"AcceptCode": "string",
"AcceptCodeValidation": "string", "AcceptType": "string",
"ContactChannelId": "string", "Note": "string",
"PageId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
AcceptCode (p. 103)
The accept code is a 6-digit code used to acknowledge the page.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 10.
Pattern: ^[0-9]*$
Required: Yes
AcceptCodeValidation (p. 103)
An optional field that Incident Manager uses to ENFORCE AcceptCode validation when
acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.
Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.
Type: String
Valid Values: IGNORE | ENFORCE Required: No
AcceptType (p. 103)
The type indicates if the page was DELIVERED or READ.
Type: String
Valid Values: DELIVERED | READ Required: Yes
AcceptPage
ContactChannelId (p. 103)
The ARN of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: No Note (p. 103)
Information provided by the user when the user acknowledges the page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[.\s\S]*$
Required: No PageId (p. 103)
The Amazon Resource Name (ARN) of the engagement to a contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
Request references a resource that doesn't exist.
HTTP Status Code: 400
AcceptPage
ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of AcceptPage.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.AcceptPage Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.accept-page X-Amz-Date: 20210816T191158Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210816/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 151
{ "PageId": "arn:aws:ssm-contacts:us-east-1:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b09c0b4ac",
"AcceptType": "READ", "AcceptCode": "425440"
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
AcceptPage
• AWS SDK for Ruby V3
ActivateContactChannel
ActivateContactChannel
Service: AWS Systems Manager Incident Manager Contacts
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
Request Syntax
{ "ActivationCode": "string", "ContactChannelId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
ActivationCode (p. 107)
The code sent to the contact channel when it was created in the contact.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 10.
Pattern: ^[0-9]*$
Required: Yes
ContactChannelId (p. 107)
The Amazon Resource Name (ARN) of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400
ActivateContactChannel
InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
Request references a resource that doesn't exist.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ActivateContactChannel.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.ActivateContactChannel Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.activate-contact-channel X-Amz-Date: 20210812T183313Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210812/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 154 {
"ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/
e5bd2c57-406a-487f-8d26-7c032bc0139c", "ActivationCode": "345140"
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
ActivateContactChannel
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateContact
CreateContact
Service: AWS Systems Manager Incident Manager Contacts
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
Request Syntax
{ "Alias": "string", "DisplayName": "string", "IdempotencyToken": "string", "Plan": {
"Type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
Alias (p. 110)
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-z0-9_\-]*$
Required: Yes
CreateContact
DisplayName (p. 110)
The full name of the contact or escalation plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^[\p{L}\p{Z}\p{N}_.\-]*$
Required: No
IdempotencyToken (p. 110)
A token ensuring that the operation is called only once with the specified details.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$
Required: No Plan (p. 110)
A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
Type: Plan (p. 248) object Required: Yes
Tags (p. 110)
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
Type: Array of Tag (p. 251) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No Type (p. 110)
To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
Type: String
Valid Values: PERSONAL | ESCALATION Required: Yes
Response Syntax
{
"ContactArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
CreateContact
The following data is returned in JSON format by the service.
ContactArn (p. 111)
The Amazon Resource Name (ARN) of the created contact or escalation plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 ConflictException
Updating or deleting a resource causes an inconsistent state.
HTTP Status Code: 400 DataEncryptionException
The operation failed to due an encryption key error.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ServiceQuotaExceededException
Request would cause a service quota to be exceeded.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateContact.
CreateContact
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.CreateContact Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.create-contact X-Amz-Date: 20210812T172928Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210812/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=AKIAIOSFODNN7EXAMPLE
Content-Length: 151 {
"Alias": "akuam",
"DisplayName": "Akua Mansa", "Type": "PERSONAL",
"Plan": { "Stages": []
}, "IdempotencyToken": "5b03013e-6255-404c-a673-1aa1060969a7"
}
Sample Response
{ "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateContactChannel
CreateContactChannel
Service: AWS Systems Manager Incident Manager Contacts
A contact channel is the method that Incident Manager uses to engage your contact.
Request Syntax
{ "ContactId": "string", "DeferActivation": boolean, "DeliveryAddress": { "SimpleAddress": "string"
},
"IdempotencyToken": "string", "Name": "string",
"Type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
ContactId (p. 114)
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes DeferActivation (p. 114)
If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.
Type: Boolean Required: No
DeliveryAddress (p. 114)
The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:
• SMS - '+' followed by the country code and phone number
• VOICE - '+' followed by the country code and phone number
• EMAIL - any standard email format Type: ContactChannelAddress (p. 242) object Required: Yes
CreateContactChannel
IdempotencyToken (p. 114)
A token ensuring that the operation is called only once with the specified details.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$
Required: No Name (p. 114)
The name of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\p{L}\p{Z}\p{N}_.\-]*$
Required: Yes Type (p. 114)
Incident Manager supports three types of contact channels:
• SMS
• VOICE
• EMAIL Type: String
Valid Values: SMS | VOICE | EMAIL Required: Yes
Response Syntax
{
"ContactChannelArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ContactChannelArn (p. 115)
The Amazon Resource Name (ARN) of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
CreateContactChannel
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 ConflictException
Updating or deleting a resource causes an inconsistent state.
HTTP Status Code: 400 DataEncryptionException
The operation failed to due an encryption key error.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateContactChannel.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.CreateContactChannel Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.create-contact-channel X-Amz-Date: 20210812T174315Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210812/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 229
{ "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
CreateContactChannel
"Name": "akuas sms-test", "Type": "SMS",
"DeliveryAddress": {"SimpleAddress": "+15005550199"}, "IdempotencyToken": "922b8f50-9bb9-4dd7-83cf-a4c2593dec60"
}
Sample Response
{
"ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/
akuam/e5bd2c57-406a-487f-8d26-7c032bc0139c"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeactivateContactChannel
DeactivateContactChannel
Service: AWS Systems Manager Incident Manager Contacts
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
Request Syntax
{
"ContactChannelId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
ContactChannelId (p. 118)
The Amazon Resource Name (ARN) of the contact channel you're deactivating.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
Request references a resource that doesn't exist.
HTTP Status Code: 400
DeactivateContactChannel
ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeactivateContactChannel.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeactivateContactChannel Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.deactivate-contact-channel X-Amz-Date: 20210817T184424Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210817/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126
{ "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/
e5bd2c57-406a-487f-8d26-7c032bc0139c"
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteContact
DeleteContact
Service: AWS Systems Manager Incident Manager Contacts
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
Request Syntax
{ "ContactId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
ContactId (p. 120)
The Amazon Resource Name (ARN) of the contact that you're deleting.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
Request references a resource that doesn't exist.
DeleteContact
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteContact.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeleteContact Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.delete-contact X-Amz-Date: 20210817T184920Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210817/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 74 {
"ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteContact
DeleteContactChannel
DeleteContactChannel
Service: AWS Systems Manager Incident Manager Contacts
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
Request Syntax
{ "ContactChannelId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
ContactChannelId (p. 123)
The Amazon Resource Name (ARN) of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=
\/,.@:-]+)*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 257).
AccessDeniedException
You don't have sufficient access to perform this operation.
HTTP Status Code: 400 InternalServerException
Unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
Request references a resource that doesn't exist.
HTTP Status Code: 400
DeleteContactChannel
ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteContactChannel.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeleteContactChannel Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/
x86_64.amzn.2 prompt/off command/ssm-contacts.delete-contact-channel X-Amz-Date: 20210817T184639Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210817/us-east-1/
ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126
{ "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/
e5bd2c57-406a-487f-8d26-7c032bc0139c"
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeEngagement
DescribeEngagement
Service: AWS Systems Manager Incident Manager Contacts
Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
Request Syntax
{ "EngagementId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 255).
The request accepts the following data in JSON format.
EngagementId (p. 125)
The Amazon Resource Name (ARN) of the engagement you want the details of.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Length Constraints: Minimum length of 1. Maximum length of 2048.