amazonka-iam-1.6.0: Amazon Identity and Access Management 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.IAM.ListAccountAliases

Contents

Description

Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide .

This operation returns paginated results.

Synopsis

Creating a Request

listAccountAliases :: ListAccountAliases #

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

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

  • laaMarker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
  • laaMaxItems - (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true . If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

data ListAccountAliases #

See: listAccountAliases smart constructor.

Instances

Eq ListAccountAliases # 
Data ListAccountAliases # 

Methods

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

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

toConstr :: ListAccountAliases -> Constr #

dataTypeOf :: ListAccountAliases -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListAccountAliases # 
Show ListAccountAliases # 
Generic ListAccountAliases # 
Hashable ListAccountAliases # 
NFData ListAccountAliases # 

Methods

rnf :: ListAccountAliases -> () #

AWSPager ListAccountAliases # 
AWSRequest ListAccountAliases # 
ToHeaders ListAccountAliases # 
ToPath ListAccountAliases # 
ToQuery ListAccountAliases # 
type Rep ListAccountAliases # 
type Rep ListAccountAliases = D1 * (MetaData "ListAccountAliases" "Network.AWS.IAM.ListAccountAliases" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "ListAccountAliases'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_laaMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_laaMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))
type Rs ListAccountAliases # 

Request Lenses

laaMarker :: Lens' ListAccountAliases (Maybe Text) #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

laaMaxItems :: Lens' ListAccountAliases (Maybe Natural) #

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true . If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Destructuring the Response

listAccountAliasesResponse #

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

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

  • laarsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • laarsIsTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
  • laarsResponseStatus - -- | The response status code.
  • laarsAccountAliases - A list of aliases associated with the account. AWS supports only one alias per account.

data ListAccountAliasesResponse #

Contains the response to a successful ListAccountAliases request.

See: listAccountAliasesResponse smart constructor.

Instances

Eq ListAccountAliasesResponse # 
Data ListAccountAliasesResponse # 

Methods

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

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

toConstr :: ListAccountAliasesResponse -> Constr #

dataTypeOf :: ListAccountAliasesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListAccountAliasesResponse # 
Show ListAccountAliasesResponse # 
Generic ListAccountAliasesResponse # 
NFData ListAccountAliasesResponse # 
type Rep ListAccountAliasesResponse # 
type Rep ListAccountAliasesResponse = D1 * (MetaData "ListAccountAliasesResponse" "Network.AWS.IAM.ListAccountAliases" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "ListAccountAliasesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_laarsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_laarsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_laarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_laarsAccountAliases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])))))

Response Lenses

laarsMarker :: Lens' ListAccountAliasesResponse (Maybe Text) #

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

laarsIsTruncated :: Lens' ListAccountAliasesResponse (Maybe Bool) #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

laarsResponseStatus :: Lens' ListAccountAliasesResponse Int #

  • - | The response status code.

laarsAccountAliases :: Lens' ListAccountAliasesResponse [Text] #

A list of aliases associated with the account. AWS supports only one alias per account.