DESCRIBECLUSTERPARAMETERS()`¶

About DescribeClusterParameters¶

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Method Signature¶

METHODS /AWS1/IF_RSH~DESCRIBECLUSTERPARAMETERS
  IMPORTING
    !IV_PARAMETERGROUPNAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_SOURCE TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshclustparamgrpdets
  RAISING
    /AWS1/CX_RSHCLSTPRMGRNOTFNDF00
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_parametergroupname` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The name of a cluster parameter group for which to return details.

Optional arguments:¶

`iv_source` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

`iv_maxrecords` `TYPE /AWS1/RSHINTEGEROPTIONAL` `/AWS1/RSHINTEGEROPTIONAL`¶

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

`iv_marker` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rshclustparamgrpdets` `/AWS1/CL_RSHCLUSTPARAMGRPDETS`¶

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->describeclusterparameters(
  iv_marker = |string|
  iv_maxrecords = 123
  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.
  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_string = lo_row_1->get_parametervalue( ).
      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_parameterapplytype = lo_row_1->get_applytype( ).
      lv_boolean = lo_row_1->get_ismodifiable( ).
      lv_string = lo_row_1->get_minimumengineversion( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.

/AWS1/IF_RSH=>DESCRIBECLUSTERPARAMETERS()¶