EXPORTMETMODELASSESSMENT()`¶

About ExportMetadataModelAssessment¶

Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.

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

Method Signature¶

METHODS /AWS1/IF_DMG~EXPORTMETMODELASSESSMENT
  IMPORTING
    !IV_MIGRATIONPROJECTID TYPE /AWS1/DMGMIGRATIONPROJECTID OPTIONAL
    !IV_SELECTIONRULES TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_FILENAME TYPE /AWS1/DMGSTRING OPTIONAL
    !IT_ASSESSMENTREPORTTYPES TYPE /AWS1/CL_DMGASSESSMENTRPTTYP00=>TT_ASSESSMENTREPORTTYPESLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgexpmetmdelassess01
  RAISING
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /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 export a conversion assessment report for. 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 only explicit rule actions.

Optional arguments:¶

`iv_filename` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

The name of the assessment file to create in your Amazon S3 bucket.

`it_assessmentreporttypes` `TYPE /AWS1/CL_DMGASSESSMENTRPTTYP00=>TT_ASSESSMENTREPORTTYPESLIST` `TT_ASSESSMENTREPORTTYPESLIST`¶

The file format of the assessment file.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgexpmetmdelassess01` `/AWS1/CL_DMGEXPMETMDELASSESS01`¶

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->exportmetmodelassessment(
  it_assessmentreporttypes = VALUE /aws1/cl_dmgassessmentrpttyp00=>tt_assessmentreporttypeslist(
    ( new /aws1/cl_dmgassessmentrpttyp00( |string| ) )
  )
  iv_filename = |string|
  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.
  lo_exportmetadatamodelasse = lo_result->get_pdfreport( ).
  IF lo_exportmetadatamodelasse IS NOT INITIAL.
    lv_string = lo_exportmetadatamodelasse->get_s3objectkey( ).
    lv_string = lo_exportmetadatamodelasse->get_objecturl( ).
  ENDIF.
  lo_exportmetadatamodelasse = lo_result->get_csvreport( ).
  IF lo_exportmetadatamodelasse IS NOT INITIAL.
    lv_string = lo_exportmetadatamodelasse->get_s3objectkey( ).
    lv_string = lo_exportmetadatamodelasse->get_objecturl( ).
  ENDIF.
ENDIF.

Export a conversion assessment report¶

The following example exports a conversion assessment report for all objects in the ExampleSchema schema.

DATA(lo_result) = lo_client->exportmetmodelassessment(
  it_assessmentreporttypes = VALUE /aws1/cl_dmgassessmentrpttyp00=>tt_assessmentreporttypeslist(
    ( new /aws1/cl_dmgassessmentrpttyp00( |pdf| ) )
    ( new /aws1/cl_dmgassessmentrpttyp00( |csv| ) )
  )
  iv_filename = |example-assessment-report|
  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"}]}|
).

/AWS1/IF_DMG=>EXPORTMETMODELASSESSMENT()¶