docs(client-ssm-contacts): Fixed an error in the DescribeEngagement e…

…xample for AWS Incident Manager.
aws · May 9, 2022 · eb5ccc6 · eb5ccc6
1 parent 872386c
commit eb5ccc6
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 19 deletions.
diff --git a/clients/client-ssm-contacts/src/SSMContacts.ts b/clients/client-ssm-contacts/src/SSMContacts.ts
@@ -740,7 +740,9 @@ export class SSMContacts extends SSMContactsClient {
   }
 
   /**
-   * <p>Adds a resource to the specified contact or escalation plan.</p>
+   * <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
+   *          is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html">Setting up
+   *             cross-account functionality</a>.</p>
    */
   public putContactPolicy(
     args: PutContactPolicyCommandInput,

diff --git a/clients/client-ssm-contacts/src/commands/PutContactPolicyCommand.ts b/clients/client-ssm-contacts/src/commands/PutContactPolicyCommand.ts
@@ -23,7 +23,9 @@ export interface PutContactPolicyCommandInput extends PutContactPolicyRequest {}
 export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, __MetadataBearer {}
 
 /**
- * <p>Adds a resource to the specified contact or escalation plan.</p>
+ * <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
+ *          is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html">Setting up
+ *             cross-account functionality</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/codegen/sdk-codegen/aws-models/ssm-contacts.json b/codegen/sdk-codegen/aws-models/ssm-contacts.json
@@ -2099,7 +2099,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Adds a resource to the specified contact or escalation plan.</p>"
+        "smithy.api#documentation": "<p>Adds a resource policy to the specified contact or escalation plan. The resource policy\n         is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html\">Setting up\n            cross-account functionality</a>.</p>"
       }
     },
     "com.amazonaws.ssmcontacts#PutContactPolicyRequest": {
@@ -2247,6 +2247,21 @@
     },
     "com.amazonaws.ssmcontacts#SSMContacts": {
       "type": "service",
+      "traits": {
+        "aws.api#service": {
+          "sdkId": "SSM Contacts",
+          "arnNamespace": "ssm-contacts",
+          "cloudFormationName": "SSMContacts",
+          "cloudTrailEventSource": "ssmcontacts.amazonaws.com",
+          "endpointPrefix": "ssm-contacts"
+        },
+        "aws.auth#sigv4": {
+          "name": "ssm-contacts"
+        },
+        "aws.protocols#awsJson1_1": {},
+        "smithy.api#documentation": "<p>Systems Manager Incident Manager is an incident management console designed to help users\n         mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.\n         An incident is any unplanned interruption or reduction in quality of services. </p>\n         <p>Incident Manager increases incident resolution by notifying responders of impact,\n         highlighting relevant troubleshooting data, and providing collaboration tools to get\n         services back up and running. To achieve the primary goal of reducing the\n         time-to-resolution of critical incidents, Incident Manager automates response plans\n         and enables responder team escalation. </p>",
+        "smithy.api#title": "AWS Systems Manager Incident Manager Contacts"
+      },
       "version": "2021-05-03",
       "operations": [
         {
@@ -2330,22 +2345,7 @@
         {
           "target": "com.amazonaws.ssmcontacts#UpdateContactChannel"
         }
-      ],
-      "traits": {
-        "aws.api#service": {
-          "sdkId": "SSM Contacts",
-          "arnNamespace": "ssm-contacts",
-          "cloudFormationName": "SSMContacts",
-          "cloudTrailEventSource": "ssmcontacts.amazonaws.com",
-          "endpointPrefix": "ssm-contacts"
-        },
-        "aws.auth#sigv4": {
-          "name": "ssm-contacts"
-        },
-        "aws.protocols#awsJson1_1": {},
-        "smithy.api#documentation": "<p>Systems Manager Incident Manager is an incident management console designed to help users\n         mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.\n         An incident is any unplanned interruption or reduction in quality of services. </p>\n         <p>Incident Manager increases incident resolution by notifying responders of impact,\n         highlighting relevant troubleshooting data, and providing collaboration tools to get\n         services back up and running. To achieve the primary goal of reducing the\n         time-to-resolution of critical incidents, Incident Manager automates response plans\n         and enables responder team escalation. </p>",
-        "smithy.api#title": "AWS Systems Manager Incident Manager Contacts"
-      }
+      ]
     },
     "com.amazonaws.ssmcontacts#SendActivationCode": {
       "type": "operation",