SSMContacts / Paginator / ListPagesByEngagement

ListPagesByEngagement

class SSMContacts.Paginator.ListPagesByEngagement

paginator = client.get_paginator('list_pages_by_engagement')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMContacts.Client.list_pages_by_engagement().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EngagementId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• EngagementId (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the engagement.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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) –

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