DESCRIBECLUSTERVERSIONS()`¶

About DescribeClusterVersions¶

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Method Signature¶

METHODS /AWS1/IF_RSH~DESCRIBECLUSTERVERSIONS
  IMPORTING
    !IV_CLUSTERVERSION TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_CLUSTERPARAMGROUPFAMILY 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_rshclustvrssmessage
  RAISING
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_clusterversion` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The specific cluster version to return.

Example: 1.0

`iv_clusterparamgroupfamily` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

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

Constraints:

Must be 1 to 255 alphanumeric characters

First character must be a letter

Cannot end with a hyphen or contain two consecutive hyphens

`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 DescribeClusterVersions 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_rshclustvrssmessage` `/AWS1/CL_RSHCLUSTVRSSMESSAGE`¶

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->describeclusterversions(
  iv_clusterparamgroupfamily = |string|
  iv_clusterversion = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

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_marker( ).
  LOOP AT lo_result->get_clusterversions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clusterversion( ).
      lv_string = lo_row_1->get_clusterparamgroupfamily( ).
      lv_string = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_RSH=>DESCRIBECLUSTERVERSIONS()¶