Skip to content

Commit eb5ccc6

Browse files
author
awstools
committed
docs(client-ssm-contacts): Fixed an error in the DescribeEngagement example for AWS Incident Manager.
1 parent 872386c commit eb5ccc6

File tree

3 files changed

+23
-19
lines changed

3 files changed

+23
-19
lines changed

clients/client-ssm-contacts/src/SSMContacts.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,9 @@ export class SSMContacts extends SSMContactsClient {
740740
}
741741

742742
/**
743-
* <p>Adds a resource to the specified contact or escalation plan.</p>
743+
* <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
744+
* 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
745+
* cross-account functionality</a>.</p>
744746
*/
745747
public putContactPolicy(
746748
args: PutContactPolicyCommandInput,

clients/client-ssm-contacts/src/commands/PutContactPolicyCommand.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ export interface PutContactPolicyCommandInput extends PutContactPolicyRequest {}
2323
export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, __MetadataBearer {}
2424

2525
/**
26-
* <p>Adds a resource to the specified contact or escalation plan.</p>
26+
* <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
27+
* 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
28+
* cross-account functionality</a>.</p>
2729
* @example
2830
* Use a bare-bones client and the command you need to make an API call.
2931
* ```javascript

codegen/sdk-codegen/aws-models/ssm-contacts.json

+17-17
Original file line numberDiff line numberDiff line change
@@ -2099,7 +2099,7 @@
20992099
}
21002100
],
21012101
"traits": {
2102-
"smithy.api#documentation": "<p>Adds a resource to the specified contact or escalation plan.</p>"
2102+
"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>"
21032103
}
21042104
},
21052105
"com.amazonaws.ssmcontacts#PutContactPolicyRequest": {
@@ -2247,6 +2247,21 @@
22472247
},
22482248
"com.amazonaws.ssmcontacts#SSMContacts": {
22492249
"type": "service",
2250+
"traits": {
2251+
"aws.api#service": {
2252+
"sdkId": "SSM Contacts",
2253+
"arnNamespace": "ssm-contacts",
2254+
"cloudFormationName": "SSMContacts",
2255+
"cloudTrailEventSource": "ssmcontacts.amazonaws.com",
2256+
"endpointPrefix": "ssm-contacts"
2257+
},
2258+
"aws.auth#sigv4": {
2259+
"name": "ssm-contacts"
2260+
},
2261+
"aws.protocols#awsJson1_1": {},
2262+
"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>",
2263+
"smithy.api#title": "AWS Systems Manager Incident Manager Contacts"
2264+
},
22502265
"version": "2021-05-03",
22512266
"operations": [
22522267
{
@@ -2330,22 +2345,7 @@
23302345
{
23312346
"target": "com.amazonaws.ssmcontacts#UpdateContactChannel"
23322347
}
2333-
],
2334-
"traits": {
2335-
"aws.api#service": {
2336-
"sdkId": "SSM Contacts",
2337-
"arnNamespace": "ssm-contacts",
2338-
"cloudFormationName": "SSMContacts",
2339-
"cloudTrailEventSource": "ssmcontacts.amazonaws.com",
2340-
"endpointPrefix": "ssm-contacts"
2341-
},
2342-
"aws.auth#sigv4": {
2343-
"name": "ssm-contacts"
2344-
},
2345-
"aws.protocols#awsJson1_1": {},
2346-
"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>",
2347-
"smithy.api#title": "AWS Systems Manager Incident Manager Contacts"
2348-
}
2348+
]
23492349
},
23502350
"com.amazonaws.ssmcontacts#SendActivationCode": {
23512351
"type": "operation",

0 commit comments

Comments
 (0)