Associates an existing KMS alias with a different KMS key. Each alias is associated with
only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
KMS key must be in the same Amazon Web Services account and Region.
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.
The current and new KMS key must be the same type (both symmetric or both asymmetric or
both HMAC), and they must have the same key usage. This restriction prevents errors in code
that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create
a new alias.
You cannot use UpdateAlias to change an alias name. To change an alias name,
use DeleteAlias to delete the old alias and CreateAlias to
create a new alias.
Because an alias is not a property of a KMS key, you can create, update, and delete 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
in the account, use the ListAliases operation.
The KMS key that you use for this operation must be in a compatible key state. For
details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.
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.
The current and new KMS key must be the same type (both symmetric or both asymmetric or both HMAC), and they must have the same key usage. This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.
You cannot use
UpdateAliasto change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.Because an alias is not a property of a KMS key, you can create, update, and delete 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 in the account, use the ListAliases operation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions
kms:UpdateAlias on the alias (IAM policy).
kms:UpdateAlias on the current KMS key (key policy).
kms:UpdateAlias on the new KMS key (key policy).
For details, see Controlling access to aliases in the Key Management Service Developer Guide.
Related operations:
CreateAlias
DeleteAlias
ListAliases
Use a bare-bones client and the command you need to make an API call.
import { KMSClient, UpdateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import // const { KMSClient, UpdateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import const client = new KMSClient(config); const command = new UpdateAliasCommand(input); const response = await client.send(command);UpdateAliasCommandInput for command's
inputshape.UpdateAliasCommandOutput for command's
responseshape.config for KMSClient's
configshape.