MailManager / Paginator / ListMembersOfAddressList

ListMembersOfAddressList

class MailManager.Paginator.ListMembersOfAddressList

paginator = client.get_paginator('list_members_of_address_list')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AddressListId (string) –

  [REQUIRED]

  The unique identifier of the address list to list the addresses from.

• Filter (dict) –

  Filter to be used to limit the results.

  • AddressPrefix (string) –

    Filter to limit the results to addresses having the provided prefix.

• 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

{
    'Addresses': [
        {
            'Address': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Addresses (list) –

    The list of addresses.

    • (dict) –

      An address that is a member of an address list.

      • Address (string) –

        The email or domain that constitutes the address.

      • CreatedTimestamp (datetime) –

        The timestamp of when the address was added to the address list.