MailManager / Client / list_members_of_address_list

list_members_of_address_list¶

MailManager.Client.list_members_of_address_list(**kwargs)¶

Lists members of an address list.

Request Syntax

response = client.list_members_of_address_list(
    AddressListId='string',
    Filter={
        'AddressPrefix': 'string'
    },
    NextToken='string',
    PageSize=123
)

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.
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 members that are returned per call. You can use NextToken to retrieve the next page of members.

Return type:

dict

Returns:

Response Syntax

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

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.
- 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.ResourceNotFoundException
MailManager.Client.exceptions.ThrottlingException