Skip to content

KMS  >  Operations  >  delete_alias

delete_alias

Operation

delete_alias async 

delete_alias(input: DeleteAliasInput, plugins: list[Plugin] | None = None) -> DeleteAliasOutput

Deletes the specified alias.

Note

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

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

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

Required permissions

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

Related operations:

  • CreateAlias

  • ListAliases

  • UpdateAlias

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Parameters:

Name Type Description Default
input DeleteAliasInput

An instance of DeleteAliasInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteAliasOutput

An instance of DeleteAliasOutput.

Input

DeleteAliasInput dataclass

Bases: _SerdeShape

Dataclass for DeleteAliasInput structure.

Attributes

alias_name class-attribute instance-attribute 
alias_name: str | None = ...

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

Output

DeleteAliasOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteAliasOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.