Skip to content

/AWS1/IF_ERN=>STARTIDMAPPINGJOB()

About StartIdMappingJob

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

Method Signature

METHODS /AWS1/IF_ERN~STARTIDMAPPINGJOB
  IMPORTING
    !IV_WORKFLOWNAME TYPE /AWS1/ERNENTNAMEORIDMAPWORKF00 OPTIONAL
    !IT_OUTPUTSOURCECONFIG TYPE /AWS1/CL_ERNIDMAPJOBOUTPUTSRC=>TT_IDMAPJOBOUTPUTSOURCECONFIG OPTIONAL
    !IV_JOBTYPE TYPE /AWS1/ERNJOBTYPE OPTIONAL
  PREFERRED PARAMETER iv_workflowname
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ernstartidmapjobout
  RAISING
    /AWS1/CX_ERNACCESSDENIEDEX
    /AWS1/CX_ERNCONFLICTEXCEPTION
    /AWS1/CX_ERNEXCEEDSLIMITEX
    /AWS1/CX_ERNINTERNALSERVEREX
    /AWS1/CX_ERNRESOURCENOTFOUNDEX
    /AWS1/CX_ERNTHROTTLINGEX
    /AWS1/CX_ERNVALIDATIONEX
    /AWS1/CX_ERNCLIENTEXC
    /AWS1/CX_ERNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_workflowname TYPE /AWS1/ERNENTNAMEORIDMAPWORKF00 /AWS1/ERNENTNAMEORIDMAPWORKF00

The name of the ID mapping job to be retrieved.

Optional arguments:

it_outputsourceconfig TYPE /AWS1/CL_ERNIDMAPJOBOUTPUTSRC=>TT_IDMAPJOBOUTPUTSOURCECONFIG TT_IDMAPJOBOUTPUTSOURCECONFIG

A list of OutputSource objects.

iv_jobtype TYPE /AWS1/ERNJOBTYPE /AWS1/ERNJOBTYPE

The job type for the ID mapping job.

If the jobType value is set to INCREMENTAL, only new or changed data is processed since the last job run. This is the default value if the CreateIdMappingWorkflow API is configured with an incrementalRunConfig.

If the jobType value is set to BATCH, all data is processed from the input source, regardless of previous job runs. This is the default value if the CreateIdMappingWorkflow API isn't configured with an incrementalRunConfig.

If the jobType value is set to DELETE_ONLY, only deletion requests from BatchDeleteUniqueIds are processed.

RETURNING

oo_output TYPE REF TO /aws1/cl_ernstartidmapjobout /AWS1/CL_ERNSTARTIDMAPJOBOUT

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->startidmappingjob(
  it_outputsourceconfig = VALUE /aws1/cl_ernidmapjoboutputsrc=>tt_idmapjoboutputsourceconfig(
    (
      new /aws1/cl_ernidmapjoboutputsrc(
        iv_kmsarn = |string|
        iv_outputs3path = |string|
        iv_rolearn = |string|
      )
    )
  )
  iv_jobtype = |string|
  iv_workflowname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
  LOOP AT lo_result->get_outputsourceconfig( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_rolearn = lo_row_1->get_rolearn( ).
      lv_s3path = lo_row_1->get_outputs3path( ).
      lv_kmsarn = lo_row_1->get_kmsarn( ).
    ENDIF.
  ENDLOOP.
  lv_jobtype = lo_result->get_jobtype( ).
ENDIF.