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.

BatchGetSecretValueCommand

Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.

Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request 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:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. 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, BatchGetSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
// const { SecretsManagerClient, BatchGetSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
const client = new SecretsManagerClient(config);
const input = { // BatchGetSecretValueRequest
  SecretIdList: [ // SecretIdListType
    "STRING_VALUE",
  ],
  Filters: [ // FiltersListType
    { // Filter
      Key: "description" || "name" || "tag-key" || "tag-value" || "primary-region" || "owning-service" || "all",
      Values: [ // FilterValuesStringList
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new BatchGetSecretValueCommand(input);
const response = await client.send(command);
// { // BatchGetSecretValueResponse
//   SecretValues: [ // SecretValuesType
//     { // SecretValueEntry
//       ARN: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       VersionId: "STRING_VALUE",
//       SecretBinary: new Uint8Array(),
//       SecretString: "STRING_VALUE",
//       VersionStages: [ // SecretVersionStagesType
//         "STRING_VALUE",
//       ],
//       CreatedDate: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   Errors: [ // APIErrorListType
//     { // APIErrorType
//       SecretId: "STRING_VALUE",
//       ErrorCode: "STRING_VALUE",
//       Message: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editor