AWS Systems Manager Incident Manager Contacts

{'AcceptCodeValidation': 'IGNORE | ENFORCE'}

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

See also: AWS API Documentation

Request Syntax

client.accept_page(
    PageId='string',
    ContactChannelId='string',
    AcceptType='DELIVERED'|'READ',
    Note='string',
    AcceptCode='string',
    AcceptCodeValidation='IGNORE'|'ENFORCE'
)

type PageId:

string

param PageId:

[REQUIRED]

The Amazon Resource Name (ARN) of the engagement to a contact channel.

type ContactChannelId:

string

param ContactChannelId:

The ARN of the contact channel.

type AcceptType:

string

param AcceptType:

[REQUIRED]

The type indicates if the page was DELIVERED or READ.

type Note:

string

param Note:

Information provided by the user when the user acknowledges the page.

type AcceptCode:

string

param AcceptCode:

[REQUIRED]

The accept code is a 6-digit code used to acknowledge the page.

type AcceptCodeValidation:

string

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --