MailManager / Client / list_address_lists

list_address_lists#

MailManager.Client.list_address_lists(**kwargs)#

Lists address lists for this account.

See also: AWS API Documentation

Request Syntax

response = client.list_address_lists(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize (integer) – The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.AccessDeniedException

  • MailManager.Client.exceptions.ThrottlingException