DocDBElastic / Client / list_clusters

list_clusters#

DocDBElastic.Client.list_clusters(**kwargs)#

Returns information about provisioned Amazon DocumentDB elastic clusters.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) – The maximum number of elastic cluster snapshot results to receive in the response.

  • nextToken (string) –

    A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

    If there is no more data in the responce, the nextToken will not be returned.

Return type:

dict

Returns:

Response Syntax

{
    'clusters': [
        {
            'clusterArn': 'string',
            'clusterName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • clusters (list) –

      A list of Amazon DocumentDB elastic clusters.

      • (dict) –

        A list of Amazon DocumentDB elastic clusters.

        • clusterArn (string) –

          The ARN identifier of the elastic cluster.

        • clusterName (string) –

          The name of the elastic cluster.

        • status (string) –

          The status of the elastic cluster.

    • nextToken (string) –

      A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

      If there is no more data in the responce, the nextToken will not be returned.

Exceptions