Batch Get Secret Value

secretsmanager_batch_get_secret_value

R Documentation

Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets

Description

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

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 get_secret_value 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.

Usage

secretsmanager_batch_get_secret_value(SecretIdList, Filters, MaxResults,
  NextToken)

Arguments

SecretIdList

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Filters

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

MaxResults

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call batch_get_secret_value again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

NextToken

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call batch_get_secret_value again with this value.

Value

A list with the following syntax:

list(
  SecretValues = list(
    list(
      ARN = "string",
      Name = "string",
      VersionId = "string",
      SecretBinary = raw,
      SecretString = "string",
      VersionStages = list(
        "string"
      ),
      CreatedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string",
  Errors = list(
    list(
      SecretId = "string",
      ErrorCode = "string",
      Message = "string"
    )
  )
)

Request syntax

svc$batch_get_secret_value(
  SecretIdList = list(
    "string"
  ),
  Filters = list(
    list(
      Key = "description"|"name"|"tag-key"|"tag-value"|"primary-region"|"owning-service"|"all",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)

Examples

## Not run: 
# The following example gets the values for three secrets.
svc$batch_get_secret_value(
  SecretIdList = list(
    "MySecret1",
    "MySecret2",
    "MySecret3"
  )
)

## End(Not run)