Skip to content

/AWS1/IF_RDS=>DESCRSVRLSV2PLATFORMVERSIONS()

About DescribeServerlessV2PlatformVersions

Describes the properties of specific platform versions for Aurora Serverless v2.

Method Signature

METHODS /AWS1/IF_RDS~DESCRSVRLSV2PLATFORMVERSIONS
  IMPORTING
    !IV_SERVERLESSV2PLTFVERSION TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_ENGINE TYPE /AWS1/RDSSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST OPTIONAL
    !IV_DEFAULTONLY TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
    !IV_INCLUDEALL TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RDSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdssvrlsv2pltfvrsnmsg
  RAISING
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_serverlessv2pltfversion TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

A specific platform version to return details for.

Example: 3

iv_engine TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The database engine to return platform version details for.

Valid Values:

  • aurora-mysql

  • aurora-postgresql

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter isn't currently supported.

iv_defaultonly TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.

iv_includeall TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to also include platform versions which are no longer in use.

iv_maxrecords TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 20

Constraints: Minimum 1, maximum 200.

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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_rdssvrlsv2pltfvrsnmsg /AWS1/CL_RDSSVRLSV2PLTFVRSNMSG

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->descrsvrlsv2platformversions(
  it_filters = VALUE /aws1/cl_rdsfilter=>tt_filterlist(
    (
      new /aws1/cl_rdsfilter(
        it_values = VALUE /aws1/cl_rdsfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_rdsfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_defaultonly = ABAP_TRUE
  iv_engine = |string|
  iv_includeall = ABAP_TRUE
  iv_marker = |string|
  iv_maxrecords = 123
  iv_serverlessv2pltfversion = |string|
).

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_svrlsv2platformversions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_serverlessv2pltfversion( ).
      lv_string = lo_row_1->get_svrlsv2pltfversiondesc( ).
      lv_string = lo_row_1->get_engine( ).
      lo_serverlessv2featuressup = lo_row_1->get_serverlessv2featuressupp( ).
      IF lo_serverlessv2featuressup IS NOT INITIAL.
        lv_doubleoptional = lo_serverlessv2featuressup->get_mincapacity( ).
        lv_doubleoptional = lo_serverlessv2featuressup->get_maxcapacity( ).
      ENDIF.
      lv_string = lo_row_1->get_status( ).
      lv_boolean = lo_row_1->get_isdefault( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe the serverless platform versions for the Aurora MySQL DB engine

The following example displays details about each of the serverless platform versions for the specified DB engine.

DATA(lo_result) = lo_client->descrsvrlsv2platformversions( iv_engine = |aurora-mysql| ) .