Skip to content

Returns information about the cache of a gateway

Description

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Usage

storagegateway_describe_cache(GatewayARN)

Arguments

  • GatewayARN

    [required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

Value

A list with the following syntax:

list(
  GatewayARN = "string",
  DiskIds = list(
    "string"
  ),
  CacheAllocatedInBytes = 123,
  CacheUsedPercentage = 123.0,
  CacheDirtyPercentage = 123.0,
  CacheHitPercentage = 123.0,
  CacheMissPercentage = 123.0
)

Request syntax

svc$describe_cache(
  GatewayARN = "string"
)

Examples

# Returns information about the cache of a gateway.
svc$describe_cache(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)