From eb5ccc69c7744cb9e02ee0cba98d500fe6b4a4fb Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 9 May 2022 18:17:51 +0000 Subject: [PATCH] docs(client-ssm-contacts): Fixed an error in the DescribeEngagement example for AWS Incident Manager. --- .../client-ssm-contacts/src/SSMContacts.ts | 4 ++- .../src/commands/PutContactPolicyCommand.ts | 4 ++- .../sdk-codegen/aws-models/ssm-contacts.json | 34 +++++++++---------- 3 files changed, 23 insertions(+), 19 deletions(-) diff --git a/clients/client-ssm-contacts/src/SSMContacts.ts b/clients/client-ssm-contacts/src/SSMContacts.ts index b54549559537..3b5d465053ca 100644 --- 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 { } /** - *

Adds a resource to the specified contact or escalation plan.

+ *

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 Setting up + * cross-account functionality.

*/ public putContactPolicy( args: PutContactPolicyCommandInput, diff --git a/clients/client-ssm-contacts/src/commands/PutContactPolicyCommand.ts b/clients/client-ssm-contacts/src/commands/PutContactPolicyCommand.ts index cb351ed1824a..ee6cfb9d3f54 100644 --- 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 {} /** - *

Adds a resource to the specified contact or escalation plan.

+ *

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 Setting up + * cross-account functionality.

* @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 index ac38021096f4..659e3d0f70d3 100644 --- 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": "

Adds a resource to the specified contact or escalation plan.

" + "smithy.api#documentation": "

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 Setting up\n cross-account functionality.

" } }, "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": "

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.

\n

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.

", + "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": "

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.

\n

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.

", - "smithy.api#title": "AWS Systems Manager Incident Manager Contacts" - } + ] }, "com.amazonaws.ssmcontacts#SendActivationCode": { "type": "operation",