paws.security.identity (version 0.1.12)

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 description of a CMK, use describe_key.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:UpdateKeyDescription (key policy)

Related operations

• create_key

• describe_key

Usage

kms_update_key_description(KeyId, Description)

Value

An empty list.

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 list_keys or describe_key.

Description

[required] New description for the CMK.

Request syntax

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

Examples

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