BATCHGETSECRETVALUE()`¶

About BatchGetSecretValue¶

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.

Method Signature¶

METHODS /AWS1/IF_SMR~BATCHGETSECRETVALUE
  IMPORTING
    !IT_SECRETIDLIST TYPE /AWS1/CL_SMRSECRETIDLISTTYPE_W=>TT_SECRETIDLISTTYPE OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_SMRFILTER=>TT_FILTERSLISTTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SMRMAXRESULTSBATCHTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SMRNEXTTOKENTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smrbtcgetsecretvalrsp
  RAISING
    /AWS1/CX_SMRDECRYPTIONFAILURE
    /AWS1/CX_SMRINTERNALSVCERROR
    /AWS1/CX_SMRINVALIDNEXTTOKENEX
    /AWS1/CX_SMRINVALIDPARAMETEREX
    /AWS1/CX_SMRINVALIDREQUESTEX
    /AWS1/CX_SMRRESOURCENOTFOUNDEX
    /AWS1/CX_SMRCLIENTEXC
    /AWS1/CX_SMRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_secretidlist` `TYPE /AWS1/CL_SMRSECRETIDLISTTYPE_W=>TT_SECRETIDLISTTYPE` `TT_SECRETIDLISTTYPE`¶

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

`it_filters` `TYPE /AWS1/CL_SMRFILTER=>TT_FILTERSLISTTYPE` `TT_FILTERSLISTTYPE`¶

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

`iv_maxresults` `TYPE /AWS1/SMRMAXRESULTSBATCHTYPE` `/AWS1/SMRMAXRESULTSBATCHTYPE`¶

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

`iv_nexttoken` `TYPE /AWS1/SMRNEXTTOKENTYPE` `/AWS1/SMRNEXTTOKENTYPE`¶

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 BatchGetSecretValue again with this value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_smrbtcgetsecretvalrsp` `/AWS1/CL_SMRBTCGETSECRETVALRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->batchgetsecretvalue(
  it_filters = VALUE /aws1/cl_smrfilter=>tt_filterslisttype(
    (
      new /aws1/cl_smrfilter(
        it_values = VALUE /aws1/cl_smrfiltvalsstrlist_w=>tt_filtervaluesstringlist(
          ( new /aws1/cl_smrfiltvalsstrlist_w( |string| ) )
        )
        iv_key = |string|
      )
    )
  )
  it_secretidlist = VALUE /aws1/cl_smrsecretidlisttype_w=>tt_secretidlisttype(
    ( new /aws1/cl_smrsecretidlisttype_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_secretvalues( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_secretarntype = lo_row_1->get_arn( ).
      lv_secretnametype = lo_row_1->get_name( ).
      lv_secretversionidtype = lo_row_1->get_versionid( ).
      lv_secretbinarytype = lo_row_1->get_secretbinary( ).
      lv_secretstringtype = lo_row_1->get_secretstring( ).
      LOOP AT lo_row_1->get_versionstages( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_secretversionstagetype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_createddatetype = lo_row_1->get_createddate( ).
    ENDIF.
  ENDLOOP.
  lv_nexttokentype = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_errors( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_secretidtype = lo_row_5->get_secretid( ).
      lv_errorcode = lo_row_5->get_errorcode( ).
      lv_errormessage = lo_row_5->get_message( ).
    ENDIF.
  ENDLOOP.
ENDIF.

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

The following example gets the values for three secrets.

DATA(lo_result) = lo_client->batchgetsecretvalue(
  it_secretidlist = VALUE /aws1/cl_smrsecretidlisttype_w=>tt_secretidlisttype(
    ( new /aws1/cl_smrsecretidlisttype_w( |MySecret1| ) )
    ( new /aws1/cl_smrsecretidlisttype_w( |MySecret2| ) )
    ( new /aws1/cl_smrsecretidlisttype_w( |MySecret3| ) )
  )
).

/AWS1/IF_SMR=>BATCHGETSECRETVALUE()¶