GetSecret Method

Retrieves a secret version's data.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetSecret(const char* lpszSecretId, const char* lpszVersionId, const char* lpszStagingLabel);

Unicode (Windows)
INT GetSecret(LPCWSTR lpszSecretId, LPCWSTR lpszVersionId, LPCWSTR lpszStagingLabel);

- (void)getSecret:(NSString*)secretId :(NSString*)versionId :(NSString*)stagingLabel;

#define MID_AMAZONSECRETS_GETSECRET 10

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

Remarks

This method retrieves the secret data held by a version of the secret specified by SecretId. The exact version whose data should be retrieved is specified by either VersionId or StagingLabel (if both are specified, the latter is ignored). If neither are specified, the data from the secret version with the AWSCURRENT staging label is retrieved.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The secret data is returned via the output stream supplied via the SetOutputStream method, the specified LocalFile, or the SecretData or SecretString property.

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.)