Skip to content

Describe Snapshots

memorydb_describe_snapshots R Documentation

Returns information about cluster 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.

Usage

memorydb_describe_snapshots(ClusterName, SnapshotName, Source,
  NextToken, MaxResults, ShowDetail)

Arguments

ClusterName

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

SnapshotName

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

Source

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

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

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

A Boolean value which if true, the shard configuration is included in the snapshot description.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Snapshots = list(
    list(
      Name = "string",
      Status = "string",
      Source = "string",
      KmsKeyId = "string",
      ARN = "string",
      ClusterConfiguration = list(
        Name = "string",
        Description = "string",
        NodeType = "string",
        EngineVersion = "string",
        MaintenanceWindow = "string",
        TopicArn = "string",
        Port = 123,
        ParameterGroupName = "string",
        SubnetGroupName = "string",
        VpcId = "string",
        SnapshotRetentionLimit = 123,
        SnapshotWindow = "string",
        NumShards = 123,
        Shards = list(
          list(
            Name = "string",
            Configuration = list(
              Slots = "string",
              ReplicaCount = 123
            ),
            Size = "string",
            SnapshotCreationTime = as.POSIXct(
              "2015-01-01"
            )
          )
        )
      ),
      DataTiering = "true"|"false"
    )
  )
)

Request syntax

svc$describe_snapshots(
  ClusterName = "string",
  SnapshotName = "string",
  Source = "string",
  NextToken = "string",
  MaxResults = 123,
  ShowDetail = TRUE|FALSE
)