AcceptPage - AWS Systems Manager Incident Manager

AcceptPage

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

Request Syntax

{ "AcceptCode": "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

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

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

See Also

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