Smaws_Client_KMS.ListAliasesval request :
Smaws_Lib.Context.t ->
list_aliases_request ->
(list_aliases_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `DependencyTimeoutException of dependency_timeout_exception
| `InvalidArnException of invalid_arn_exception
| `InvalidMarkerException of invalid_marker_exception
| `KMSInternalException of kms_internal_exception
| `NotFoundException of not_found_exception ])
Stdlib.resultGets 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/, 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:
CreateAliasDeleteAliasUpdateAliasEventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.