SSMContacts / Client / list_pages_by_engagement

list_pages_by_engagement

SSMContacts.Client.list_pages_by_engagement(**kwargs)

Lists the engagements to contact channels that occurred by engaging a contact.

See also: AWS API Documentation

Request Syntax

response = client.list_pages_by_engagement(
    EngagementId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• EngagementId (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the engagement.

• NextToken (string) – The pagination token to continue to the next page of results.

• MaxResults (integer) – The maximum number of engagements to contact channels to list per page of results.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Pages': [
        {
            'PageArn': 'string',
            'EngagementArn': 'string',
            'ContactArn': 'string',
            'Sender': 'string',
            'IncidentId': 'string',
            'SentTime': datetime(2015, 1, 1),
            'DeliveryTime': datetime(2015, 1, 1),
            'ReadTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The pagination token to continue to the next page of results.

  • Pages (list) –

    The list of engagements to contact channels.

    • (dict) –

      Incident Manager engaging a contact’s contact channel.

      • PageArn (string) –

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

      • EngagementArn (string) –

        The ARN of the engagement that this page is part of.

      • ContactArn (string) –

        The ARN of the contact that Incident Manager is engaging.

      • Sender (string) –

        The user that started the engagement.

      • IncidentId (string) –

        The ARN of the incident that’s engaging the contact channel.

      • SentTime (datetime) –

        The time that Incident Manager engaged the contact channel.

      • DeliveryTime (datetime) –

        The time the message was delivered to the contact channel.

      • ReadTime (datetime) –

        The time that the contact channel acknowledged engagement.

Exceptions

• SSMContacts.Client.exceptions.AccessDeniedException

• SSMContacts.Client.exceptions.InternalServerException

• SSMContacts.Client.exceptions.ResourceNotFoundException

• SSMContacts.Client.exceptions.ThrottlingException

• SSMContacts.Client.exceptions.ValidationException

Examples

The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.

response = client.list_pages_by_engagement(
    EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
)

print(response)

Expected Output:

{
    'Pages': [
        {
            'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
            'PageArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
            'Sender': 'cli',
            'SentTime': datetime(2021, 5, 18, 18, 40, 27, 1, 138, 0),
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}