paws.security.identity (version 0.1.12)

kms_list_aliases: Gets a list of aliases in the caller's AWS account and region

Description

Gets a list of aliases in the caller's AWS account and region. For more information about aliases, see create_alias.

By default, the list_aliases operation returns all aliases in the account and region. To get only the aliases associated with a particular customer master key (CMK), use the KeyId parameter.

The list_aliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS 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 AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.

Cross-account use: No. list_aliases does not return aliases in other AWS accounts.

Required permissions: kms:ListAliases (IAM policy)

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

Related operations:

• create_alias

• delete_alias

• update_alias

Usage

kms_list_aliases(KeyId, Limit, Marker)

Value

A list with the following syntax:

list(
  Aliases = list(
    list(
      AliasName = "string",
      AliasArn = "string",
      TargetKeyId = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextMarker = "string",
  Truncated = TRUE|FALSE
)

Arguments

KeyId

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.

This parameter is optional. If you omit it, list_aliases returns all aliases in the account and Region.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use list_keys or describe_key.

Limit

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.

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.

Request syntax

svc$list_aliases(
  KeyId = "string",
  Limit = 123,
  Marker = "string"
)

Examples

if (FALSE) {
# The following example lists aliases.
svc$list_aliases()
}