| 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 |
Amazonka.KMS.ListAliases
Description
Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias.
By default, the ListAliases operation returns all aliases in the
account and region. To get only the aliases associated with a particular
KMS key, use the KeyId parameter.
The ListAliases response can include aliases that you created and
associated with your customer managed keys, and aliases that Amazon Web
Services created and associated with Amazon Web Services managed keys in
your account. You can recognize Amazon Web Services aliases because
their names have the format aws/<service-name>, such as
aws/dynamodb.
The response might also include aliases that have no TargetKeyId
field. These are predefined aliases that Amazon Web Services has created
but has not yet associated with a KMS key. Aliases that Amazon Web
Services creates in your account, including predefined aliases, do not
count against your
KMS aliases quota.
Cross-account use: No. ListAliases does not return aliases in
other Amazon Web Services accounts.
Required permissions: kms:ListAliases (IAM policy)
For details, see Controlling access to aliases in the Key Management Service Developer Guide.
Related operations:
- CreateAlias
- DeleteAlias
- UpdateAlias
This operation returns paginated results.
Synopsis
- data ListAliases = ListAliases' {}
- newListAliases :: ListAliases
- listAliases_keyId :: Lens' ListAliases (Maybe Text)
- listAliases_marker :: Lens' ListAliases (Maybe Text)
- listAliases_limit :: Lens' ListAliases (Maybe Natural)
- data ListAliasesResponse = ListAliasesResponse' {
- truncated :: Maybe Bool
- aliases :: Maybe [AliasListEntry]
- nextMarker :: Maybe Text
- httpStatus :: Int
- newListAliasesResponse :: Int -> ListAliasesResponse
- listAliasesResponse_truncated :: Lens' ListAliasesResponse (Maybe Bool)
- listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [AliasListEntry])
- listAliasesResponse_nextMarker :: Lens' ListAliasesResponse (Maybe Text)
- listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int
Creating a Request
data ListAliases Source #
See: newListAliases smart constructor.
Constructors
| ListAliases' | |
Fields
| |
Instances
newListAliases :: ListAliases Source #
Create a value of ListAliases 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:keyId:ListAliases', listAliases_keyId - Lists only aliases that are associated with the specified KMS key. Enter
a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases returns all
aliases in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
$sel:marker:ListAliases', listAliases_marker - 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.
$sel:limit:ListAliases', listAliases_limit - Use this parameter to specify the maximum number of items to return.
When this value is present, 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.
Request Lenses
listAliases_keyId :: Lens' ListAliases (Maybe Text) Source #
Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases returns all
aliases in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
listAliases_marker :: 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.
listAliases_limit :: Lens' ListAliases (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, 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
data ListAliasesResponse Source #
See: newListAliasesResponse smart constructor.
Constructors
| ListAliasesResponse' | |
Fields
| |
Instances
newListAliasesResponse Source #
Arguments
| :: Int | |
| -> ListAliasesResponse |
Create a value of ListAliasesResponse 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:truncated:ListAliasesResponse', listAliasesResponse_truncated - 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 thisresponse to the
Marker parameter in a subsequent request.
$sel:aliases:ListAliasesResponse', listAliasesResponse_aliases - A list of aliases.
$sel:nextMarker:ListAliasesResponse', listAliasesResponse_nextMarker - When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
$sel:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.
Response Lenses
listAliasesResponse_truncated :: 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 thisresponse to the
Marker parameter in a subsequent request.
listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [AliasListEntry]) Source #
A list of aliases.
listAliasesResponse_nextMarker :: 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.
listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #
The response's http status code.