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

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

Network.AWS.KMS.ListAliases

Contents

Description

Lists all of the key aliases in the account.

This operation returns paginated results.

Synopsis

Creating a Request

listAliases :: ListAliases #

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

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

  • laMarker - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
  • laLimit - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

data ListAliases #

See: listAliases smart constructor.

Instances

Eq ListAliases # 
Data ListAliases # 

Methods

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

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

toConstr :: ListAliases -> Constr #

dataTypeOf :: ListAliases -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListAliases -> ListAliases #

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

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

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

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

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

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

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

Read ListAliases # 
Show ListAliases # 
Generic ListAliases # 

Associated Types

type Rep ListAliases :: * -> * #

Hashable ListAliases # 
ToJSON ListAliases # 
NFData ListAliases # 

Methods

rnf :: ListAliases -> () #

AWSPager ListAliases # 
AWSRequest ListAliases # 
ToQuery ListAliases # 
ToPath ListAliases # 
ToHeaders ListAliases # 

Methods

toHeaders :: ListAliases -> [Header] #

type Rep ListAliases # 
type Rep ListAliases = D1 (MetaData "ListAliases" "Network.AWS.KMS.ListAliases" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListAliases'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_laMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_laLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs ListAliases # 

Request Lenses

laMarker :: Lens' ListAliases (Maybe Text) #

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

laLimit :: Lens' ListAliases (Maybe Natural) #

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Destructuring the Response

listAliasesResponse #

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

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

  • larsTruncated - A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
  • larsAliases - A list of key aliases in the user's account.
  • larsNextMarker - When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • larsResponseStatus - -- | The response status code.

data ListAliasesResponse #

See: listAliasesResponse smart constructor.

Instances

Eq ListAliasesResponse # 
Data ListAliasesResponse # 

Methods

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

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

toConstr :: ListAliasesResponse -> Constr #

dataTypeOf :: ListAliasesResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListAliasesResponse -> ListAliasesResponse #

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

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

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

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

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

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

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

Read ListAliasesResponse # 
Show ListAliasesResponse # 
Generic ListAliasesResponse # 
NFData ListAliasesResponse # 

Methods

rnf :: ListAliasesResponse -> () #

type Rep ListAliasesResponse # 
type Rep ListAliasesResponse = D1 (MetaData "ListAliasesResponse" "Network.AWS.KMS.ListAliases" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListAliasesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_larsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_larsAliases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AliasListEntry])))) ((:*:) (S1 (MetaSel (Just Symbol "_larsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_larsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

larsTruncated :: Lens' ListAliasesResponse (Maybe Bool) #

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

larsAliases :: Lens' ListAliasesResponse [AliasListEntry] #

A list of key aliases in the user's account.

larsNextMarker :: Lens' ListAliasesResponse (Maybe Text) #

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

larsResponseStatus :: Lens' ListAliasesResponse Int #

  • - | The response status code.