DeleteSecret Method

Deletes a secret and all of its versions.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int DeleteSecret(const char* lpszSecretId, int iDaysToWait);

Unicode (Windows)
INT DeleteSecret(LPCWSTR lpszSecretId, INT iDaysToWait);

- (void)deleteSecret:(NSString*)secretId :(int)daysToWait;

#define MID_AMAZONSECRETS_DELETESECRET 7

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonSecrets_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)