DocDBElastic / Client / list_cluster_snapshots

list_cluster_snapshots#

DocDBElastic.Client.list_cluster_snapshots(**kwargs)#

Returns information about Elastic DocumentDB snapshots for a specified cluster.

Request Syntax

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

Parameters:

clusterArn (string) – The arn of the Elastic DocumentDB cluster.
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

{
    'nextToken': 'string',
    'snapshots': [
        {
            'clusterArn': 'string',
            'snapshotArn': 'string',
            'snapshotCreationTime': 'string',
            'snapshotName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'
        },
    ]
}

Response Structure

(dict) –
- 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.
- snapshots (list) –
  
  A list of Elastic DocumentDB snapshots for a specified cluster.
  - (dict) –
    
    A list of Elastic DocumentDB snapshots.
    - clusterArn (string) –
      
      The arn of the Elastic DocumentDB cluster.
    - snapshotArn (string) –
      
      The arn of the Elastic DocumentDB snapshot
    - snapshotCreationTime (string) –
      
      The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    - snapshotName (string) –
      
      The name of the Elastic DocumentDB snapshot.
    - status (string) –
      
      The status of the Elastic DocumentDB snapshot.

Exceptions

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