paws.security.identity (version 0.1.0)

kms_update_key_description: Updates the description of a customer master key (CMK)

Description

Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.

Usage

kms_update_key_description(KeyId, Description)

Arguments

KeyId

[required] A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Description

[required] New description for the CMK.

Request syntax

svc$update_key_description(
  KeyId = "string",
  Description = "string"
)

Details

You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples

# NOT RUN {
# The following example updates the description of the specified CMK.
# }
# NOT RUN {
svc$update_key_description(
  Description = "Example description that indicates the intended use of this CMK.",
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
# }
# NOT RUN {
# }