DeleteSecret Method
Deletes a secret and all of its versions.
Syntax
amazonsecrets.deleteSecret(secretId, 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 deletes the secret specified by SecretId, and all of its versions, either immediately or after a waiting period depending on the value passed for DaysToWait.
The value passed for SecretId must the ARN or name of a secret in the current account and Region.
If 0 is passed for DaysToWait, the secret is deleted immediately. Otherwise, DaysToWait must be a value in the range 7 to 30 (inclusive), which will cause the secret to be scheduled for deletion. During the waiting period:
- The secret's data cannot be retrieved from any secret version.
- The deletion can be canceled by calling the CancelDeletion method.