:doc:`Kafka <../../kafka>` / Paginator / ListNodes

*********
ListNodes
*********



.. py:class:: Kafka.Paginator.ListNodes

  ::

    
    paginator = client.get_paginator('list_nodes')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Kafka.Client.list_nodes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListNodes>`_    


    **Request Syntax**
    ::

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

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

      

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

      
      ::

        {
            'NodeInfoList': [
                {
                    'AddedToClusterTime': 'string',
                    'BrokerNodeInfo': {
                        'AttachedENIId': 'string',
                        'BrokerId': 123.0,
                        'ClientSubnet': 'string',
                        'ClientVpcIpAddress': 'string',
                        'CurrentBrokerSoftwareInfo': {
                            'ConfigurationArn': 'string',
                            'ConfigurationRevision': 123,
                            'KafkaVersion': 'string'
                        },
                        'Endpoints': [
                            'string',
                        ]
                    },
                    'ControllerNodeInfo': {
                        'Endpoints': [
                            'string',
                        ]
                    },
                    'InstanceType': 'string',
                    'NodeARN': 'string',
                    'NodeType': 'BROKER',
                    'ZookeeperNodeInfo': {
                        'AttachedENIId': 'string',
                        'ClientVpcIpAddress': 'string',
                        'Endpoints': [
                            'string',
                        ],
                        'ZookeeperId': 123.0,
                        'ZookeeperVersion': 'string'
                    }
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Successful response.

        
        

        - **NodeInfoList** *(list) --* 

          List containing a NodeInfo object.

          
          

          - *(dict) --* 

            The node information object.

            
            

            - **AddedToClusterTime** *(string) --* 

              The start time.

              
            

            - **BrokerNodeInfo** *(dict) --* 

              The broker node info.

              
              

              - **AttachedENIId** *(string) --* 

                The attached elastic network interface of the broker.

                
              

              - **BrokerId** *(float) --* 

                The ID of the broker.

                
              

              - **ClientSubnet** *(string) --* 

                The client subnet to which this broker node belongs.

                
              

              - **ClientVpcIpAddress** *(string) --* 

                The virtual private cloud (VPC) of the client.

                
              

              - **CurrentBrokerSoftwareInfo** *(dict) --* 

                Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

                
                

                - **ConfigurationArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

                  
                

                - **ConfigurationRevision** *(integer) --* 

                  The revision of the configuration to use. This field isn't visible in this preview release.

                  
                

                - **KafkaVersion** *(string) --* 

                  The version of Apache Kafka.

                  
            
              

              - **Endpoints** *(list) --* 

                Endpoints for accessing the broker.

                
                

                - *(string) --* 
            
          
            

            - **ControllerNodeInfo** *(dict) --* 

              The ControllerNodeInfo.

              
              

              - **Endpoints** *(list) --* 

                Endpoints for accessing the Controller.

                
                

                - *(string) --* 
            
          
            

            - **InstanceType** *(string) --* 

              The instance type.

              
            

            - **NodeARN** *(string) --* 

              The Amazon Resource Name (ARN) of the node.

              
            

            - **NodeType** *(string) --* 

              The node type.

              
            

            - **ZookeeperNodeInfo** *(dict) --* 

              The ZookeeperNodeInfo.

              
              

              - **AttachedENIId** *(string) --* 

                The attached elastic network interface of the broker.

                
              

              - **ClientVpcIpAddress** *(string) --* 

                The virtual private cloud (VPC) IP address of the client.

                
              

              - **Endpoints** *(list) --* 

                Endpoints for accessing the ZooKeeper.

                
                

                - *(string) --* 
            
              

              - **ZookeeperId** *(float) --* 

                The role-specific ID for Zookeeper.

                
              

              - **ZookeeperVersion** *(string) --* 

                The version of Zookeeper.

                
          
        
      
    