list_clusters

DocDBElastic.Client.list_clusters(**kwargs)

Returns information about provisioned Elastic DocumentDB clusters.

See also: AWS API Documentation

Request Syntax

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

Parameters

• maxResults (integer) -- The maximum number of entries to recieve in the response.
• nextToken (string) -- The nextToken which is used the get the next page of data.

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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • clusters (list) --

    A list of Elastic DocumentDB cluster.

    • (dict) --

      A list of Elastic DocumentDB cluster.

      • clusterArn (string) --

        The arn of the Elastic DocumentDB cluster.

      • clusterName (string) --

        The name of the Elastic DocumentDB cluster.

      • status (string) --

        The status of the Elastic DocumentDB cluster.

  • nextToken (string) --

    The response will provide a nextToken if there is more data beyond the maxResults.

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

Exceptions

• DocDBElastic.Client.exceptions.ThrottlingException
• DocDBElastic.Client.exceptions.ValidationException
• DocDBElastic.Client.exceptions.InternalServerException
• DocDBElastic.Client.exceptions.AccessDeniedException