Cloud Keys 2020 Node.js Edition

Questions / Feedback?

GetSecret Method

Retrieves a secret version's data.


amazonsecrets.getSecret(secretId, versionId, stagingLabel, [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:



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 specified LocalFile or the SecretData or SecretString property.

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