ElastiCache / Paginator / DescribeSnapshots

DescribeSnapshots

class ElastiCache.Paginator.DescribeSnapshots

paginator = client.get_paginator('describe_snapshots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ElastiCache.Client.describe_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReplicationGroupId='string',
    CacheClusterId='string',
    SnapshotName='string',
    SnapshotSource='string',
    ShowNodeGroupConfig=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ReplicationGroupId (string) – A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

• CacheClusterId (string) – A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

• SnapshotName (string) – A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

• SnapshotSource (string) – If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

• ShowNodeGroupConfig (boolean) – A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

• 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': [
        {
            'SnapshotName': 'string',
            'ReplicationGroupId': 'string',
            'ReplicationGroupDescription': 'string',
            'CacheClusterId': 'string',
            'SnapshotStatus': 'string',
            'SnapshotSource': 'string',
            'CacheNodeType': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'NumCacheNodes': 123,
            'PreferredAvailabilityZone': 'string',
            'PreferredOutpostArn': 'string',
            'CacheClusterCreateTime': datetime(2015, 1, 1),
            'PreferredMaintenanceWindow': 'string',
            'TopicArn': 'string',
            'Port': 123,
            'CacheParameterGroupName': 'string',
            'CacheSubnetGroupName': 'string',
            'VpcId': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'SnapshotRetentionLimit': 123,
            'SnapshotWindow': 'string',
            'NumNodeGroups': 123,
            'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
            'NodeSnapshots': [
                {
                    'CacheClusterId': 'string',
                    'NodeGroupId': 'string',
                    'CacheNodeId': 'string',
                    'NodeGroupConfiguration': {
                        'NodeGroupId': 'string',
                        'Slots': 'string',
                        'ReplicaCount': 123,
                        'PrimaryAvailabilityZone': 'string',
                        'ReplicaAvailabilityZones': [
                            'string',
                        ],
                        'PrimaryOutpostArn': 'string',
                        'ReplicaOutpostArns': [
                            'string',
                        ]
                    },
                    'CacheSize': 'string',
                    'CacheNodeCreateTime': datetime(2015, 1, 1),
                    'SnapshotCreateTime': datetime(2015, 1, 1)
                },
            ],
            'KmsKeyId': 'string',
            'ARN': 'string',
            'DataTiering': 'enabled'|'disabled'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a DescribeSnapshots operation.

  • Snapshots (list) –

    A list of snapshots. Each item in the list contains detailed information about one snapshot.

    • (dict) –

      Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.

      • SnapshotName (string) –

        The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

      • ReplicationGroupId (string) –

        The unique identifier of the source replication group.

      • ReplicationGroupDescription (string) –

        A description of the source replication group.

      • CacheClusterId (string) –

        The user-supplied identifier of the source cluster.

      • SnapshotStatus (string) –

        The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

      • SnapshotSource (string) –

        Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).

      • CacheNodeType (string) –

        The name of the compute and memory capacity node type for the source cluster.

        The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

        • General purpose:

          • Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          Note

          For region availability, see Supported Node Types

          M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

        • Compute optimized:

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge

        • Memory optimized:

          • Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          Note

          For region availability, see Supported Node Types

          R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

        Additional node type info

        • All current generation instance types are created in Amazon VPC by default.

        • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

        • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

        • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

      • Engine (string) –

        The name of the cache engine ( memcached or redis) used by the source cluster.

      • EngineVersion (string) –

        The version of the cache engine version that is used by the source cluster.

      • NumCacheNodes (integer) –

        The number of cache nodes in the source cluster.

        For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      • PreferredAvailabilityZone (string) –

        The name of the Availability Zone in which the source cluster is located.

      • PreferredOutpostArn (string) –

        The ARN (Amazon Resource Name) of the preferred outpost.

      • CacheClusterCreateTime (datetime) –

        The date and time when the source cluster was created.

      • PreferredMaintenanceWindow (string) –

        Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

        Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:23:00-mon:01:30

      • TopicArn (string) –

        The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

      • Port (integer) –

        The port number used by each cache nodes in the source cluster.

      • CacheParameterGroupName (string) –

        The cache parameter group that is associated with the source cluster.

      • CacheSubnetGroupName (string) –

        The name of the cache subnet group associated with the source cluster.

      • VpcId (string) –

        The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

      • AutoMinorVersionUpgrade (boolean) –

        If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

      • SnapshotRetentionLimit (integer) –

        For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

        For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

        Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

      • SnapshotWindow (string) –

        The daily time range during which ElastiCache takes daily snapshots of the source cluster.

      • NumNodeGroups (integer) –

        The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

      • AutomaticFailover (string) –

        Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.

      • NodeSnapshots (list) –

        A list of the cache nodes in the source cluster.

        • (dict) –

          Represents an individual cache node in a snapshot of a cluster.

          • CacheClusterId (string) –

            A unique identifier for the source cluster.

          • NodeGroupId (string) –

            A unique identifier for the source node group (shard).

          • CacheNodeId (string) –

            The cache node identifier for the node in the source cluster.

          • NodeGroupConfiguration (dict) –

            The configuration for the source node group (shard).

            • NodeGroupId (string) –

              Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

            • Slots (string) –

              A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

              Example: "0-3999"

            • ReplicaCount (integer) –

              The number of read replica nodes in this node group (shard).

            • PrimaryAvailabilityZone (string) –

              The Availability Zone where the primary node of this node group (shard) is launched.

            • ReplicaAvailabilityZones (list) –

              A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

              • (string) –

            • PrimaryOutpostArn (string) –

              The outpost ARN of the primary node.

            • ReplicaOutpostArns (list) –

              The outpost ARN of the node replicas.

              • (string) –

          • CacheSize (string) –

            The size of the cache on the source cache node.

          • CacheNodeCreateTime (datetime) –

            The date and time when the cache node was created in the source cluster.

          • SnapshotCreateTime (datetime) –

            The date and time when the source node’s metadata and cache data set was obtained for the snapshot.

      • KmsKeyId (string) –

        The ID of the KMS key used to encrypt the snapshot.

      • ARN (string) –

        The ARN (Amazon Resource Name) of the snapshot.

      • DataTiering (string) –

        Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

  • NextToken (string) –

    A token to resume pagination.