Skip to content

/AWS1/IF_MGN=>STARTIMPORTFILEENRICHMENT()

About StartImportFileEnrichment

Starts an import file enrichment job to process and enrich network migration import files with additional metadata and IP assignment strategies.

Method Signature

METHODS /AWS1/IF_MGN~STARTIMPORTFILEENRICHMENT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/MGNCLIIDEMPOTENCYTOKEN OPTIONAL
    !IO_S3BUCKETSOURCE TYPE REF TO /AWS1/CL_MGNENRCHMNTSRCS3CONF OPTIONAL
    !IO_S3BUCKETTARGET TYPE REF TO /AWS1/CL_MGNENRCHMNTTGTS3CONF OPTIONAL
    !IV_IPASSIGNMENTSTRATEGY TYPE /AWS1/MGNIPASSIGNMENTSTRATEGY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mgnstartimpfileercrsp
  RAISING
    /AWS1/CX_MGNACCESSDENIEDEX
    /AWS1/CX_MGNCONFLICTEXCEPTION
    /AWS1/CX_MGNSERVICEQUOTAEXCDEX
    /AWS1/CX_MGNTHROTTLINGEX
    /AWS1/CX_MGNVALIDATIONEX
    /AWS1/CX_MGNCLIENTEXC
    /AWS1/CX_MGNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_s3bucketsource TYPE REF TO /AWS1/CL_MGNENRCHMNTSRCS3CONF /AWS1/CL_MGNENRCHMNTSRCS3CONF

The S3 configuration specifying the source location of the import file to be enriched.

io_s3buckettarget TYPE REF TO /AWS1/CL_MGNENRCHMNTTGTS3CONF /AWS1/CL_MGNENRCHMNTTGTS3CONF

The S3 configuration specifying the target location where the enriched import file will be stored.

Optional arguments:

iv_clienttoken TYPE /AWS1/MGNCLIIDEMPOTENCYTOKEN /AWS1/MGNCLIIDEMPOTENCYTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

iv_ipassignmentstrategy TYPE /AWS1/MGNIPASSIGNMENTSTRATEGY /AWS1/MGNIPASSIGNMENTSTRATEGY

The IP assignment strategy to use when enriching the import file. Can be STATIC or DYNAMIC.

RETURNING

oo_output TYPE REF TO /aws1/cl_mgnstartimpfileercrsp /AWS1/CL_MGNSTARTIMPFILEERCRSP

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->startimportfileenrichment(
  io_s3bucketsource = new /aws1/cl_mgnenrchmntsrcs3conf(
    iv_s3bucket = |string|
    iv_s3bucketowner = |string|
    iv_s3key = |string|
  )
  io_s3buckettarget = new /aws1/cl_mgnenrchmnttgts3conf(
    iv_s3bucket = |string|
    iv_s3bucketowner = |string|
    iv_s3key = |string|
  )
  iv_clienttoken = |string|
  iv_ipassignmentstrategy = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_importfileenrichmentjob = lo_result->get_jobid( ).
ENDIF.

Sample StartImportFileEnrichment call

Sample StartImportFileEnrichment call

DATA(lo_result) = lo_client->startimportfileenrichment(
  io_s3bucketsource = new /aws1/cl_mgnenrchmntsrcs3conf(
    iv_s3bucket = |my-source-bucket|
    iv_s3bucketowner = |123456789012|
    iv_s3key = |imports/source-file.csv|
  )
  io_s3buckettarget = new /aws1/cl_mgnenrchmnttgts3conf(
    iv_s3bucket = |my-target-bucket|
    iv_s3bucketowner = |123456789012|
    iv_s3key = |enriched/output.csv|
  )
  iv_ipassignmentstrategy = |STATIC|
).