Skip to content

/AWS1/IF_DMG=>STARTMETADATAMODELCONVERSION()

About StartMetadataModelConversion

Queues a conversion of the selected source metadata models (database objects such as tables, views, and procedures) to the target database format. If other requests created by Start* operations are already in the migration project's queue, the conversion begins after they complete.

The conversion request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation.

If converted objects already exist in the target metadata tree, the conversion overwrites them, including any manual edits.

To check the status of the conversion request, call DescribeMetadataModelConversions using the returned RequestIdentifier as a filter.

To cancel a queued or in-progress request, call CancelMetadataModelConversion with the returned RequestIdentifier.

After the conversion completes successfully:

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

Method Signature

METHODS /AWS1/IF_DMG~STARTMETADATAMODELCONVERSION
  IMPORTING
    !IV_MIGRATIONPROJECTID TYPE /AWS1/DMGMIGRATIONPROJECTID OPTIONAL
    !IV_SELECTIONRULES TYPE /AWS1/DMGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgstrtmetmdelconvr01
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGINVRESRCSTATEFAULT
    /AWS1/CX_DMGKMSKEYNOTACCIBLE00
    /AWS1/CX_DMGRESRCALRDYEXFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGRESRCQUOTAEXCDFA00
    /AWS1/CX_DMGS3ACCDENIEDFAULT
    /AWS1/CX_DMGS3RESRCNOTFNDFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_migrationprojectid TYPE /AWS1/DMGMIGRATIONPROJECTID /AWS1/DMGMIGRATIONPROJECTID

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

iv_selectionrules TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

A JSON string that identifies the metadata models to convert. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

Usage:

  • Accepts only source selection rules, where server-name in the object locator matches the source data provider.

  • Supports explicit, include, and exclude rule actions.

RETURNING

oo_output TYPE REF TO /aws1/cl_dmgstrtmetmdelconvr01 /AWS1/CL_DMGSTRTMETMDELCONVR01

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->startmetadatamodelconversion(
  iv_migrationprojectid = |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_requestidentifier( ).
ENDIF.

Convert all objects in a schema

The following example queues a conversion of all objects in the ExampleSchema schema to the target database format.

DATA(lo_result) = lo_client->startmetadatamodelconversion(
  iv_migrationprojectid = |arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS|
  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"}]}|
).