describe-snapshots¶
Description¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-snapshots
[--cluster-name <value>]
[--snapshot-name <value>]
[--source <value>]
[--next-token <value>]
[--max-results <value>]
[--show-detail | --no-show-detail]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--cluster-name (string)
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
--snapshot-name (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.
--next-token (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.
--max-results (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.
--show-detail | --no-show-detail (boolean)
A Boolean value which if true, the shard configuration is included in the snapshot description.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
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.
(structure)
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 -> (structure)
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
EngineVersion -> (string)
The Redis 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
(structure)
Provides details of a shard in a snapshot
Name -> (string)
The name of the shard
Configuration -> (structure)
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 -> (timestamp)
The date and time that the shard’s snapshot was created