/AWS1/CL_NEP=>DESCRIBEDBINSTANCES()

About DescribeDBInstances

Returns information about provisioned instances, and supports pagination.

This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

Method Signature

IMPORTING

Optional arguments:

iv_dbinstanceidentifier TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

it_filters TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

• engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

iv_maxrecords TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a 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/NEPSTRING /AWS1/NEPSTRING

An optional pagination token provided by a previous DescribeDBInstances 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_nepdbinstancemessage /AWS1/CL_NEPDBINSTANCEMESSAGE

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_nep~describedbinstances(
  it_filters = VALUE /aws1/cl_nepfilter=>tt_filterlist(
    (
      new /aws1/cl_nepfilter(
        it_values = VALUE /aws1/cl_nepfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_nepfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbinstanceidentifier = |string|
  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_dbinstances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_dbinstanceidentifier( ).
      lv_string = lo_row_1->get_dbinstanceclass( ).
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_dbinstancestatus( ).
      lv_string = lo_row_1->get_masterusername( ).
      lv_string = lo_row_1->get_dbname( ).
      lo_endpoint = lo_row_1->get_endpoint( ).
      IF lo_endpoint IS NOT INITIAL.
        lv_string = lo_endpoint->get_address( ).
        lv_integer = lo_endpoint->get_port( ).
        lv_string = lo_endpoint->get_hostedzoneid( ).
      ENDIF.
      lv_integer = lo_row_1->get_allocatedstorage( ).
      lv_tstamp = lo_row_1->get_instancecreatetime( ).
      lv_string = lo_row_1->get_preferredbackupwindow( ).
      lv_integer = lo_row_1->get_backupretentionperiod( ).
      LOOP AT lo_row_1->get_dbsecuritygroups( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_dbsecuritygroupname( ).
          lv_string = lo_row_3->get_status( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_vpcsecuritygroups( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_vpcsecuritygroupid( ).
          lv_string = lo_row_5->get_status( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_dbparametergroups( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_dbparametergroupname( ).
          lv_string = lo_row_7->get_parameterapplystatus( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_availabilityzone( ).
      lo_dbsubnetgroup = lo_row_1->get_dbsubnetgroup( ).
      IF lo_dbsubnetgroup IS NOT INITIAL.
        lv_string = lo_dbsubnetgroup->get_dbsubnetgroupname( ).
        lv_string = lo_dbsubnetgroup->get_dbsubnetgroupdescription( ).
        lv_string = lo_dbsubnetgroup->get_vpcid( ).
        lv_string = lo_dbsubnetgroup->get_subnetgroupstatus( ).
        LOOP AT lo_dbsubnetgroup->get_subnets( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_string = lo_row_9->get_subnetidentifier( ).
            lo_availabilityzone = lo_row_9->get_subnetavailabilityzone( ).
            IF lo_availabilityzone IS NOT INITIAL.
              lv_string = lo_availabilityzone->get_name( ).
            ENDIF.
            lv_string = lo_row_9->get_subnetstatus( ).
          ENDIF.
        ENDLOOP.
        lv_string = lo_dbsubnetgroup->get_dbsubnetgrouparn( ).
      ENDIF.
      lv_string = lo_row_1->get_preferredmaintenancewi00( ).
      lo_pendingmodifiedvalues = lo_row_1->get_pendingmodifiedvalues( ).
      IF lo_pendingmodifiedvalues IS NOT INITIAL.
        lv_string = lo_pendingmodifiedvalues->get_dbinstanceclass( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_allocatedstorage( ).
        lv_string = lo_pendingmodifiedvalues->get_masteruserpassword( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_port( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_backupretentionperiod( ).
        lv_booleanoptional = lo_pendingmodifiedvalues->get_multiaz( ).
        lv_string = lo_pendingmodifiedvalues->get_engineversion( ).
        lv_string = lo_pendingmodifiedvalues->get_licensemodel( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_iops( ).
        lv_string = lo_pendingmodifiedvalues->get_dbinstanceidentifier( ).
        lv_string = lo_pendingmodifiedvalues->get_storagetype( ).
        lv_string = lo_pendingmodifiedvalues->get_cacertificateidentifier( ).
        lv_string = lo_pendingmodifiedvalues->get_dbsubnetgroupname( ).
        lo_pendingcloudwatchlogsex = lo_pendingmodifiedvalues->get_pendingcloudwatchlogsexp( ).
        IF lo_pendingcloudwatchlogsex IS NOT INITIAL.
          LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) 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.
          LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) 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.
        ENDIF.
      ENDIF.
      lv_tstamp = lo_row_1->get_latestrestorabletime( ).
      lv_boolean = lo_row_1->get_multiaz( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_boolean = lo_row_1->get_autominorversionupgrade( ).
      lv_string = lo_row_1->get_readrplsourcedbinstid( ).
      LOOP AT lo_row_1->get_readreplicadbinstanceids( ) 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.
      LOOP AT lo_row_1->get_readreplicadbclusterids( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_string = lo_row_15->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_licensemodel( ).
      lv_integeroptional = lo_row_1->get_iops( ).
      LOOP AT lo_row_1->get_optiongroupmemberships( ) into lo_row_16.
        lo_row_17 = lo_row_16.
        IF lo_row_17 IS NOT INITIAL.
          lv_string = lo_row_17->get_optiongroupname( ).
          lv_string = lo_row_17->get_status( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_charactersetname( ).
      lv_string = lo_row_1->get_secondaryaz( ).
      lv_boolean = lo_row_1->get_publiclyaccessible( ).
      LOOP AT lo_row_1->get_statusinfos( ) into lo_row_18.
        lo_row_19 = lo_row_18.
        IF lo_row_19 IS NOT INITIAL.
          lv_string = lo_row_19->get_statustype( ).
          lv_boolean = lo_row_19->get_normal( ).
          lv_string = lo_row_19->get_status( ).
          lv_string = lo_row_19->get_message( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_storagetype( ).
      lv_string = lo_row_1->get_tdecredentialarn( ).
      lv_integer = lo_row_1->get_dbinstanceport( ).
      lv_string = lo_row_1->get_dbclusteridentifier( ).
      lv_boolean = lo_row_1->get_storageencrypted( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_string = lo_row_1->get_dbiresourceid( ).
      lv_string = lo_row_1->get_cacertificateidentifier( ).
      LOOP AT lo_row_1->get_domainmemberships( ) into lo_row_20.
        lo_row_21 = lo_row_20.
        IF lo_row_21 IS NOT INITIAL.
          lv_string = lo_row_21->get_domain( ).
          lv_string = lo_row_21->get_status( ).
          lv_string = lo_row_21->get_fqdn( ).
          lv_string = lo_row_21->get_iamrolename( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_copytagstosnapshot( ).
      lv_integeroptional = lo_row_1->get_monitoringinterval( ).
      lv_string = lo_row_1->get_enhancedmonresourcearn( ).
      lv_string = lo_row_1->get_monitoringrolearn( ).
      lv_integeroptional = lo_row_1->get_promotiontier( ).
      lv_string = lo_row_1->get_dbinstancearn( ).
      lv_string = lo_row_1->get_timezone( ).
      lv_boolean = lo_row_1->get_iamdatabaseauthntctnenbd( ).
      lv_booleanoptional = lo_row_1->get_performanceinsightsenbd( ).
      lv_string = lo_row_1->get_performanceinsightskms00( ).
      LOOP AT lo_row_1->get_enabledcloudwatchlogsexp( ) 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_booleanoptional = lo_row_1->get_deletionprotection( ).
    ENDIF.
  ENDLOOP.
ENDIF.