PutContactPolicy - AWS Systems Manager Incident Manager

PutContactPolicy

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using AWS Resource Access Manager (AWS RAM). For more information about cross-account sharing, see Setting up cross-account functionality.

Request Syntax

{ "ContactArn": "string", "Policy": "string" }

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.

ContactArn

The Amazon Resource Name (ARN) of the 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+=\/,.@:-]+)*

Required: Yes

Policy

Details of the resource policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 395000.

Pattern: .*\S.*

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.

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

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 PutContactPolicy.

Sample Request

POST / HTTP/1.1 Host: ssm-contacts.us-east-1.amazonaws.com Accept-Encoding: identity X-Amz-Target: SSMContacts.PutContactPolicy 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.put-contact-policy X-Amz-Date: 20210816T212604Z 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: 546 { "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"444455556666\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact\\/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement\\/akuam\\/*\"]}]}" }

Sample Response

{}

See Also

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