There are more AWS SDK examples available in the AWS Doc SDK Examples
Use UpdateAlias
with an AWS SDK or CLI
The following code examples show how to use UpdateAlias
.
- CLI
-
- AWS CLI
-
To associate an alias with a different KMS key
The following
update-alias
example associates the aliasalias/test-key
with a different KMS key.The
--alias-name
parameter specifies the alias. The alias name value must begin withalias/
.The--target-key-id
parameter specifies the KMS key to associate with the alias. You don't need to specify the current KMS key for the alias.aws kms update-alias \ --alias-name alias/test-key \ --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab
This command produces no output. To find the alias, use the
list-aliases
command.For more information, see Updating aliases in the AWS Key Management Service Developer Guide.
-
For API details, see UpdateAlias
in AWS CLI Command Reference.
-
- Python
-
- SDK for Python (Boto3)
-
Note
There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository
. class AliasManager: def __init__(self, kms_client): self.kms_client = kms_client self.created_key = None @classmethod def from_client(cls) -> "AliasManager": """ Creates an AliasManager instance with a default KMS client. :return: An instance of AliasManager initialized with the default KMS client. """ kms_client = boto3.client("kms") return cls(kms_client) def update_alias(self, alias, current_key_id): """ Updates an alias by assigning it to another key. :param alias: The alias to reassign. :param current_key_id: The ARN or ID of the key currently associated with the alias. """ new_key_id = input( f"Alias {alias} is currently associated with {current_key_id}. " f"Enter another key ID or ARN that you want to associate with {alias}: " ) if new_key_id != "": try: self.kms_client.update_alias(AliasName=alias, TargetKeyId=new_key_id) except ClientError as err: logger.error( "Couldn't associate alias %s with key %s. Here's why: %s", alias, new_key_id, err.response["Error"]["Message"], ) else: print(f"Alias {alias} is now associated with key {new_key_id}.") else: print("Skipping alias update.")
-
For API details, see UpdateAlias in AWS SDK for Python (Boto3) API Reference.
-