Skip to content

/AWS1/IF_HLL=>STARTDATATRANSFORMATIONJOB()

About StartDataTransformationJob

Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.

Method Signature

METHODS /AWS1/IF_HLL~STARTDATATRANSFORMATIONJOB
  IMPORTING
    !IO_INPUTDATACONFIG TYPE REF TO /AWS1/CL_HLLXFORMTNINPDATACFG OPTIONAL
    !IO_OUTPUTDATACONFIG TYPE REF TO /AWS1/CL_HLLXFORMTNOUTDATACFG OPTIONAL
    !IV_DATAACCESSROLEARN TYPE /AWS1/HLLDATAXFORMTNIAMROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/HLLCLIENTTOKEN OPTIONAL
    !IV_JOBNAME TYPE /AWS1/HLLDATAXFORMTNJOBNAME OPTIONAL
    !IV_PROFILEID TYPE /AWS1/HLLPROFILEIDSTRING OPTIONAL
    !IV_DRIFTDETECTIONENABLED TYPE /AWS1/HLLBOOLEAN00 OPTIONAL
    !IV_PROVENANCEENABLED TYPE /AWS1/HLLBOOLEAN00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hllstrtdataxfrmjobrsp
  RAISING
    /AWS1/CX_HLLACCESSDENIEDEX
    /AWS1/CX_HLLINTERNALSERVEREX
    /AWS1/CX_HLLRESOURCENOTFOUNDEX
    /AWS1/CX_HLLTHROTTLINGEX
    /AWS1/CX_HLLVALIDATIONEX
    /AWS1/CX_HLLCLIENTEXC
    /AWS1/CX_HLLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_inputdataconfig TYPE REF TO /AWS1/CL_HLLXFORMTNINPDATACFG /AWS1/CL_HLLXFORMTNINPDATACFG

The Amazon S3 location and format of the source files to transform.

io_outputdataconfig TYPE REF TO /AWS1/CL_HLLXFORMTNOUTDATACFG /AWS1/CL_HLLXFORMTNOUTDATACFG

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

iv_dataaccessrolearn TYPE /AWS1/HLLDATAXFORMTNIAMROLEARN /AWS1/HLLDATAXFORMTNIAMROLEARN

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.

iv_clienttoken TYPE /AWS1/HLLCLIENTTOKEN /AWS1/HLLCLIENTTOKEN

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

iv_profileid TYPE /AWS1/HLLPROFILEIDSTRING /AWS1/HLLPROFILEIDSTRING

The unique identifier of the data transformation profile to use for conversion.

Optional arguments:

iv_jobname TYPE /AWS1/HLLDATAXFORMTNJOBNAME /AWS1/HLLDATAXFORMTNJOBNAME

A descriptive name for the data transformation job.

iv_driftdetectionenabled TYPE /AWS1/HLLBOOLEAN00 /AWS1/HLLBOOLEAN00

Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

iv_provenanceenabled TYPE /AWS1/HLLBOOLEAN00 /AWS1/HLLBOOLEAN00

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

RETURNING

oo_output TYPE REF TO /aws1/cl_hllstrtdataxfrmjobrsp /AWS1/CL_HLLSTRTDATAXFRMJOBRSP

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->startdatatransformationjob(
  io_inputdataconfig = new /aws1/cl_hllxformtninpdatacfg(
    iv_s3uri = |string|
    iv_sourceformat = |string|
  )
  io_outputdataconfig = new /aws1/cl_hllxformtnoutdatacfg(
    io_s3configuration = new /aws1/cl_hlldataxformtns3conf(
      iv_kmskeyid = |string|
      iv_s3uri = |string|
    )
  )
  iv_clienttoken = |string|
  iv_dataaccessrolearn = |string|
  iv_driftdetectionenabled = ABAP_TRUE
  iv_jobname = |string|
  iv_profileid = |string|
  iv_provenanceenabled = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_datatransformationjobid = lo_result->get_jobid( ).
  lv_transformationjobstatus = lo_result->get_jobstatus( ).
ENDIF.