UpdateContact - AWS Systems Manager Incident Manager


Updates the contact or escalation plan specified.

Request Syntax

{ "ContactId": "string", "DisplayName": "string", "Plan": { "RotationIds": [ "string" ], "Stages": [ { "DurationInMinutes": number, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "string", "RetryIntervalInMinutes": number }, "ContactTargetInfo": { "ContactId": "string", "IsEssential": boolean } } ] } ] } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.

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


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


A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.

Type: Plan object

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


You don't have sufficient access to perform this operation.

HTTP Status Code: 400


The operation failed to due an encryption key error.

HTTP Status Code: 400


Unexpected error occurred while processing the request.

HTTP Status Code: 500


Request references a resource that doesn't exist.

HTTP Status Code: 400


Request would cause a service quota to be exceeded.

HTTP Status Code: 400


The request was denied due to request throttling.

HTTP Status Code: 400


The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400



This example illustrates one usage of UpdateContact.

Sample Request

POST / HTTP/1.1 Host: ssm-contacts.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: SSMContacts.UpdateContact 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.update-contact X-Amz-Date: 20220812T181127Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 534 { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/31111aa5-9b84-4591-a5a6-5a8f9EXAMPLE", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE", "RetryIntervalInMinutes": 1 } } ] } ] } }

Sample Response


See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: