storagegateway_describe_cache: Returns information about the cache of a gateway

Description Usage Arguments Value Request syntax Examples

View source: R/storagegateway_operations.R

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

1

Arguments

GatewayARN

[required]

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
list(
  GatewayARN = "string",
  DiskIds = list(
    "string"
  ),
  CacheAllocatedInBytes = 123,
  CacheUsedPercentage = 123.0,
  CacheDirtyPercentage = 123.0,
  CacheHitPercentage = 123.0,
  CacheMissPercentage = 123.0
)

Request syntax

1
2
3
svc$describe_cache(
  GatewayARN = "string"
)

Examples

1
2
3
4
5
6
7
## Not run: 
# Returns information about the cache of a gateway.
svc$describe_cache(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.