paws.security.identity (version 0.1.12)

kms_delete_alias: Deletes the specified alias

Description

Deletes the specified alias.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the describe_key operation. To get the aliases of all CMKs, use the list_aliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use delete_alias to delete the current alias and create_alias to create a new alias. To associate an existing alias with a different customer master key (CMK), call update_alias.

Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

Required permissions

• kms:DeleteAlias on the alias (IAM policy).

• kms:DeleteAlias on the CMK (key policy).

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

Related operations:

• create_alias

• list_aliases

• update_alias

Usage

kms_delete_alias(AliasName)

Value

An empty list.

Arguments

AliasName

[required] The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

Request syntax

svc$delete_alias(
  AliasName = "string"
)

Examples

if (FALSE) {
# The following example deletes the specified alias.
svc$delete_alias(
  AliasName = "alias/ExampleAlias"
)
}