amazonka-kms-1.6.0: Amazon Key Management Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KMS.ListKeys

Contents

Description

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

This operation returns paginated results.

Synopsis

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 # 
Data 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 # 
Show ListKeys # 
Generic ListKeys # 

Associated Types

type Rep ListKeys :: * -> * #

Methods

from :: ListKeys -> Rep ListKeys x #

to :: Rep ListKeys x -> ListKeys #

Hashable ListKeys # 

Methods

hashWithSalt :: Int -> ListKeys -> Int #

hash :: ListKeys -> Int #

ToJSON ListKeys # 
NFData ListKeys # 

Methods

rnf :: ListKeys -> () #

AWSPager ListKeys # 
AWSRequest ListKeys # 
ToHeaders ListKeys # 

Methods

toHeaders :: ListKeys -> [Header] #

ToPath ListKeys # 
ToQuery ListKeys # 
type Rep ListKeys # 
type Rep ListKeys = D1 * (MetaData "ListKeys" "Network.AWS.KMS.ListKeys" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" False) (C1 * (MetaCons "ListKeys'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lkMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lkLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))
type Rs ListKeys # 

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 #

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 # 
Data ListKeysResponse # 

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 # 
Show ListKeysResponse # 
Generic ListKeysResponse # 
NFData ListKeysResponse # 

Methods

rnf :: ListKeysResponse -> () #

type Rep ListKeysResponse # 
type Rep ListKeysResponse = D1 * (MetaData "ListKeysResponse" "Network.AWS.KMS.ListKeys" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" False) (C1 * (MetaCons "ListKeysResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lkrsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_lkrsKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [KeyListEntry])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lkrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_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.