:doc:`MailManager <../../mailmanager>` / Paginator / ListMembersOfAddressList

************************
ListMembersOfAddressList
************************



.. py:class:: MailManager.Paginator.ListMembersOfAddressList

  ::

    
    paginator = client.get_paginator('list_members_of_address_list')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MailManager.Client.list_members_of_address_list`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AddressListId='string',
          Filter={
              'AddressPrefix': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

              
        
      
    