Skip to content

/AWS1/CL_RDS=>DESCRIBEDBENGINEVERSIONS()

About DescribeDBEngineVersions

Describes the properties of specific versions of DB engines.

Method Signature

IMPORTING

Optional arguments:

iv_engine TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The database engine to return version details for.

Valid Values:

  • aurora-mysql

  • aurora-postgresql

  • custom-oracle-ee

  • custom-oracle-ee-cdb

  • custom-oracle-se2

  • custom-oracle-se2-cdb

  • db2-ae

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

iv_engineversion TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

A specific database engine version to return details for.

Example: 5.1.49

iv_dbparametergroupfamily TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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

Constraints:

  • If supplied, must match an existing DB parameter group family.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more DB engine versions to describe.

Supported filters:

  • db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

  • engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

  • engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

    • global

    • multimaster

    • parallelquery

    • provisioned

    • serverless

  • engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

  • status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

    • available

    • deprecated

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: 100

Constraints: Minimum 20, maximum 100.

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.

iv_defaultonly TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

iv_listsuppedcharactersets TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.

iv_listsupportedtimezones TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.

iv_includeall TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdbenginevrsmessage /AWS1/CL_RDSDBENGINEVRSMESSAGE

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->/aws1/if_rds~describedbengineversions(
  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_dbparametergroupfamily = |string|
  iv_defaultonly = ABAP_TRUE
  iv_engine = |string|
  iv_engineversion = |string|
  iv_includeall = ABAP_TRUE
  iv_listsuppedcharactersets = ABAP_TRUE
  iv_listsupportedtimezones = ABAP_TRUE
  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_dbengineversions( ) 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_dbparametergroupfamily( ).
      lv_string = lo_row_1->get_dbenginedescription( ).
      lv_string = lo_row_1->get_dbengineversiondesc( ).
      lo_characterset = lo_row_1->get_defaultcharacterset( ).
      IF lo_characterset IS NOT INITIAL.
        lv_string = lo_characterset->get_charactersetname( ).
        lv_string = lo_characterset->get_charactersetdescription( ).
      ENDIF.
      lo_customdbengineversionam = lo_row_1->get_image( ).
      IF lo_customdbengineversionam IS NOT INITIAL.
        lv_string = lo_customdbengineversionam->get_imageid( ).
        lv_string = lo_customdbengineversionam->get_status( ).
      ENDIF.
      lv_string = lo_row_1->get_dbenginemediatype( ).
      LOOP AT lo_row_1->get_supportedcharactersets( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_charactersetname( ).
          lv_string = lo_row_3->get_charactersetdescription( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_suppedncharcharactersets( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_charactersetname( ).
          lv_string = lo_row_3->get_charactersetdescription( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_validupgradetarget( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_engine( ).
          lv_string = lo_row_5->get_engineversion( ).
          lv_string = lo_row_5->get_description( ).
          lv_boolean = lo_row_5->get_autoupgrade( ).
          lv_boolean = lo_row_5->get_ismajorversionupgrade( ).
          LOOP AT lo_row_5->get_supportedenginemodes( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_string = lo_row_7->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_booleanoptional = lo_row_5->get_supportsparallelquery( ).
          lv_booleanoptional = lo_row_5->get_supportsglobaldatabases( ).
          lv_booleanoptional = lo_row_5->get_supportsbabelfish( ).
          lv_booleanoptional = lo_row_5->get_suppslimitlessdatabase( ).
          lv_booleanoptional = lo_row_5->get_suppslocalwriteforward00( ).
          lv_booleanoptional = lo_row_5->get_supportsintegrations( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_supportedtimezones( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_string = lo_row_9->get_timezonename( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_exportablelogtypes( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_string = lo_row_11->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_suppslogexptocloudwatc00( ).
      lv_boolean = lo_row_1->get_supportsreadreplica( ).
      LOOP AT lo_row_1->get_supportedenginemodes( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_supportedfeaturenames( ) into lo_row_12.
        lo_row_13 = lo_row_12.
        IF lo_row_13 IS NOT INITIAL.
          lv_string = lo_row_13->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_status( ).
      lv_boolean = lo_row_1->get_supportsparallelquery( ).
      lv_boolean = lo_row_1->get_supportsglobaldatabases( ).
      lv_string = lo_row_1->get_majorengineversion( ).
      lv_string = lo_row_1->get_databaseinstallationfi00( ).
      lv_string = lo_row_1->get_databaseinstallationfi01( ).
      lv_string = lo_row_1->get_dbengineversionarn( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_tstamp = lo_row_1->get_createtime( ).
      LOOP AT lo_row_1->get_taglist( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_string = lo_row_15->get_key( ).
          lv_string = lo_row_15->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_supportsbabelfish( ).
      lv_customdbengineversionma = lo_row_1->get_custdbenginevrsmanifest( ).
      lv_boolean = lo_row_1->get_suppslimitlessdatabase( ).
      lv_booleanoptional = lo_row_1->get_suppscrtrotationwthout00( ).
      LOOP AT lo_row_1->get_supportedcacertids( ) into lo_row_16.
        lo_row_17 = lo_row_16.
        IF lo_row_17 IS NOT INITIAL.
          lv_string = lo_row_17->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_booleanoptional = lo_row_1->get_suppslocalwriteforward00( ).
      lv_boolean = lo_row_1->get_supportsintegrations( ).
      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.
    ENDIF.
  ENDLOOP.
ENDIF.

To describe the DB engine versions for the MySQL DB engine

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

DATA(lo_result) = lo_client->/aws1/if_rds~describedbengineversions( iv_engine = |mysql| ) .