Skip to content

/AWS1/CL_RDS=>DESCRDBSNAPTENANTDATABASES()

About DescribeDBSnapshotTenantDatabases

Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.

You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

Method Signature

IMPORTING

Optional arguments:

iv_dbinstanceidentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.

Constraints:

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

iv_dbsnapshotidentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.

Constraints:

  • If you specify this parameter, the value must match the ID of an existing DB snapshot.

  • If you specify an automatic snapshot, you must also specify SnapshotType.

iv_snapshottype TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The type of DB snapshots to be returned. You can specify one of the following values:

  • automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

  • manual – All DB snapshots that have been taken by my Amazon Web Services account.

  • shared – All manual DB snapshots that have been shared to my Amazon Web Services account.

  • public – All DB snapshots that have been marked as public.

  • awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more tenant databases to describe.

Supported filters:

  • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

  • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

  • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

  • db-snapshot-id - Accepts DB snapshot identifiers.

  • snapshot-type - Accepts types of DB snapshots.

iv_maxrecords TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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 you can retrieve the remaining results.

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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

iv_dbiresourceid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

A specific DB resource identifier to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdbsnaptenantdata00 /AWS1/CL_RDSDBSNAPTENANTDATA00

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~descrdbsnaptenantdatabases(
  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_dbinstanceidentifier = |string|
  iv_dbiresourceid = |string|
  iv_dbsnapshotidentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_snapshottype = |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_dbsnaptenantdatabases( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_dbsnapshotidentifier( ).
      lv_string = lo_row_1->get_dbinstanceidentifier( ).
      lv_string = lo_row_1->get_dbiresourceid( ).
      lv_string = lo_row_1->get_enginename( ).
      lv_string = lo_row_1->get_snapshottype( ).
      lv_tstamp = lo_row_1->get_tenantdatabasecreatetime( ).
      lv_string = lo_row_1->get_tenantdbname( ).
      lv_string = lo_row_1->get_masterusername( ).
      lv_string = lo_row_1->get_tenantdatabaseresourceid( ).
      lv_string = lo_row_1->get_charactersetname( ).
      lv_string = lo_row_1->get_dbsnaptenantdatabasearn( ).
      lv_string = lo_row_1->get_ncharcharactersetname( ).
      LOOP AT lo_row_1->get_taglist( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.