:doc:`Snowball <../../snowball>` / Paginator / ListClusters

************
ListClusters
************



.. py:class:: Snowball.Paginator.ListClusters

  ::

    
    paginator = client.get_paginator('list_clusters')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Snowball.Client.list_clusters`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters>`_    


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

      
      ::

        {
            'ClusterListEntries': [
                {
                    'ClusterId': 'string',
                    'ClusterState': 'AwaitingQuorum'|'Pending'|'InUse'|'Complete'|'Cancelled',
                    'CreationDate': datetime(2015, 1, 1),
                    'Description': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ClusterListEntries** *(list) --* 

          Each ``ClusterListEntry`` object contains a cluster's state, a cluster's ID, and other important status information.

          
          

          - *(dict) --* 

            Contains a cluster's state, a cluster's ID, and other important information.

            
            

            - **ClusterId** *(string) --* 

              The 39-character ID for the cluster that you want to list, for example ``CID123e4567-e89b-12d3-a456-426655440000``.

              
            

            - **ClusterState** *(string) --* 

              The current state of this cluster. For information about the state of a specific node, see  JobListEntry$JobState.

              
            

            - **CreationDate** *(datetime) --* 

              The creation date for this cluster.

              
            

            - **Description** *(string) --* 

              Defines an optional description of the cluster, for example ``Environmental Data Cluster-01``.

              
        
      
    