MemoryDB / Client / describe_snapshots

describe_snapshots#

MemoryDB.Client.describe_snapshots(**kwargs)#

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.

Request Syntax

response = client.describe_snapshots(
    ClusterName='string',
    SnapshotName='string',
    Source='string',
    NextToken='string',
    MaxResults=123,
    ShowDetail=True|False
)

Parameters:

ClusterName (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 named snapshot is described.
Source (string) – If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
NextToken (string) – An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
MaxResults (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
ShowDetail (boolean) – A Boolean value which if true, the shard configuration is included in the snapshot description.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Snapshots': [
        {
            'Name': 'string',
            'Status': 'string',
            'Source': 'string',
            'KmsKeyId': 'string',
            'ARN': 'string',
            'ClusterConfiguration': {
                'Name': 'string',
                'Description': 'string',
                'NodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'MaintenanceWindow': 'string',
                'TopicArn': 'string',
                'Port': 123,
                'ParameterGroupName': 'string',
                'SubnetGroupName': 'string',
                'VpcId': 'string',
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string',
                'NumShards': 123,
                'Shards': [
                    {
                        'Name': 'string',
                        'Configuration': {
                            'Slots': 'string',
                            'ReplicaCount': 123
                        },
                        'Size': 'string',
                        'SnapshotCreationTime': datetime(2015, 1, 1)
                    },
                ]
            },
            'DataTiering': 'true'|'false'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- Snapshots (list) –
  
  A list of snapshots. Each item in the list contains detailed information about one snapshot.
  - (dict) –
    
    Represents a copy of an entire cluster as of the time when the snapshot was taken.
    - Name (string) –
      
      The name of the snapshot
    - Status (string) –
      
      The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    - Source (string) –
      
      Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    - KmsKeyId (string) –
      
      The ID of the KMS key used to encrypt the snapshot.
    - ARN (string) –
      
      The ARN (Amazon Resource Name) of the snapshot.
    - ClusterConfiguration (dict) –
      
      The configuration of the cluster from which the snapshot was taken
      - Name (string) –
        
        The name of the cluster
      - Description (string) –
        
        The description of the cluster configuration
      - NodeType (string) –
        
        The node type used for the cluster
      - Engine (string) –
        
        The configuration for the Redis OSS or Valkey engine used by the cluster.
      - EngineVersion (string) –
        
        The engine version used by the cluster
      - MaintenanceWindow (string) –
        
        The specified maintenance window for the cluster
      - TopicArn (string) –
        
        The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
      - Port (integer) –
        
        The port used by the cluster
      - ParameterGroupName (string) –
        
        The name of parameter group used by the cluster
      - SubnetGroupName (string) –
        
        The name of the subnet group used by the cluster
      - VpcId (string) –
        
        The ID of the VPC the cluster belongs to
      - SnapshotRetentionLimit (integer) –
        
        The snapshot retention limit set by the cluster
      - SnapshotWindow (string) –
        
        The snapshot window set by the cluster
      - NumShards (integer) –
        
        The number of shards in the cluster
      - Shards (list) –
        
        The list of shards in the cluster
        
        (dict) –
        
        Provides details of a shard in a snapshot
        
        Name (string) –
        
        The name of the shard
        
        Configuration (dict) –
        
        The configuration details of the shard
        
        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.
        
        ReplicaCount (integer) –
        
        The number of read replica nodes in this shard.
        
        Size (string) –
        
        The size of the shard’s snapshot
        
        SnapshotCreationTime (datetime) –
        
        The date and time that the shard’s snapshot was created
    - DataTiering (string) –
      
      Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Exceptions

MemoryDB.Client.exceptions.SnapshotNotFoundFault
MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault
MemoryDB.Client.exceptions.InvalidParameterValueException
MemoryDB.Client.exceptions.InvalidParameterCombinationException