Skip to content

/AWS1/CL_RSH=>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

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