Learn R Programming

paws.security.identity (version 0.7.0)

kms_update_key_description: 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.

See https://www.paws-r-sdk.com/docs/kms_update_key_description/ for full documentation.

Usage

kms_update_key_description(KeyId, Description)

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 or describe_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.