DESCRORDERABLECLUSTEROPTIONS()`¶

About DescribeOrderableClusterOptions¶

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Method Signature¶

METHODS /AWS1/IF_RSH~DESCRORDERABLECLUSTEROPTIONS
  IMPORTING
    !IV_CLUSTERVERSION TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_NODETYPE 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_rshorderableclstopt00
  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 version filter value. Specify this parameter to show only the available offerings matching the specified version.

Default: All versions.

Constraints: Must be one of the version returned from DescribeClusterVersions.

`iv_nodetype` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

`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 DescribeOrderableClusterOptions 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_rshorderableclstopt00` `/AWS1/CL_RSHORDERABLECLSTOPT00`¶

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->descrorderableclusteroptions(
  iv_clusterversion = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_nodetype = |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_orderableclusteroptions( ) 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_clustertype( ).
      lv_string = lo_row_1->get_nodetype( ).
      LOOP AT lo_row_1->get_availabilityzones( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_name( ).
          LOOP AT lo_row_3->get_supportedplatforms( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_name( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.

/AWS1/IF_RSH=>DESCRORDERABLECLUSTEROPTIONS()¶