Skip to content

/AWS1/IF_DOD=>DESCRORDERABLEDBINSTOPTIONS()

About DescribeOrderableDBInstanceOptions

Returns a list of orderable instance options for the specified engine.

Method Signature

METHODS /AWS1/IF_DOD~DESCRORDERABLEDBINSTOPTIONS
  IMPORTING
    !IV_ENGINE TYPE /AWS1/DODSTRING OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/DODSTRING OPTIONAL
    !IV_DBINSTANCECLASS TYPE /AWS1/DODSTRING OPTIONAL
    !IV_LICENSEMODEL TYPE /AWS1/DODSTRING OPTIONAL
    !IV_VPC TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DODINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DODSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodorderabledbinsto00
  RAISING
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_engine TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The name of the engine to retrieve instance options for.

Optional arguments:

iv_engineversion TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

iv_dbinstanceclass TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

iv_licensemodel TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

iv_vpc TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

it_filters TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter is not currently supported.

iv_maxrecords TYPE /AWS1/DODINTEGEROPTIONAL /AWS1/DODINTEGEROPTIONAL

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

Default: 100

Constraints: Minimum 20, maximum 100.

iv_marker TYPE /AWS1/DODSTRING /AWS1/DODSTRING

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

RETURNING

oo_output TYPE REF TO /aws1/cl_dodorderabledbinsto00 /AWS1/CL_DODORDERABLEDBINSTO00

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->descrorderabledbinstoptions(
  it_filters = VALUE /aws1/cl_dodfilter=>tt_filterlist(
    (
      new /aws1/cl_dodfilter(
        it_values = VALUE /aws1/cl_dodfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dodfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbinstanceclass = |string|
  iv_engine = |string|
  iv_engineversion = |string|
  iv_licensemodel = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_vpc = ABAP_TRUE
).

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_orderabledbinstoptions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_string = lo_row_1->get_dbinstanceclass( ).
      lv_string = lo_row_1->get_licensemodel( ).
      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( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_vpc( ).
      lv_string = lo_row_1->get_storagetype( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.