ListVersions Method

List the secret versions for the specified secret.

Syntax

amazonsecrets.listVersions(secretId, [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 lists the secret versions for the secret specified by SecretId. Note that by default, only non-deprecated versions are returned (i.e., those with at least one staging label attached to them); the IncludeDeprecated configuration setting can be used to control this behavior.

Calling this method will fire the VersionList event once for each secret version, and will also populate the Version* properties.

If there are still more secret versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Version* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.