DESCRIBEMETMODELCHILDREN()`¶

About DescribeMetadataModelChildren¶

Gets a list of child metadata models for the specified metadata model in the database hierarchy.

Required permissions: dms:DescribeMetadataModelChildren. For more information, see Actions, resources, and condition keys for Database Migration Service.

Method Signature¶

METHODS /AWS1/IF_DMG~DESCRIBEMETMODELCHILDREN
  IMPORTING
    !IV_SELECTIONRULES TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_MIGRATIONPROJECTID TYPE /AWS1/DMGMIGRATIONPROJECTID OPTIONAL
    !IV_ORIGIN TYPE /AWS1/DMGORIGINTYPEVALUE OPTIONAL
    !IV_MARKER TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgdscmetmdelchildr01
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_selectionrules` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

A JSON string that identifies the metadata model whose children to retrieve. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

Usage:

Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

Supports only explicit rule actions.

Exactly one rule is allowed.

`iv_migrationprojectid` `TYPE /AWS1/DMGMIGRATIONPROJECTID` `/AWS1/DMGMIGRATIONPROJECTID`¶

The migration project name or Amazon Resource Name (ARN).

`iv_origin` `TYPE /AWS1/DMGORIGINTYPEVALUE` `/AWS1/DMGORIGINTYPEVALUE`¶

Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

Optional arguments:¶

`iv_marker` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

Specifies the unique pagination token that indicates where the next page should start. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

`iv_maxrecords` `TYPE /AWS1/DMGINTEGEROPTIONAL` `/AWS1/DMGINTEGEROPTIONAL`¶

The maximum number of metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgdscmetmdelchildr01` `/AWS1/CL_DMGDSCMETMDELCHILDR01`¶

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->describemetmodelchildren(
  iv_marker = |string|
  iv_maxrecords = 123
  iv_migrationprojectid = |string|
  iv_origin = |string|
  iv_selectionrules = |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_metadatamodelchildren( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_metadatamodelname( ).
      lv_string = lo_row_1->get_selectionrules( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Retrieve children of a schema¶

The following example retrieves the child metadata models of the ExampleSchema schema from the source metadata tree.

DATA(lo_result) = lo_client->describemetmodelchildren(
  iv_migrationprojectid = |arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS|
  iv_origin = |SOURCE|
  iv_selectionrules = |{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"}, "rule-action": "explicit"}]}|
).

/AWS1/IF_DMG=>DESCRIBEMETMODELCHILDREN()¶