Skip to content

/AWS1/CL_KMS=>UPDATEKEYDESCRIPTION()

About UpdateKeyDescription

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

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

Method Signature

IMPORTING

Required arguments:

iv_keyid TYPE /AWS1/KMSKEYIDTYPE /AWS1/KMSKEYIDTYPE

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.

iv_description TYPE /AWS1/KMSDESCRIPTIONTYPE /AWS1/KMSDESCRIPTIONTYPE

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.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->/aws1/if_kms~updatekeydescription(
  iv_description = |string|
  iv_keyid = |string|
).

To update the description of a KMS key

The following example updates the description of the specified KMS key.

lo_client->/aws1/if_kms~updatekeydescription(
  iv_description = |Example description that indicates the intended use of this KMS key.|
  iv_keyid = |1234abcd-12ab-34cd-56ef-1234567890ab|
).