kms_delete_alias: Deletes the specified alias

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Usage

1
kms_delete_alias(AliasName)

Arguments

AliasName

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

Details

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 DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

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

Request syntax

1
2
3
svc$delete_alias(
  AliasName = "string"
)

Examples

1
2
3
4
# The following example deletes the specified alias.
svc$delete_alias(
  AliasName = "alias/ExampleAlias"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.