:doc:`MailManager <../../mailmanager>` / Client / list_members_of_address_list

****************************
list_members_of_address_list
****************************



.. py:method:: MailManager.Client.list_members_of_address_list(**kwargs)

  

  Lists members of an address list.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListMembersOfAddressList>`_  


  **Request Syntax**
  ::

    response = client.list_members_of_address_list(
        AddressListId='string',
        Filter={
            'AddressPrefix': 'string'
        },
        NextToken='string',
        PageSize=123
    )
    
  :type AddressListId: string
  :param AddressListId: **[REQUIRED]** 

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

    

  
  :type Filter: dict
  :param Filter: 

    Filter to be used to limit the results.

    

  
    - **AddressPrefix** *(string) --* 

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

      

    
  
  :type NextToken: string
  :param NextToken: 

    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.

    

  
  :type PageSize: integer
  :param PageSize: 

    The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.

    

  
  
  :rtype: 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**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  
  *   :py:class:`MailManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MailManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`MailManager.Client.exceptions.ThrottlingException`

  