GET

/#Action=DescribeSnapshots

http://elasticache.{region}.amazonaws.com/#Action=DescribeSnapshots

Returns information about cluster or replication group snapshots. By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. <note> This operation is valid for Redis only. </note>

Access Token Required: API Key

Query Params

ReplicationGroupIdstring

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

CacheClusterIdstring

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

SnapshotNamestring

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

SnapshotSourcestring

If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Markerstring

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.

MaxRecordsinteger

The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.

ShowNodeGroupConfigboolean

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

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://elasticache.{region}.amazonaws.com/#Action=DescribeSnapshots' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}