Skip to content

Returns information about serverless cache snapshots

Description

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

Usage

elasticache_describe_serverless_cache_snapshots(ServerlessCacheName,
  ServerlessCacheSnapshotName, SnapshotType, NextToken, MaxResults)

Arguments

  • ServerlessCacheName

    The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • ServerlessCacheSnapshotName

    The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • SnapshotType

    The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • NextToken

    An optional marker returned from a prior request to support 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 max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

  • MaxResults

    The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

Value

A list with the following syntax:

list(
  NextToken = "string",
  ServerlessCacheSnapshots = list(
    list(
      ServerlessCacheSnapshotName = "string",
      ARN = "string",
      KmsKeyId = "string",
      SnapshotType = "string",
      Status = "string",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      ExpiryTime = as.POSIXct(
        "2015-01-01"
      ),
      BytesUsedForCache = "string",
      ServerlessCacheConfiguration = list(
        ServerlessCacheName = "string",
        Engine = "string",
        MajorEngineVersion = "string"
      )
    )
  )
)

Request syntax

svc$describe_serverless_cache_snapshots(
  ServerlessCacheName = "string",
  ServerlessCacheSnapshotName = "string",
  SnapshotType = "string",
  NextToken = "string",
  MaxResults = 123
)