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 |
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
- listAccountAliases :: ListAccountAliases
- data ListAccountAliases
- laaMarker :: Lens' ListAccountAliases (Maybe Text)
- laaMaxItems :: Lens' ListAccountAliases (Maybe Natural)
- listAccountAliasesResponse :: Int -> ListAccountAliasesResponse
- data ListAccountAliasesResponse
- laarsMarker :: Lens' ListAccountAliasesResponse (Maybe Text)
- laarsIsTruncated :: Lens' ListAccountAliasesResponse (Maybe Bool)
- laarsResponseStatus :: Lens' ListAccountAliasesResponse Int
- laarsAccountAliases :: Lens' ListAccountAliasesResponse [Text]
Creating a Request
listAccountAliases :: ListAccountAliases Source #
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 theMarker
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, theIsTruncated
response element istrue
. 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, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
data ListAccountAliases Source #
See: listAccountAliases
smart constructor.
Instances
Request Lenses
laaMarker :: Lens' ListAccountAliases (Maybe Text) Source #
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) Source #
(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 Source #
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
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
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 theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
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 Source #
Contains the response to a successful ListAccountAliases
request.
See: listAccountAliasesResponse
smart constructor.
Instances
Response Lenses
laarsMarker :: Lens' ListAccountAliasesResponse (Maybe Text) Source #
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) Source #
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 Source #
- - | The response status code.
laarsAccountAliases :: Lens' ListAccountAliasesResponse [Text] Source #
A list of aliases associated with the account. AWS supports only one alias per account.