Skip to content

/AWS1/IF_DMG=>STARTREPLTASKASSESSMENTRUN()

About StartReplicationTaskAssessmentRun

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

Method Signature

METHODS /AWS1/IF_DMG~STARTREPLTASKASSESSMENTRUN
  IMPORTING
    !IV_REPLICATIONTASKARN TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_SERVICEACCESSROLEARN TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_RESULTLOCATIONBUCKET TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_RESULTLOCATIONFOLDER TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_RESULTENCRYPTIONMODE TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_RESULTKMSKEYARN TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_ASSESSMENTRUNNAME TYPE /AWS1/DMGSTRING OPTIONAL
    !IT_INCLUDEONLY TYPE /AWS1/CL_DMGINCLUDETESTLIST_W=>TT_INCLUDETESTLIST OPTIONAL
    !IT_EXCLUDE TYPE /AWS1/CL_DMGEXCLUDETESTLIST_W=>TT_EXCLUDETESTLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgstrtrepltskasses03
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGINVRESRCSTATEFAULT
    /AWS1/CX_DMGKMSACCDENIEDFAULT
    /AWS1/CX_DMGKMSDISABLEDFAULT
    /AWS1/CX_DMGKMSFAULT
    /AWS1/CX_DMGKMSINVSTATEFAULT
    /AWS1/CX_DMGKMSKEYNOTACCIBLE00
    /AWS1/CX_DMGKMSNOTFOUNDFAULT
    /AWS1/CX_DMGRESRCALRDYEXFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /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_replicationtaskarn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

iv_serviceaccessrolearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

iv_resultlocationbucket TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Amazon S3 bucket where you want DMS to store the results of this assessment run.

iv_assessmentrunname TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Unique name to identify the assessment run.

Optional arguments:

iv_resultlocationfolder TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

iv_resultencryptionmode TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

  • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.

  • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.

iv_resultkmskeyarn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

it_includeonly TYPE /AWS1/CL_DMGINCLUDETESTLIST_W=>TT_INCLUDETESTLIST TT_INCLUDETESTLIST

Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

it_exclude TYPE /AWS1/CL_DMGEXCLUDETESTLIST_W=>TT_EXCLUDETESTLIST TT_EXCLUDETESTLIST

Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

it_tags TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST TT_TAGLIST

One or more tags to be assigned to the premigration assessment run that you want to start.

RETURNING

oo_output TYPE REF TO /aws1/cl_dmgstrtrepltskasses03 /AWS1/CL_DMGSTRTREPLTSKASSES03

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->startrepltaskassessmentrun(
  it_exclude = VALUE /aws1/cl_dmgexcludetestlist_w=>tt_excludetestlist(
    ( new /aws1/cl_dmgexcludetestlist_w( |string| ) )
  )
  it_includeonly = VALUE /aws1/cl_dmgincludetestlist_w=>tt_includetestlist(
    ( new /aws1/cl_dmgincludetestlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_dmgtag=>tt_taglist(
    (
      new /aws1/cl_dmgtag(
        iv_key = |string|
        iv_resourcearn = |string|
        iv_value = |string|
      )
    )
  )
  iv_assessmentrunname = |string|
  iv_replicationtaskarn = |string|
  iv_resultencryptionmode = |string|
  iv_resultkmskeyarn = |string|
  iv_resultlocationbucket = |string|
  iv_resultlocationfolder = |string|
  iv_serviceaccessrolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_replicationtaskassessme = lo_result->get_repltaskassessmentrun( ).
  IF lo_replicationtaskassessme IS NOT INITIAL.
    lv_string = lo_replicationtaskassessme->get_repltaskassessmentrunarn( ).
    lv_string = lo_replicationtaskassessme->get_replicationtaskarn( ).
    lv_string = lo_replicationtaskassessme->get_status( ).
    lv_tstamp = lo_replicationtaskassessme->get_repltskassessmentruncr00( ).
    lo_replicationtaskassessme_1 = lo_replicationtaskassessme->get_assessmentprogress( ).
    IF lo_replicationtaskassessme_1 IS NOT INITIAL.
      lv_integer = lo_replicationtaskassessme_1->get_individualassessmentcnt( ).
      lv_integer = lo_replicationtaskassessme_1->get_individualassessmentcm00( ).
    ENDIF.
    lv_string = lo_replicationtaskassessme->get_lastfailuremessage( ).
    lv_string = lo_replicationtaskassessme->get_serviceaccessrolearn( ).
    lv_string = lo_replicationtaskassessme->get_resultlocationbucket( ).
    lv_string = lo_replicationtaskassessme->get_resultlocationfolder( ).
    lv_string = lo_replicationtaskassessme->get_resultencryptionmode( ).
    lv_string = lo_replicationtaskassessme->get_resultkmskeyarn( ).
    lv_string = lo_replicationtaskassessme->get_assessmentrunname( ).
    lv_boolean = lo_replicationtaskassessme->get_islatsttaskassessmentrun( ).
    lo_replicationtaskassessme_2 = lo_replicationtaskassessme->get_resultstatistic( ).
    IF lo_replicationtaskassessme_2 IS NOT INITIAL.
      lv_integer = lo_replicationtaskassessme_2->get_passed( ).
      lv_integer = lo_replicationtaskassessme_2->get_failed( ).
      lv_integer = lo_replicationtaskassessme_2->get_error( ).
      lv_integer = lo_replicationtaskassessme_2->get_warning( ).
      lv_integer = lo_replicationtaskassessme_2->get_cancelled( ).
      lv_integer = lo_replicationtaskassessme_2->get_skipped( ).
    ENDIF.
  ENDIF.
ENDIF.