Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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' {}
- newDescribeCacheResponse :: Int -> DescribeCacheResponse
- describeCacheResponse_cacheAllocatedInBytes :: Lens' DescribeCacheResponse (Maybe Integer)
- describeCacheResponse_cacheDirtyPercentage :: Lens' DescribeCacheResponse (Maybe Double)
- describeCacheResponse_cacheHitPercentage :: Lens' DescribeCacheResponse (Maybe Double)
- describeCacheResponse_cacheMissPercentage :: Lens' DescribeCacheResponse (Maybe Double)
- describeCacheResponse_cacheUsedPercentage :: Lens' DescribeCacheResponse (Maybe Double)
- describeCacheResponse_diskIds :: Lens' DescribeCacheResponse (Maybe [Text])
- describeCacheResponse_gatewayARN :: Lens' DescribeCacheResponse (Maybe Text)
- describeCacheResponse_httpStatus :: Lens' DescribeCacheResponse Int
Creating a Request
data DescribeCache Source #
See: newDescribeCache
smart constructor.
Instances
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 Source #
Undocumented member.
Destructuring the Response
data DescribeCacheResponse Source #
See: newDescribeCacheResponse
smart constructor.
DescribeCacheResponse' | |
|
Instances
newDescribeCacheResponse Source #
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) 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_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_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_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_gatewayARN :: Lens' DescribeCacheResponse (Maybe Text) Source #
Undocumented member.
describeCacheResponse_httpStatus :: Lens' DescribeCacheResponse Int Source #
The response's http status code.