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

**********
ListRelays
**********



.. py:class:: MailManager.Paginator.ListRelays

  ::

    
    paginator = client.get_paginator('list_relays')

  
  

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

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

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


    **Request Syntax**
    ::

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

      
      ::

        {
            'Relays': [
                {
                    'RelayId': 'string',
                    'RelayName': 'string',
                    'LastModifiedTimestamp': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Relays** *(list) --* 

          The list of returned relays.

          
          

          - *(dict) --* 

            The relay resource that can be used as a rule to relay receiving emails to the destination relay server.

            
            

            - **RelayId** *(string) --* 

              The unique relay identifier.

              
            

            - **RelayName** *(string) --* 

              The unique relay name.

              
            

            - **LastModifiedTimestamp** *(datetime) --* 

              The timestamp of when the relay was last modified.

              
        
      
    