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 |
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias
.
The response might include several aliases that do not have a TargetKeyId
field because they are not associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an alias is not associated with a CMK, the alias does not count against the alias limit for your account.
This operation returns paginated results.
Synopsis
- listAliases :: ListAliases
- data ListAliases
- laMarker :: Lens' ListAliases (Maybe Text)
- laLimit :: Lens' ListAliases (Maybe Natural)
- listAliasesResponse :: Int -> ListAliasesResponse
- data ListAliasesResponse
- larsTruncated :: Lens' ListAliasesResponse (Maybe Bool)
- larsAliases :: Lens' ListAliasesResponse [AliasListEntry]
- larsNextMarker :: Lens' ListAliasesResponse (Maybe Text)
- larsResponseStatus :: Lens' ListAliasesResponse Int
Creating a Request
listAliases :: ListAliases Source #
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 in a subsequent request after you receive a response with truncated results. Set it to the value ofNextMarker
from the truncated response you just received.laLimit
- 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 100, inclusive. If you do not include a value, it defaults to 50.
data ListAliases Source #
See: listAliases
smart constructor.
Instances
Request Lenses
laMarker :: Lens' ListAliases (Maybe Text) Source #
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.
laLimit :: Lens' ListAliases (Maybe Natural) Source #
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 100, inclusive. If you do not include a value, it defaults to 50.
Destructuring the Response
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. When this value is true, the list in this response is truncated. To get more items, pass the value of theNextMarker
element in this response to theMarker
parameter in a subsequent request.larsAliases
- A list of aliases.larsNextMarker
- WhenTruncated
is true, this element is present and contains the value to use for theMarker
parameter in a subsequent request.larsResponseStatus
- -- | The response status code.
data ListAliasesResponse Source #
See: listAliasesResponse
smart constructor.
Instances
Response Lenses
larsTruncated :: Lens' ListAliasesResponse (Maybe Bool) Source #
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.
larsAliases :: Lens' ListAliasesResponse [AliasListEntry] Source #
A list of aliases.
larsNextMarker :: Lens' ListAliasesResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value to use for the Marker
parameter in a subsequent request.
larsResponseStatus :: Lens' ListAliasesResponse Int Source #
- - | The response status code.