Skip to content

KMS  >  Operations  >  update_key_description

update_key_description

Operation

update_key_description async 

update_key_description(input: UpdateKeyDescriptionInput, plugins: list[Plugin] | None = None) -> UpdateKeyDescriptionOutput

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

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:UpdateKeyDescription (key policy)

Related operations

  • CreateKey

  • DescribeKey

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

Parameters:

Name Type Description Default
input UpdateKeyDescriptionInput

An instance of UpdateKeyDescriptionInput.

 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
UpdateKeyDescriptionOutput

An instance of UpdateKeyDescriptionOutput.

Input

UpdateKeyDescriptionInput dataclass

Bases: _SerdeShape

Dataclass for UpdateKeyDescriptionInput structure.

Attributes

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

New description for the KMS key.

Warning

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Output

UpdateKeyDescriptionOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateKeyDescriptionOutput 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.