:doc:`AuroraDSQL <../../dsql>` / Client / list_clusters

*************
list_clusters
*************



.. py:method:: AuroraDSQL.Client.list_clusters(**kwargs)

  

  Retrieves information about a list of clusters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/ListClusters>`_  


  **Request Syntax**
  ::

    response = client.list_clusters(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          'clusters': [
              {
                  'identifier': 'string',
                  'arn': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

        
      

      - **clusters** *(list) --* 

        An array of the returned clusters.

        
        

        - *(dict) --* 

          A summary of the properties of a cluster.

          
          

          - **identifier** *(string) --* 

            The ID of the cluster.

            
          

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

            The ARN of the cluster.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`AuroraDSQL.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.ValidationException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.InternalServerException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.ResourceNotFoundException`

  