Update Key Description
kms_update_key_description | R Documentation |
Updates the description of a KMS key¶
Description¶
Updates the description of a KMS key. To see the description of a KMS
key, use describe_key
.
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
-
create_key
-
describe_key
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Usage¶
Arguments¶
KeyId
[required] 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
list_keys
ordescribe_key
.Description
[required] New description for the KMS key.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
Value¶
An empty list.