MailManager / Paginator / ListAddressLists

ListAddressLists

class MailManager.Paginator.ListAddressLists

paginator = client.get_paginator('list_address_lists')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MailManager.Client.list_address_lists().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'AddressLists': [
        {
            'AddressListArn': 'string',
            'AddressListId': 'string',
            'AddressListName': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • AddressLists (list) –

    The list of address lists.

    • (dict) –

      An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.

      • AddressListArn (string) –

        The Amazon Resource Name (ARN) of the address list.

      • AddressListId (string) –

        The identifier of the address list.

      • AddressListName (string) –

        The user-friendly name of the address list.

      • CreatedTimestamp (datetime) –

        The timestamp of when the address list was created.

      • LastUpdatedTimestamp (datetime) –

        The timestamp of when the address list was last updated.