Skip to content

/AWS1/CL_RDS=>DESCRIBERESERVEDDBINSTANCES()

About DescribeReservedDBInstances

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Method Signature

IMPORTING

Optional arguments:

iv_reserveddbinstanceid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

iv_reserveddbinstsofferingid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

iv_dbinstanceclass TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

iv_duration TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

iv_productdescription TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

iv_offeringtype TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

iv_multiaz TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

Specifies whether to show only those reservations that support Multi-AZ.

iv_leaseid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter isn't currently supported.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsreserveddbinstmsg /AWS1/CL_RDSRESERVEDDBINSTMSG

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~describereserveddbinstances(
  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_dbinstanceclass = |string|
  iv_duration = |string|
  iv_leaseid = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_multiaz = ABAP_TRUE
  iv_offeringtype = |string|
  iv_productdescription = |string|
  iv_reserveddbinstanceid = |string|
  iv_reserveddbinstsofferingid = |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_reserveddbinstances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_reserveddbinstanceid( ).
      lv_string = lo_row_1->get_rsvddbinstsofferingid( ).
      lv_string = lo_row_1->get_dbinstanceclass( ).
      lv_tstamp = lo_row_1->get_starttime( ).
      lv_integer = lo_row_1->get_duration( ).
      lv_double = lo_row_1->get_fixedprice( ).
      lv_double = lo_row_1->get_usageprice( ).
      lv_string = lo_row_1->get_currencycode( ).
      lv_integer = lo_row_1->get_dbinstancecount( ).
      lv_string = lo_row_1->get_productdescription( ).
      lv_string = lo_row_1->get_offeringtype( ).
      lv_boolean = lo_row_1->get_multiaz( ).
      lv_string = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_recurringcharges( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_double = lo_row_3->get_recurringchargeamount( ).
          lv_string = lo_row_3->get_recurringchargefrequency( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_reserveddbinstancearn( ).
      lv_string = lo_row_1->get_leaseid( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe reserved DB instances

The following example retrieves details about any reserved DB instances in the current AWS account.

DATA(lo_result) = lo_client->/aws1/if_rds~describereserveddbinstances( ).