paws.storage (version 0.1.12)

storagegateway_describe_cache: 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)

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
)

Arguments

GatewayARN

[required]

Request syntax

svc$describe_cache(
  GatewayARN = "string"
)

Examples

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