GETPARAMETERS()`¶

About GetParameters¶

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost.

For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

Method Signature¶

METHODS /AWS1/IF_SSM~GETPARAMETERS
  IMPORTING
    !IT_NAMES TYPE /AWS1/CL_SSMPARAMNAMELIST_W=>TT_PARAMETERNAMELIST OPTIONAL
    !IV_WITHDECRYPTION TYPE /AWS1/SSMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetparamsresult
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDKEYID
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_names` `TYPE /AWS1/CL_SSMPARAMNAMELIST_W=>TT_PARAMETERNAMELIST` `TT_PARAMETERNAMELIST`¶

The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

The results for GetParameters requests are listed in alphabetical order in query responses.

For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Optional arguments:¶

`iv_withdecryption` `TYPE /AWS1/SSMBOOLEAN` `/AWS1/SSMBOOLEAN`¶

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmgetparamsresult` `/AWS1/CL_SSMGETPARAMSRESULT`¶

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->getparameters(
  it_names = VALUE /aws1/cl_ssmparamnamelist_w=>tt_parameternamelist(
    ( new /aws1/cl_ssmparamnamelist_w( |string| ) )
  )
  iv_withdecryption = ABAP_TRUE
).

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_parameters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_psparametername = lo_row_1->get_name( ).
      lv_parametertype = lo_row_1->get_type( ).
      lv_psparametervalue = lo_row_1->get_value( ).
      lv_psparameterversion = lo_row_1->get_version( ).
      lv_psparameterselector = lo_row_1->get_selector( ).
      lv_string = lo_row_1->get_sourceresult( ).
      lv_datetime = lo_row_1->get_lastmodifieddate( ).
      lv_string = lo_row_1->get_arn( ).
      lv_parameterdatatype = lo_row_1->get_datatype( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_invalidparameters( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_psparametername = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_SSM=>GETPARAMETERS()¶