STARTREADSETEXPORTJOB()`¶

About StartReadSetExportJob¶

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation.

To monitor the status of the export job, use the ListReadSetExportJobs API operation.

Method Signature¶

METHODS /AWS1/IF_OMX~STARTREADSETEXPORTJOB
  IMPORTING
    !IV_SEQUENCESTOREID TYPE /AWS1/OMXSEQUENCESTOREID OPTIONAL
    !IV_DESTINATION TYPE /AWS1/OMXS3DESTINATION OPTIONAL
    !IV_ROLEARN TYPE /AWS1/OMXROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OMXCLIENTTOKEN OPTIONAL
    !IT_SOURCES TYPE /AWS1/CL_OMXEXPORTREADSET=>TT_EXPORTREADSETLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxstrtreadsetexpjo01
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /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_sequencestoreid` `TYPE /AWS1/OMXSEQUENCESTOREID` `/AWS1/OMXSEQUENCESTOREID`¶

The read set's sequence store ID.

`iv_destination` `TYPE /AWS1/OMXS3DESTINATION` `/AWS1/OMXS3DESTINATION`¶

A location for exported files in Amazon S3.

`iv_rolearn` `TYPE /AWS1/OMXROLEARN` `/AWS1/OMXROLEARN`¶

A service role for the job.

`it_sources` `TYPE /AWS1/CL_OMXEXPORTREADSET=>TT_EXPORTREADSETLIST` `TT_EXPORTREADSETLIST`¶

The job's source files.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/OMXCLIENTTOKEN` `/AWS1/OMXCLIENTTOKEN`¶

To ensure that jobs don't run multiple times, specify a unique token for each job.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxstrtreadsetexpjo01` `/AWS1/CL_OMXSTRTREADSETEXPJO01`¶

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->startreadsetexportjob(
  it_sources = VALUE /aws1/cl_omxexportreadset=>tt_exportreadsetlist(
    ( new /aws1/cl_omxexportreadset( |string| ) )
  )
  iv_clienttoken = |string|
  iv_destination = |string|
  iv_rolearn = |string|
  iv_sequencestoreid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_exportjobid = lo_result->get_id( ).
  lv_sequencestoreid = lo_result->get_sequencestoreid( ).
  lv_s3destination = lo_result->get_destination( ).
  lv_readsetexportjobstatus = lo_result->get_status( ).
  lv_timestamp = lo_result->get_creationtime( ).
ENDIF.

/AWS1/IF_OMX=>STARTREADSETEXPORTJOB()¶