CANCELKEYDELETION()`¶

About CancelKeyDeletion¶

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey.

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide.

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:CancelKeyDeletion (key policy)

Related operations: ScheduleKeyDeletion

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`¶

Identifies the KMS key whose deletion is being canceled.

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kmscanckeydeletionrsp` `/AWS1/CL_KMSCANCKEYDELETIONRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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.

DATA(lo_result) = lo_client->/aws1/if_kms~cancelkeydeletion( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_keyidtype = lo_result->get_keyid( ).
ENDIF.

To cancel deletion of a KMS key¶

The following example cancels deletion of the specified KMS key.

DATA(lo_result) = lo_client->/aws1/if_kms~cancelkeydeletion( |1234abcd-12ab-34cd-56ef-1234567890ab| ).

/AWS1/CL_KMS=>CANCELKEYDELETION()¶