Cloud Keys 2020 Node.js Edition

Questions / Feedback?

ScheduleKeyDeletion Method

Schedules the deletion of a CMK.

Syntax

amazonkms.scheduleKeyDeletion(keyId, daysToWait, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method schedules the deletion of the CMK specified by KeyId. The DaysToWait parameter specifies the length of the waiting period; it must be a value between 7 and 30.

When a CMK is scheduled for deletion, it cannot be used. This is a safety feature designed to help identify any code that still relies on the CMK.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]