/AWS1/IF_SSM=>GETPARAMETERSBYPATH()

About GetParametersByPath

Retrieve information about one or more parameters under a specified level in a hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

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.

Method Signature

METHODS /AWS1/IF_SSM~GETPARAMETERSBYPATH
  IMPORTING
    !IV_PATH TYPE /AWS1/SSMPSPARAMETERNAME OPTIONAL
    !IV_RECURSIVE TYPE /AWS1/SSMBOOLEAN OPTIONAL
    !IT_PARAMETERFILTERS TYPE /AWS1/CL_SSMPARAMSTRINGFILTER=>TT_PARAMETERSTRINGFILTERLIST OPTIONAL
    !IV_WITHDECRYPTION TYPE /AWS1/SSMBOOLEAN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SSMGETPARMSBYPATHMAXRSS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SSMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetparmsbypathrs
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDFILTERKEY
    /AWS1/CX_SSMINVFILTEROPTION
    /AWS1/CX_SSMINVALIDFILTERVALUE
    /AWS1/CX_SSMINVALIDKEYID
    /AWS1/CX_SSMINVALIDNEXTTOKEN
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_path TYPE /AWS1/SSMPSPARAMETERNAME /AWS1/SSMPSPARAMETERNAME

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Optional arguments:

iv_recursive TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

it_parameterfilters TYPE /AWS1/CL_SSMPARAMSTRINGFILTER=>TT_PARAMETERSTRINGFILTERLIST TT_PARAMETERSTRINGFILTERLIST

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

iv_withdecryption TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

Retrieve all parameters in a hierarchy with their value decrypted.

iv_maxresults TYPE /AWS1/SSMGETPARMSBYPATHMAXRSS /AWS1/SSMGETPARMSBYPATHMAXRSS

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

iv_nexttoken TYPE /AWS1/SSMNEXTTOKEN /AWS1/SSMNEXTTOKEN

A token to start the list. Use this token to get the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmgetparmsbypathrs /AWS1/CL_SSMGETPARMSBYPATHRS

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->getparametersbypath(
  it_parameterfilters = VALUE /aws1/cl_ssmparamstringfilter=>tt_parameterstringfilterlist(
    (
      new /aws1/cl_ssmparamstringfilter(
        it_values = VALUE /aws1/cl_ssmprmstrfiltvallst_w=>tt_paramstringfiltervaluelist(
          ( new /aws1/cl_ssmprmstrfiltvallst_w( |string| ) )
        )
        iv_key = |string|
        iv_option = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_path = |string|
  iv_recursive = ABAP_TRUE
  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.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.