Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.KMS.ListKeys

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.

This operation returns paginated results.

Synopsis

listKeys :: ListKeys
data ListKeys
lkMarker :: Lens' ListKeys (Maybe Text)
lkLimit :: Lens' ListKeys (Maybe Natural)
listKeysResponse :: Int -> ListKeysResponse
data ListKeysResponse
lkrsTruncated :: Lens' ListKeysResponse (Maybe Bool)
lkrsKeys :: Lens' ListKeysResponse [KeyListEntry]
lkrsNextMarker :: Lens' ListKeysResponse (Maybe Text)
lkrsResponseStatus :: Lens' ListKeysResponse Int

Creating a Request

listKeys :: ListKeys #

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

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

lkMarker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
lkLimit - Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

data ListKeys #

See: listKeys smart constructor.

Instances

Eq ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods (==) :: ListKeys -> ListKeys -> Bool # (/=) :: ListKeys -> ListKeys -> Bool #
Data ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListKeys -> c ListKeys # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListKeys # toConstr :: ListKeys -> Constr # dataTypeOf :: ListKeys -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListKeys) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListKeys) # gmapT :: (forall b. Data b => b -> b) -> ListKeys -> ListKeys # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListKeys -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListKeys -> r # gmapQ :: (forall d. Data d => d -> u) -> ListKeys -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListKeys -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListKeys -> m ListKeys # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListKeys -> m ListKeys # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListKeys -> m ListKeys #
Read ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods readsPrec :: Int -> ReadS ListKeys # readList :: ReadS [ListKeys] # readPrec :: ReadPrec ListKeys # readListPrec :: ReadPrec [ListKeys] #
Show ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods showsPrec :: Int -> ListKeys -> ShowS # show :: ListKeys -> String # showList :: [ListKeys] -> ShowS #
Generic ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Associated Types type Rep ListKeys :: * -> * # Methods from :: ListKeys -> Rep ListKeys x # to :: Rep ListKeys x -> ListKeys #
Hashable ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods hashWithSalt :: Int -> ListKeys -> Int # hash :: ListKeys -> Int #
ToJSON ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods toJSON :: ListKeys -> Value # toEncoding :: ListKeys -> Encoding # toJSONList :: [ListKeys] -> Value # toEncodingList :: [ListKeys] -> Encoding #
AWSPager ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods page :: ListKeys -> Rs ListKeys -> Maybe ListKeys #
AWSRequest ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Associated Types type Rs ListKeys :: * # Methods request :: ListKeys -> Request ListKeys # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListKeys -> ClientResponse -> m (Response ListKeys) #
ToHeaders ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods toHeaders :: ListKeys -> [Header] #
ToPath ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods toPath :: ListKeys -> ByteString #
ToQuery ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods toQuery :: ListKeys -> QueryString #
NFData ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys Methods rnf :: ListKeys -> () #
type Rep ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys type Rep ListKeys = D1 (MetaData "ListKeys" "Network.AWS.KMS.ListKeys" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "ListKeys'" PrefixI True) (S1 (MetaSel (Just "_lkMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lkLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))
type Rs ListKeys #
Instance details Defined in Network.AWS.KMS.ListKeys type Rs ListKeys = ListKeysResponse

Request Lenses

lkMarker :: Lens' ListKeys (Maybe Text) #

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

lkLimit :: Lens' ListKeys (Maybe Natural) #

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Destructuring the Response

listKeysResponse #

Arguments

:: Int	`lkrsResponseStatus`
-> ListKeysResponse

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

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

lkrsTruncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
lkrsKeys - A list of customer master keys (CMKs).
lkrsNextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
lkrsResponseStatus - -- | The response status code.

data ListKeysResponse #

See: listKeysResponse smart constructor.

Instances

Eq ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Methods (==) :: ListKeysResponse -> ListKeysResponse -> Bool # (/=) :: ListKeysResponse -> ListKeysResponse -> Bool #
Data ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListKeysResponse -> c ListKeysResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListKeysResponse # toConstr :: ListKeysResponse -> Constr # dataTypeOf :: ListKeysResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListKeysResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListKeysResponse) # gmapT :: (forall b. Data b => b -> b) -> ListKeysResponse -> ListKeysResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListKeysResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListKeysResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListKeysResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListKeysResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListKeysResponse -> m ListKeysResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListKeysResponse -> m ListKeysResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListKeysResponse -> m ListKeysResponse #
Read ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Methods readsPrec :: Int -> ReadS ListKeysResponse # readList :: ReadS [ListKeysResponse] # readPrec :: ReadPrec ListKeysResponse # readListPrec :: ReadPrec [ListKeysResponse] #
Show ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Methods showsPrec :: Int -> ListKeysResponse -> ShowS # show :: ListKeysResponse -> String # showList :: [ListKeysResponse] -> ShowS #
Generic ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Associated Types type Rep ListKeysResponse :: * -> * # Methods from :: ListKeysResponse -> Rep ListKeysResponse x # to :: Rep ListKeysResponse x -> ListKeysResponse #
NFData ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys Methods rnf :: ListKeysResponse -> () #
type Rep ListKeysResponse #
Instance details Defined in Network.AWS.KMS.ListKeys type Rep ListKeysResponse = D1 (MetaData "ListKeysResponse" "Network.AWS.KMS.ListKeys" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "ListKeysResponse'" PrefixI True) ((S1 (MetaSel (Just "_lkrsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_lkrsKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [KeyListEntry]))) :: (S1 (MetaSel (Just "_lkrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lkrsTruncated :: Lens' ListKeysResponse (Maybe Bool) #

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

lkrsKeys :: Lens' ListKeysResponse [KeyListEntry] #

A list of customer master keys (CMKs).

lkrsNextMarker :: Lens' ListKeysResponse (Maybe Text) #

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

lkrsResponseStatus :: Lens' ListKeysResponse Int #

- | The response status code.