Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . kms ]

delete-alias

Description

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

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 .

See also: AWS API Documentation

Synopsis

  delete-alias
--alias-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--alias-name (string)

The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

None