Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . storagegateway ]

describe-cache

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-cache
--gateway-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--gateway-arn (string)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

GatewayARN -> (string)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

DiskIds -> (list)

(string)

CacheAllocatedInBytes -> (long)

CacheUsedPercentage -> (double)

CacheDirtyPercentage -> (double)

CacheHitPercentage -> (double)

CacheMissPercentage -> (double)