Skip to main content

Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

GetSecretValueCommand

Suggest an Edit

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

To retrieve the values for a group of secrets, call BatchGetSecretValue.

We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications .

To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage .

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail .

Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SecretsManagerClient, GetSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
// const { SecretsManagerClient, GetSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
const client = new SecretsManagerClient(config);
const input = { // GetSecretValueRequest
  SecretId: "STRING_VALUE", // required
  VersionId: "STRING_VALUE",
  VersionStage: "STRING_VALUE",
};
const command = new GetSecretValueCommand(input);
const response = await client.send(command);
// { // GetSecretValueResponse
//   ARN: "STRING_VALUE",
//   Name: "STRING_VALUE",
//   VersionId: "STRING_VALUE",
//   SecretBinary: new Uint8Array(),
//   SecretString: "STRING_VALUE",
//   VersionStages: [ // SecretVersionStagesType
//     "STRING_VALUE",
//   ],
//   CreatedDate: new Date("TIMESTAMP"),
// };

Example Usage

There was an error loading the code editor. Retry

GetSecretValueCommand Input

See GetSecretValueCommandInput for more details

Parameter	Type	Description
`SecretId` Required	`string \| undefined`	The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN .
`VersionId`	`string \| undefined`	The unique identifier of the version of the secret to retrieve. If you include both this parameter and `VersionStage`, the two parameters must refer to the same secret version. If you don't specify either a `VersionStage` or `VersionId`, then Secrets Manager returns the `AWSCURRENT` version. This value is typically a UUID-type value with 32 hexadecimal digits.
`VersionStage`	`string \| undefined`	The staging label of the version of the secret to retrieve. Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and `VersionId`, the two parameters must refer to the same secret version. If you don't specify either a `VersionStage` or `VersionId`, Secrets Manager returns the `AWSCURRENT` version.

GetSecretValueCommand Output

See GetSecretValueCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ARN`	`string \| undefined`	The ARN of the secret.
`CreatedDate`	`Date \| undefined`	The date and time that this version of the secret was created. If you don't specify which version in `VersionId` or `VersionStage`, then Secrets Manager uses the `AWSCURRENT` version.
`Name`	`string \| undefined`	The friendly name of the secret.
`SecretBinary`	`Uint8Array \| undefined`	The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a `SecretBinary` using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded. If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in `SecretString` instead. Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
`SecretString`	`string \| undefined`	The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console. If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs. Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
`VersionId`	`string \| undefined`	The unique identifier of this version of the secret.
`VersionStages`	`string[] \| undefined`	A list of all of the staging labels currently attached to this version of the secret.

Throws

Name	Fault	Details
DecryptionFailure	client	Secrets Manager can't decrypt the protected secret text using the provided KMS key.
InternalServiceError	server	An error occurred on the server side.
InvalidParameterException	client	The parameter name or value is invalid.
InvalidRequestException	client	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services .
ResourceNotFoundException	client	Secrets Manager can't find the resource that you asked for.
SecretsManagerServiceException		Base exception class for all service exceptions from SecretsManager service.