UpdateKeyDescription Method

Updates a CMK's description.

Syntax

amazonkms.updateKeyDescription(keyId, newDescription, [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 updates the description of the CMK specified by KeyId.

The value passed for the KeyId parameter must be the Id or ARN of a CMK in the current account and Region.

This method will fail if the specified CMK's state is aksPendingDeletion (2), or if it is AWS-managed (see KeyAWSManaged).