Copyright | (c) 2013-2021 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 |
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide.
This operation returns paginated results.
Synopsis
- data ListAccountAliases = ListAccountAliases' {}
- newListAccountAliases :: ListAccountAliases
- listAccountAliases_marker :: Lens' ListAccountAliases (Maybe Text)
- listAccountAliases_maxItems :: Lens' ListAccountAliases (Maybe Natural)
- data ListAccountAliasesResponse = ListAccountAliasesResponse' {
- marker :: Maybe Text
- isTruncated :: Maybe Bool
- httpStatus :: Int
- accountAliases :: [Text]
- newListAccountAliasesResponse :: Int -> ListAccountAliasesResponse
- listAccountAliasesResponse_marker :: Lens' ListAccountAliasesResponse (Maybe Text)
- listAccountAliasesResponse_isTruncated :: Lens' ListAccountAliasesResponse (Maybe Bool)
- listAccountAliasesResponse_httpStatus :: Lens' ListAccountAliasesResponse Int
- listAccountAliasesResponse_accountAliases :: Lens' ListAccountAliasesResponse [Text]
Creating a Request
data ListAccountAliases Source #
See: newListAccountAliases
smart constructor.
ListAccountAliases' | |
|
Instances
newListAccountAliases :: ListAccountAliases Source #
Create a value of ListAccountAliases
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListAccountAliases'
, listAccountAliases_marker
- 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.
$sel:maxItems:ListAccountAliases'
, listAccountAliases_maxItems
- 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, the number of items 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.
Request Lenses
listAccountAliases_marker :: 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.
listAccountAliases_maxItems :: Lens' ListAccountAliases (Maybe Natural) Source #
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, the number of items 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
data ListAccountAliasesResponse Source #
Contains the response to a successful ListAccountAliases request.
See: newListAccountAliasesResponse
smart constructor.
ListAccountAliasesResponse' | |
|
Instances
newListAccountAliasesResponse Source #
Create a value of ListAccountAliasesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListAccountAliases'
, listAccountAliasesResponse_marker
- When IsTruncated
is true
, this element is present and contains the
value to use for the Marker
parameter in a subsequent pagination
request.
$sel:isTruncated:ListAccountAliasesResponse'
, listAccountAliasesResponse_isTruncated
- 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 your
results.
$sel:httpStatus:ListAccountAliasesResponse'
, listAccountAliasesResponse_httpStatus
- The response's http status code.
$sel:accountAliases:ListAccountAliasesResponse'
, listAccountAliasesResponse_accountAliases
- A list of aliases associated with the account. Amazon Web Services
supports only one alias per account.
Response Lenses
listAccountAliasesResponse_marker :: 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.
listAccountAliasesResponse_isTruncated :: 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 your
results.
listAccountAliasesResponse_httpStatus :: Lens' ListAccountAliasesResponse Int Source #
The response's http status code.
listAccountAliasesResponse_accountAliases :: Lens' ListAccountAliasesResponse [Text] Source #
A list of aliases associated with the account. Amazon Web Services supports only one alias per account.