SSMContacts / Client / accept_page

accept_page#

SSMContacts.Client.accept_page(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • PageId (string) –

    [REQUIRED]

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

  • ContactChannelId (string) – The ARN of the contact channel.

  • AcceptType (string) –

    [REQUIRED]

    The type indicates if the page was DELIVERED or READ.

  • Note (string) – Information provided by the user when the user acknowledges the page.

  • AcceptCode (string) –

    [REQUIRED]

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

  • AcceptCodeValidation (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSMContacts.Client.exceptions.AccessDeniedException

  • SSMContacts.Client.exceptions.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException

Examples

The following accept-page operation uses an accept code sent to the contact channel to accept a page.

response = client.accept_page(
    AcceptCode='425440',
    AcceptType='READ',
    PageId='arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}