Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StorageGateway.DescribeCache

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data DescribeCache = DescribeCache' {
- gatewayARN :: Text
}
newDescribeCache :: Text -> DescribeCache
describeCache_gatewayARN :: Lens' DescribeCache Text
data DescribeCacheResponse = DescribeCacheResponse' {
- gatewayARN :: Maybe Text
- diskIds :: Maybe [Text]
- cacheUsedPercentage :: Maybe Double
- cacheHitPercentage :: Maybe Double
- cacheMissPercentage :: Maybe Double
- cacheAllocatedInBytes :: Maybe Integer
- cacheDirtyPercentage :: Maybe Double
- httpStatus :: Int
}
newDescribeCacheResponse :: Int -> DescribeCacheResponse
describeCacheResponse_gatewayARN :: Lens' DescribeCacheResponse (Maybe Text)
describeCacheResponse_diskIds :: Lens' DescribeCacheResponse (Maybe [Text])
describeCacheResponse_cacheUsedPercentage :: Lens' DescribeCacheResponse (Maybe Double)
describeCacheResponse_cacheHitPercentage :: Lens' DescribeCacheResponse (Maybe Double)
describeCacheResponse_cacheMissPercentage :: Lens' DescribeCacheResponse (Maybe Double)
describeCacheResponse_cacheAllocatedInBytes :: Lens' DescribeCacheResponse (Maybe Integer)
describeCacheResponse_cacheDirtyPercentage :: Lens' DescribeCacheResponse (Maybe Double)
describeCacheResponse_httpStatus :: Lens' DescribeCacheResponse Int

Creating a Request

data DescribeCache Source #

See: newDescribeCache smart constructor.

Constructors

DescribeCache'
Fields gatewayARN :: Text

Instances

Instances details

Eq DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods (==) :: DescribeCache -> DescribeCache -> Bool # (/=) :: DescribeCache -> DescribeCache -> Bool #
Read DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods readsPrec :: Int -> ReadS DescribeCache # readList :: ReadS [DescribeCache] # readPrec :: ReadPrec DescribeCache # readListPrec :: ReadPrec [DescribeCache] #
Show DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods showsPrec :: Int -> DescribeCache -> ShowS # show :: DescribeCache -> String # showList :: [DescribeCache] -> ShowS #
Generic DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Associated Types type Rep DescribeCache :: Type -> Type # Methods from :: DescribeCache -> Rep DescribeCache x # to :: Rep DescribeCache x -> DescribeCache #
NFData DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods rnf :: DescribeCache -> () #
Hashable DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods hashWithSalt :: Int -> DescribeCache -> Int # hash :: DescribeCache -> Int #
ToJSON DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods toJSON :: DescribeCache -> Value # toEncoding :: DescribeCache -> Encoding # toJSONList :: [DescribeCache] -> Value # toEncodingList :: [DescribeCache] -> Encoding #
AWSRequest DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Associated Types type AWSResponse DescribeCache # Methods request :: DescribeCache -> Request DescribeCache # response :: MonadResource m => Logger -> Service -> Proxy DescribeCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCache))) #
ToHeaders DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods toHeaders :: DescribeCache -> [Header] #
ToPath DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods toPath :: DescribeCache -> ByteString #
ToQuery DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods toQuery :: DescribeCache -> QueryString #
type Rep DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache type Rep DescribeCache = D1 ('MetaData "DescribeCache" "Amazonka.StorageGateway.DescribeCache" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeCache'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeCache Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache type AWSResponse DescribeCache = DescribeCacheResponse

newDescribeCache Source #

Arguments

:: Text	`$sel:gatewayARN: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:

$sel:gatewayARN:DescribeCache', describeCache_gatewayARN - Undocumented member.

Request Lenses

describeCache_gatewayARN :: Lens' DescribeCache Text Source #

Undocumented member.

Destructuring the Response

data DescribeCacheResponse Source #

See: newDescribeCacheResponse smart constructor.

Constructors

DescribeCacheResponse'

Fields

gatewayARN :: Maybe Text
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.
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.
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.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods (==) :: DescribeCacheResponse -> DescribeCacheResponse -> Bool # (/=) :: DescribeCacheResponse -> DescribeCacheResponse -> Bool #
Read DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods readsPrec :: Int -> ReadS DescribeCacheResponse # readList :: ReadS [DescribeCacheResponse] # readPrec :: ReadPrec DescribeCacheResponse # readListPrec :: ReadPrec [DescribeCacheResponse] #
Show DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods showsPrec :: Int -> DescribeCacheResponse -> ShowS # show :: DescribeCacheResponse -> String # showList :: [DescribeCacheResponse] -> ShowS #
Generic DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Associated Types type Rep DescribeCacheResponse :: Type -> Type # Methods from :: DescribeCacheResponse -> Rep DescribeCacheResponse x # to :: Rep DescribeCacheResponse x -> DescribeCacheResponse #
NFData DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache Methods rnf :: DescribeCacheResponse -> () #
type Rep DescribeCacheResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeCache type Rep DescribeCacheResponse = D1 ('MetaData "DescribeCacheResponse" "Amazonka.StorageGateway.DescribeCache" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeCacheResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "diskIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "cacheUsedPercentage") '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 "cacheAllocatedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "cacheDirtyPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeCacheResponse Source #

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:gatewayARN:DescribeCache', describeCacheResponse_gatewayARN - Undocumented member.

$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.

$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: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: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:httpStatus:DescribeCacheResponse', describeCacheResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheResponse_gatewayARN :: Lens' DescribeCacheResponse (Maybe Text) Source #

Undocumented member.

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

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_cacheUsedPercentage :: Lens' DescribeCacheResponse (Maybe Double) Source #

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_cacheHitPercentage :: Lens' DescribeCacheResponse (Maybe Double) Source #

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) Source #

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_cacheAllocatedInBytes :: Lens' DescribeCacheResponse (Maybe Integer) Source #

The amount of cache in bytes allocated to a gateway.

describeCacheResponse_cacheDirtyPercentage :: Lens' DescribeCacheResponse (Maybe Double) Source #

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_httpStatus :: Lens' DescribeCacheResponse Int Source #

The response's http status code.