SESV2 / Client / list_contact_lists

list_contact_lists#

SESV2.Client.list_contact_lists(**kwargs)#

Lists all of the contact lists available.

See also: AWS API Documentation

Request Syntax

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

  • PageSize (integer) – Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.

  • NextToken (string) – A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

Return type:

dict

Returns:

Response Syntax

{
    'ContactLists': [
        {
            'ContactListName': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ContactLists (list) –

      The available contact lists.

      • (dict) –

        A list that contains contacts that have subscribed to a particular topic or topics.

        • ContactListName (string) –

          The name of the contact list.

        • LastUpdatedTimestamp (datetime) –

          A timestamp noting the last time the contact list was updated.

    • NextToken (string) –

      A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

Exceptions