AmazonSecretsManagerClient.BatchGetSecretValue Method (BatchGetSecretValueRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to BatchGetSecretValueAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual BatchGetSecretValueResponse BatchGetSecretValue(
         BatchGetSecretValueRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.BatchGetSecretValueRequest

Container for the necessary parameters to execute the BatchGetSecretValue service method.

Return Value

Type: BatchGetSecretValueResponse

The response from the BatchGetSecretValue service method, as returned by SecretsManager.

Exceptions

Exception	Condition
DecryptionFailureException	Secrets Manager can't decrypt the protected secret text using the provided KMS key.
InternalServiceErrorException	An error occurred on the server side.
InvalidNextTokenException	The NextToken value is invalid.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	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	Secrets Manager can't find the resource that you asked for.

Examples

The following example gets the values for three secrets.

To retrieve the secret values for a group of secrets listed by name


var client = new AmazonSecretsManagerClient();
var response = client.BatchGetSecretValue(new BatchGetSecretValueRequest 
{
    SecretIdList = new List<string> {
        "MySecret1",
        "MySecret2",
        "MySecret3"
    }
});

List<APIErrorType> errors = response.Errors;
List<SecretValueEntry> secretValues = response.SecretValues;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonSecretsManagerClient.BatchGetSecretValue (BatchGetSecretValueRequest)

Method