DocDBElastic / Client / list_cluster_snapshots

list_cluster_snapshots#

DocDBElastic.Client.list_cluster_snapshots(**kwargs)#

Returns information about snapshots for a specified elastic cluster.

See also: AWS API Documentation

Request Syntax

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

  • clusterArn (string) – The ARN identifier of the elastic cluster.

  • 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.

  • snapshotType (string) –

    The type of cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

    • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

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'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
        },
    ]
}

Response Structure

  • (dict) –

    • 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.

    • snapshots (list) –

      A list of snapshots for a specified elastic cluster.

      • (dict) –

        A list of elastic cluster snapshots.

        • clusterArn (string) –

          The ARN identifier of the elastic cluster.

        • snapshotArn (string) –

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTime (string) –

          The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

        • snapshotName (string) –

          The name of the elastic cluster snapshot.

        • status (string) –

          The status of the elastic cluster snapshot.

Exceptions

  • DocDBElastic.Client.exceptions.ThrottlingException

  • DocDBElastic.Client.exceptions.ValidationException

  • DocDBElastic.Client.exceptions.InternalServerException

  • DocDBElastic.Client.exceptions.AccessDeniedException