DocDBElastic / Paginator / ListClusterSnapshots

ListClusterSnapshots#

class DocDBElastic.Paginator.ListClusterSnapshots#
paginator = client.get_paginator('list_cluster_snapshots')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DocDBElastic.Client.list_cluster_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    clusterArn='string',
    snapshotType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

    • NextToken (string) –

      A token to resume pagination.