Skip to content

/AWS1/CL_DAX=>DESCRIBEPARAMETERS()

About DescribeParameters

Returns the detailed parameter list for a particular parameter group.

Method Signature

IMPORTING

Required arguments:

iv_parametergroupname TYPE /AWS1/DAXSTRING /AWS1/DAXSTRING

The name of the parameter group.

Optional arguments:

iv_source TYPE /AWS1/DAXSTRING /AWS1/DAXSTRING

How the parameter is defined. For example, system denotes a system-defined parameter.

iv_maxresults TYPE /AWS1/DAXINTEGEROPTIONAL /AWS1/DAXINTEGEROPTIONAL

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

iv_nexttoken TYPE /AWS1/DAXSTRING /AWS1/DAXSTRING

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

RETURNING

oo_output TYPE REF TO /aws1/cl_daxdescrparamsrsp /AWS1/CL_DAXDESCRPARAMSRSP

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->/aws1/if_dax~describeparameters(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_parametergroupname = |string|
  iv_source = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_parameters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_parametername( ).
      lv_parametertype = lo_row_1->get_parametertype( ).
      lv_string = lo_row_1->get_parametervalue( ).
      LOOP AT lo_row_1->get_nodetypespecificvalues( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_nodetype( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_source( ).
      lv_string = lo_row_1->get_datatype( ).
      lv_string = lo_row_1->get_allowedvalues( ).
      lv_ismodifiable = lo_row_1->get_ismodifiable( ).
      lv_changetype = lo_row_1->get_changetype( ).
    ENDIF.
  ENDLOOP.
ENDIF.