Skip to content

/AWS1/IF_LOC=>STARTJOB()

About StartJob

StartJob starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.

For more information, see Job concepts in the Amazon Location Service Developer Guide.

Method Signature

METHODS /AWS1/IF_LOC~STARTJOB
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/LOCCLIENTTOKEN OPTIONAL
    !IV_ACTION TYPE /AWS1/LOCJOBACTION OPTIONAL
    !IO_ACTIONOPTIONS TYPE REF TO /AWS1/CL_LOCJOBACTIONOPTIONS OPTIONAL
    !IV_EXECUTIONROLEARN TYPE /AWS1/LOCIAMROLEARN OPTIONAL
    !IO_INPUTOPTIONS TYPE REF TO /AWS1/CL_LOCJOBINPUTOPTIONS OPTIONAL
    !IV_NAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IO_OUTPUTOPTIONS TYPE REF TO /AWS1/CL_LOCJOBOUTPUTOPTIONS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locstartjobresponse
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_action TYPE /AWS1/LOCJOBACTION /AWS1/LOCJOBACTION

The action to perform on the input data.

iv_executionrolearn TYPE /AWS1/LOCIAMROLEARN /AWS1/LOCIAMROLEARN

The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

io_inputoptions TYPE REF TO /AWS1/CL_LOCJOBINPUTOPTIONS /AWS1/CL_LOCJOBINPUTOPTIONS

Configuration for input data location and format.

Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

io_outputoptions TYPE REF TO /AWS1/CL_LOCJOBOUTPUTOPTIONS /AWS1/CL_LOCJOBOUTPUTOPTIONS

Configuration for output data location and format.

Optional arguments:

iv_clienttoken TYPE /AWS1/LOCCLIENTTOKEN /AWS1/LOCCLIENTTOKEN

A unique identifier for this request to ensure idempotency.

io_actionoptions TYPE REF TO /AWS1/CL_LOCJOBACTIONOPTIONS /AWS1/CL_LOCJOBACTIONOPTIONS

Additional parameters that can be requested for each result.

iv_name TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

An optional name for the job resource.

it_tags TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Tags and corresponding values to be associated with the job.

RETURNING

oo_output TYPE REF TO /aws1/cl_locstartjobresponse /AWS1/CL_LOCSTARTJOBRESPONSE

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->startjob(
  io_actionoptions = new /aws1/cl_locjobactionoptions(
    io_validateaddress = new /aws1/cl_locvldtaddractionopts(
      it_additionalfeatures = VALUE /aws1/cl_locvldtadraddlftlst_w=>tt_vldtaddressaddlfeaturelist(
        ( new /aws1/cl_locvldtadraddlftlst_w( |string| ) )
      )
    )
  )
  io_inputoptions = new /aws1/cl_locjobinputoptions(
    iv_format = |string|
    iv_location = |string|
  )
  io_outputoptions = new /aws1/cl_locjoboutputoptions(
    iv_format = |string|
    iv_location = |string|
  )
  it_tags = VALUE /aws1/cl_loctagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_loctagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_loctagmap_w( |string| )
      )
    )
  )
  iv_action = |string|
  iv_clienttoken = |string|
  iv_executionrolearn = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_timestamp = lo_result->get_createdat( ).
  lv_geoarn = lo_result->get_jobarn( ).
  lv_jobid = lo_result->get_jobid( ).
  lv_jobstatus = lo_result->get_status( ).
ENDIF.