AcceptPage - AWS Systems Manager Incident Manager

AcceptPage

Used to acknowledge an engagement to a contact channel during an incident.

Request Syntax

{ "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.

The request accepts the following data in JSON format.

AcceptCode

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

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

The type indicates if the page was DELIVERED or READ.

Type: String

Valid Values: DELIVERED | READ

Required: Yes

ContactChannelId

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

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

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.

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

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: