SSMContacts / Paginator / ListPageReceipts

ListPageReceipts

class SSMContacts.Paginator.ListPageReceipts

paginator = client.get_paginator('list_page_receipts')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• PageId (string) –

  [REQUIRED]

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

• 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

{
    'Receipts': [
        {
            'ContactChannelArn': 'string',
            'ReceiptType': 'DELIVERED'|'ERROR'|'READ'|'SENT'|'STOP',
            'ReceiptInfo': 'string',
            'ReceiptTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • Receipts (list) –

    A list of each acknowledgement.

    • (dict) –

      Records events during an engagement.

      • ContactChannelArn (string) –

        The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.

      • ReceiptType (string) –

        The type follows the engagement cycle, SENT, DELIVERED, and READ.

      • ReceiptInfo (string) –

        Information provided during the page acknowledgement.

      • ReceiptTime (datetime) –

        The time receipt was SENT, DELIVERED, or READ.