:doc:`VPCLattice <../../vpc-lattice>` / Paginator / ListListeners

*************
ListListeners
*************



.. py:class:: VPCLattice.Paginator.ListListeners

  ::

    
    paginator = client.get_paginator('list_listeners')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`VPCLattice.Client.list_listeners`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListListeners>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          serviceIdentifier='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type serviceIdentifier: string
    :param serviceIdentifier: **[REQUIRED]** 

      The ID or ARN of the service.

      

    
    :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**

      
      ::

        {
            'items': [
                {
                    'arn': 'string',
                    'id': 'string',
                    'name': 'string',
                    'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH',
                    'port': 123,
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          Information about the listeners.

          
          

          - *(dict) --* 

            Summary information about a listener.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the listener.

              
            

            - **id** *(string) --* 

              The ID of the listener.

              
            

            - **name** *(string) --* 

              The name of the listener.

              
            

            - **protocol** *(string) --* 

              The listener protocol.

              
            

            - **port** *(integer) --* 

              The listener port.

              
            

            - **createdAt** *(datetime) --* 

              The date and time that the listener was created, in ISO-8601 format.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              The date and time that the listener was last updated, in ISO-8601 format.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    