DeleteAliasCommand

Use a bare-bones client and the command you need to make an API call.

DeleteAliasCommandInput

[DeleteAliasCommandInput](@aws-sdk/client-kms!DeleteAliasCommandInput:Interface)

Deletes the specified alias. <note> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the Key Management Service Developer Guide. </note> 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 <ul> <li> <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the alias (IAM policy). </li> <li> <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the KMS key (key policy). </li> </ul> For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the Key Management Service Developer Guide. Related operations: <ul> <li> CreateAlias </li> <li> ListAliases </li> <li> UpdateAlias </li> </ul> Eventual consistency: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.

AliasName

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

The input for [DeleteAliasCommand](@aws-sdk/client-kms!DeleteAliasCommand:Class).

$metadata

DeleteAliasCommandOutput

The output of [DeleteAliasCommand](@aws-sdk/client-kms!DeleteAliasCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

name

DependencyTimeoutException

The system timed out while trying to fulfill the request. You can retry the request.

KMSInternalException

The request was rejected because an internal exception occurred. The request can be retried.

KMSInvalidStateException

The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following: <ul> <li> The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the Key Management Service Developer Guide . </li> <li> For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception. </li> </ul>

NotFoundException

The request was rejected because the specified entity or resource could not be found.

KMSServiceException

Base exception class for all service exceptions from KMS service.