/AWS1/IF_OMX=>STARTANNOTATIONIMPORTJOB()

About StartAnnotationImportJob

Amazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change.

Starts an annotation import job.

Method Signature

METHODS /AWS1/IF_OMX~STARTANNOTATIONIMPORTJOB
  IMPORTING
    !IV_DESTINATIONNAME TYPE /AWS1/OMXSTORENAME OPTIONAL
    !IV_ROLEARN TYPE /AWS1/OMXARN OPTIONAL
    !IT_ITEMS TYPE /AWS1/CL_OMXANNOTATIONIMPITE01=>TT_ANNOTATIONIMPORTITEMSOURCES OPTIONAL
    !IV_VERSIONNAME TYPE /AWS1/OMXVERSIONNAME OPTIONAL
    !IO_FORMATOPTIONS TYPE REF TO /AWS1/CL_OMXFORMATOPTIONS OPTIONAL
    !IV_RUNLEFTNORMALIZATION TYPE /AWS1/OMXRUNLEFTNORMALIZATION OPTIONAL
    !IT_ANNOTATIONFIELDS TYPE /AWS1/CL_OMXANNOTATIONFIELDM00=>TT_ANNOTATIONFIELDMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxstrtannotationim01
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXSERVICEQUOTAEXCDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_destinationname TYPE /AWS1/OMXSTORENAME /AWS1/OMXSTORENAME

A destination annotation store for the job.

iv_rolearn TYPE /AWS1/OMXARN /AWS1/OMXARN

A service role for the job.

it_items TYPE /AWS1/CL_OMXANNOTATIONIMPITE01=>TT_ANNOTATIONIMPORTITEMSOURCES TT_ANNOTATIONIMPORTITEMSOURCES

Items to import.

Optional arguments:

iv_versionname TYPE /AWS1/OMXVERSIONNAME /AWS1/OMXVERSIONNAME

The name of the annotation store version.

io_formatoptions TYPE REF TO /AWS1/CL_OMXFORMATOPTIONS /AWS1/CL_OMXFORMATOPTIONS

Formatting options for the annotation file.

iv_runleftnormalization TYPE /AWS1/OMXRUNLEFTNORMALIZATION /AWS1/OMXRUNLEFTNORMALIZATION

The job's left normalization setting.

it_annotationfields TYPE /AWS1/CL_OMXANNOTATIONFIELDM00=>TT_ANNOTATIONFIELDMAP TT_ANNOTATIONFIELDMAP

The annotation schema generated by the parsed annotation data.

RETURNING

oo_output TYPE REF TO /aws1/cl_omxstrtannotationim01 /AWS1/CL_OMXSTRTANNOTATIONIM01

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->startannotationimportjob(
  io_formatoptions = new /aws1/cl_omxformatoptions(
    io_tsvoptions = new /aws1/cl_omxtsvoptions(
      io_readoptions = new /aws1/cl_omxreadoptions(
        iv_comment = |string|
        iv_encoding = |string|
        iv_escape = |string|
        iv_escapequotes = ABAP_TRUE
        iv_header = ABAP_TRUE
        iv_linesep = |string|
        iv_quote = |string|
        iv_quoteall = ABAP_TRUE
        iv_sep = |string|
      )
    )
    io_vcfoptions = new /aws1/cl_omxvcfoptions(
      iv_ignorefilterfield = ABAP_TRUE
      iv_ignorequalfield = ABAP_TRUE
    )
  )
  it_annotationfields = VALUE /aws1/cl_omxannotationfieldm00=>tt_annotationfieldmap(
    (
      VALUE /aws1/cl_omxannotationfieldm00=>ts_annotationfieldmap_maprow(
        key = |string|
        value = new /aws1/cl_omxannotationfieldm00( |string| )
      )
    )
  )
  it_items = VALUE /aws1/cl_omxannotationimpite01=>tt_annotationimportitemsources(
    ( new /aws1/cl_omxannotationimpite01( |string| ) )
  )
  iv_destinationname = |string|
  iv_rolearn = |string|
  iv_runleftnormalization = ABAP_TRUE
  iv_versionname = |string|
).

This is an example of reading all possible response values

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