Amazonka.StorageGateway.DescribeCache

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.

Creating a Request

data DescribeCache

See: newDescribeCache smart constructor.

Constructors

DescribeCache'

Fields

• gatewayARN :: Text

Instances

ToJSON DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

toJSON :: DescribeCache -> Value

toEncoding :: DescribeCache -> Encoding

toJSONList :: [DescribeCache] -> Value

toEncodingList :: [DescribeCache] -> Encoding

ToHeaders DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

toHeaders :: DescribeCache -> [Header]

ToPath DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

toPath :: DescribeCache -> ByteString

ToQuery DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

toQuery :: DescribeCache -> QueryString

AWSRequest DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Associated Types

type AWSResponse DescribeCache

Methods

request :: (Service -> Service) -> DescribeCache -> Request DescribeCache

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCache)))

Generic DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Associated Types

type Rep DescribeCache :: Type -> Type

Methods

from :: DescribeCache -> Rep DescribeCache x

to :: Rep DescribeCache x -> DescribeCache

Read DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

readsPrec :: Int -> ReadS DescribeCache

readList :: ReadS [DescribeCache]

readPrec :: ReadPrec DescribeCache

readListPrec :: ReadPrec [DescribeCache]

Show DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

showsPrec :: Int -> DescribeCache -> ShowS

show :: DescribeCache -> String

showList :: [DescribeCache] -> ShowS

NFData DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

rnf :: DescribeCache -> ()

Eq DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

(==) :: DescribeCache -> DescribeCache -> Bool

(/=) :: DescribeCache -> DescribeCache -> Bool

Hashable DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

Methods

hashWithSalt :: Int -> DescribeCache -> Int

hash :: DescribeCache -> Int

type AWSResponse DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

type AWSResponse DescribeCache = DescribeCacheResponse

type Rep DescribeCache

Defined in Amazonka.StorageGateway.DescribeCache

type Rep DescribeCache = D1 ('MetaData "DescribeCache" "Amazonka.StorageGateway.DescribeCache" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeCache'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCache

Arguments

:: Text

DescribeCache

-> DescribeCache

Create a value of DescribeCache with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeCache, describeCache_gatewayARN - Undocumented member.

Request Lenses

describeCache_gatewayARN :: Lens' DescribeCache Text

Undocumented member.

Destructuring the Response

data DescribeCacheResponse

See: newDescribeCacheResponse smart constructor.

Constructors

DescribeCacheResponse'

Fields

• cacheAllocatedInBytes :: Maybe Integer

  The amount of cache in bytes allocated to a gateway.

• cacheDirtyPercentage :: Maybe Double

  The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

• cacheHitPercentage :: Maybe Double

  Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

• cacheMissPercentage :: Maybe Double

  Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

• cacheUsedPercentage :: Maybe Double

  Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

• diskIds :: Maybe [Text]

  An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

Associated Types

type Rep DescribeCacheResponse :: Type -> Type

Methods

from :: DescribeCacheResponse -> Rep DescribeCacheResponse x

to :: Rep DescribeCacheResponse x -> DescribeCacheResponse

Read DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

Methods

readsPrec :: Int -> ReadS DescribeCacheResponse

readList :: ReadS [DescribeCacheResponse]

readPrec :: ReadPrec DescribeCacheResponse

readListPrec :: ReadPrec [DescribeCacheResponse]

Show DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

Methods

showsPrec :: Int -> DescribeCacheResponse -> ShowS

show :: DescribeCacheResponse -> String

showList :: [DescribeCacheResponse] -> ShowS

NFData DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

Methods

rnf :: DescribeCacheResponse -> ()

Eq DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

Methods

(==) :: DescribeCacheResponse -> DescribeCacheResponse -> Bool

(/=) :: DescribeCacheResponse -> DescribeCacheResponse -> Bool

type Rep DescribeCacheResponse

Defined in Amazonka.StorageGateway.DescribeCache

type Rep DescribeCacheResponse = D1 ('MetaData "DescribeCacheResponse" "Amazonka.StorageGateway.DescribeCache" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeCacheResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheAllocatedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "cacheDirtyPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "cacheHitPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "cacheMissPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "cacheUsedPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "diskIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeCacheResponse

Arguments

:: Int

$sel:httpStatus:DescribeCacheResponse'

-> DescribeCacheResponse

Create a value of DescribeCacheResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheAllocatedInBytes:DescribeCacheResponse', describeCacheResponse_cacheAllocatedInBytes - The amount of cache in bytes allocated to a gateway.

$sel:cacheDirtyPercentage:DescribeCacheResponse', describeCacheResponse_cacheDirtyPercentage - The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

$sel:cacheHitPercentage:DescribeCacheResponse', describeCacheResponse_cacheHitPercentage - Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

$sel:cacheMissPercentage:DescribeCacheResponse', describeCacheResponse_cacheMissPercentage - Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

$sel:cacheUsedPercentage:DescribeCacheResponse', describeCacheResponse_cacheUsedPercentage - Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

$sel:diskIds:DescribeCacheResponse', describeCacheResponse_diskIds - An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

DescribeCache, describeCacheResponse_gatewayARN - Undocumented member.

$sel:httpStatus:DescribeCacheResponse', describeCacheResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheResponse_cacheAllocatedInBytes :: Lens' DescribeCacheResponse (Maybe Integer)

The amount of cache in bytes allocated to a gateway.

describeCacheResponse_cacheDirtyPercentage :: Lens' DescribeCacheResponse (Maybe Double)

The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

describeCacheResponse_cacheHitPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

describeCacheResponse_cacheMissPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

describeCacheResponse_cacheUsedPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

describeCacheResponse_diskIds :: Lens' DescribeCacheResponse (Maybe [Text])

An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

describeCacheResponse_gatewayARN :: Lens' DescribeCacheResponse (Maybe Text)

Undocumented member.

describeCacheResponse_httpStatus :: Lens' DescribeCacheResponse Int

The response's http status code.