AuroraDSQL / Client / list_clusters

list_clusters#

AuroraDSQL.Client.list_clusters(**kwargs)#

Retrieves information about a list of clusters.

See also: AWS API Documentation

Request Syntax

response = client.list_clusters(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • nextToken (string) – 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.

Return type:

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

  • AuroraDSQL.Client.exceptions.ThrottlingException

  • AuroraDSQL.Client.exceptions.AccessDeniedException

  • AuroraDSQL.Client.exceptions.ValidationException

  • AuroraDSQL.Client.exceptions.InternalServerException

  • AuroraDSQL.Client.exceptions.ResourceNotFoundException