Network.AWS.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

describeCache

Arguments

:: Text

dcGatewayARN

-> DescribeCache

Creates a value of DescribeCache with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcGatewayARN - Undocumented member.

data DescribeCache

See: describeCache smart constructor.

Instances

Eq DescribeCache

Methods

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

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

Data DescribeCache

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeCache -> c DescribeCache

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeCache

toConstr :: DescribeCache -> Constr

dataTypeOf :: DescribeCache -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeCache)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeCache)

gmapT :: (forall b. Data b => b -> b) -> DescribeCache -> DescribeCache

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCache -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCache -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeCache -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeCache -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeCache -> m DescribeCache

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCache -> m DescribeCache

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCache -> m DescribeCache

Read DescribeCache

Methods

readsPrec :: Int -> ReadS DescribeCache

readList :: ReadS [DescribeCache]

readPrec :: ReadPrec DescribeCache

readListPrec :: ReadPrec [DescribeCache]

Show DescribeCache

Methods

showsPrec :: Int -> DescribeCache -> ShowS

show :: DescribeCache -> String

showList :: [DescribeCache] -> ShowS

Generic DescribeCache

Associated Types

type Rep DescribeCache :: * -> *

Methods

from :: DescribeCache -> Rep DescribeCache x

to :: Rep DescribeCache x -> DescribeCache

Hashable DescribeCache

Methods

hashWithSalt :: Int -> DescribeCache -> Int

hash :: DescribeCache -> Int

ToJSON DescribeCache

Methods

toJSON :: DescribeCache -> Value

toEncoding :: DescribeCache -> Encoding

toJSONList :: [DescribeCache] -> Value

toEncodingList :: [DescribeCache] -> Encoding

NFData DescribeCache

Methods

rnf :: DescribeCache -> ()

AWSRequest DescribeCache

Associated Types

type Rs DescribeCache :: *

Methods

request :: DescribeCache -> Request DescribeCache

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeCache -> ClientResponse -> m (Response DescribeCache)

ToHeaders DescribeCache

Methods

toHeaders :: DescribeCache -> [Header]

ToPath DescribeCache

Methods

toPath :: DescribeCache -> ByteString

ToQuery DescribeCache

Methods

toQuery :: DescribeCache -> QueryString

type Rep DescribeCache

type Rep DescribeCache = D1 * (MetaData "DescribeCache" "Network.AWS.StorageGateway.DescribeCache" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" True) (C1 * (MetaCons "DescribeCache'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dcGatewayARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeCache

type Rs DescribeCache = DescribeCacheResponse

Request Lenses

dcGatewayARN :: Lens' DescribeCache Text

Undocumented member.

Destructuring the Response

describeCacheResponse

Arguments

:: Int

dcrsResponseStatus

-> DescribeCacheResponse

Creates a value of DescribeCacheResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcrsGatewayARN - Undocumented member.
• dcrsDiskIds - Undocumented member.
• dcrsCacheUsedPercentage - Undocumented member.
• dcrsCacheHitPercentage - Undocumented member.
• dcrsCacheMissPercentage - Undocumented member.
• dcrsCacheAllocatedInBytes - Undocumented member.
• dcrsCacheDirtyPercentage - Undocumented member.
• dcrsResponseStatus - -- | The response status code.

data DescribeCacheResponse

See: describeCacheResponse smart constructor.

Instances

Eq DescribeCacheResponse

Methods

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

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

Data DescribeCacheResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeCacheResponse -> c DescribeCacheResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeCacheResponse

toConstr :: DescribeCacheResponse -> Constr

dataTypeOf :: DescribeCacheResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeCacheResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeCacheResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeCacheResponse -> DescribeCacheResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCacheResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCacheResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeCacheResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeCacheResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeCacheResponse -> m DescribeCacheResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCacheResponse -> m DescribeCacheResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCacheResponse -> m DescribeCacheResponse

Read DescribeCacheResponse

Methods

readsPrec :: Int -> ReadS DescribeCacheResponse

readList :: ReadS [DescribeCacheResponse]

readPrec :: ReadPrec DescribeCacheResponse

readListPrec :: ReadPrec [DescribeCacheResponse]

Show DescribeCacheResponse

Methods

showsPrec :: Int -> DescribeCacheResponse -> ShowS

show :: DescribeCacheResponse -> String

showList :: [DescribeCacheResponse] -> ShowS

Generic DescribeCacheResponse

Associated Types

type Rep DescribeCacheResponse :: * -> *

Methods

from :: DescribeCacheResponse -> Rep DescribeCacheResponse x

to :: Rep DescribeCacheResponse x -> DescribeCacheResponse

NFData DescribeCacheResponse

Methods

rnf :: DescribeCacheResponse -> ()

type Rep DescribeCacheResponse

type Rep DescribeCacheResponse = D1 * (MetaData "DescribeCacheResponse" "Network.AWS.StorageGateway.DescribeCache" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" False) (C1 * (MetaCons "DescribeCacheResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dcrsDiskIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsCacheUsedPercentage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_dcrsCacheHitPercentage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsCacheMissPercentage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_dcrsCacheAllocatedInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsCacheDirtyPercentage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_dcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

dcrsGatewayARN :: Lens' DescribeCacheResponse (Maybe Text)

Undocumented member.

dcrsDiskIds :: Lens' DescribeCacheResponse [Text]

Undocumented member.

dcrsCacheUsedPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Undocumented member.

dcrsCacheHitPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Undocumented member.

dcrsCacheMissPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Undocumented member.

dcrsCacheAllocatedInBytes :: Lens' DescribeCacheResponse (Maybe Integer)

Undocumented member.

dcrsCacheDirtyPercentage :: Lens' DescribeCacheResponse (Maybe Double)

Undocumented member.

dcrsResponseStatus :: Lens' DescribeCacheResponse Int

• - | The response status code.