/AWS1/IF_EMS=>STARTJOBRUN()

About StartJobRun

Starts a job run.

Method Signature

METHODS /AWS1/IF_EMS~STARTJOBRUN
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/EMSAPPLICATIONID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EMSCLIENTTOKEN OPTIONAL
    !IV_EXECUTIONROLEARN TYPE /AWS1/EMSIAMROLEARN OPTIONAL
    !IO_EXECUTIONIAMPOLICY TYPE REF TO /AWS1/CL_EMSJOBRUNEXECIAMPLY OPTIONAL
    !IO_JOBDRIVER TYPE REF TO /AWS1/CL_EMSJOBDRIVER OPTIONAL
    !IO_CONFIGURATIONOVERRIDES TYPE REF TO /AWS1/CL_EMSCONFOVERRIDES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_EMSTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_EXECUTIONTIMEOUTMINUTES TYPE /AWS1/EMSDURATION OPTIONAL
    !IV_NAME TYPE /AWS1/EMSSTRING256 OPTIONAL
    !IV_MODE TYPE /AWS1/EMSJOBRUNMODE OPTIONAL
    !IO_RETRYPOLICY TYPE REF TO /AWS1/CL_EMSRETRYPOLICY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emsstartjobrunrsp
  RAISING
    /AWS1/CX_EMSCONFLICTEXCEPTION
    /AWS1/CX_EMSINTERNALSERVEREX
    /AWS1/CX_EMSRESOURCENOTFOUNDEX
    /AWS1/CX_EMSVALIDATIONEX
    /AWS1/CX_EMSCLIENTEXC
    /AWS1/CX_EMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/EMSAPPLICATIONID /AWS1/EMSAPPLICATIONID

The ID of the application on which to run the job.

iv_clienttoken TYPE /AWS1/EMSCLIENTTOKEN /AWS1/EMSCLIENTTOKEN

The client idempotency token of the job run to start. Its value must be unique for each request.

iv_executionrolearn TYPE /AWS1/EMSIAMROLEARN /AWS1/EMSIAMROLEARN

The execution role ARN for the job run.

Optional arguments:

io_executioniampolicy TYPE REF TO /AWS1/CL_EMSJOBRUNEXECIAMPLY /AWS1/CL_EMSJOBRUNEXECIAMPLY

You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

io_jobdriver TYPE REF TO /AWS1/CL_EMSJOBDRIVER /AWS1/CL_EMSJOBDRIVER

The job driver for the job run.

io_configurationoverrides TYPE REF TO /AWS1/CL_EMSCONFOVERRIDES /AWS1/CL_EMSCONFOVERRIDES

The configuration overrides for the job run.

it_tags TYPE /AWS1/CL_EMSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags assigned to the job run.

iv_executiontimeoutminutes TYPE /AWS1/EMSDURATION /AWS1/EMSDURATION

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

iv_name TYPE /AWS1/EMSSTRING256 /AWS1/EMSSTRING256

The optional job run name. This doesn't have to be unique.

iv_mode TYPE /AWS1/EMSJOBRUNMODE /AWS1/EMSJOBRUNMODE

The mode of the job run when it starts.

io_retrypolicy TYPE REF TO /AWS1/CL_EMSRETRYPOLICY /AWS1/CL_EMSRETRYPOLICY

The retry policy when job run starts.

RETURNING

oo_output TYPE REF TO /aws1/cl_emsstartjobrunrsp /AWS1/CL_EMSSTARTJOBRUNRSP

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->startjobrun(
  io_configurationoverrides = new /aws1/cl_emsconfoverrides(
    io_monitoringconfiguration = new /aws1/cl_emsmonitoringconf(
      io_cloudwatchloggingconf = new /aws1/cl_emscloudwatchlogconf(
        it_logtypes = VALUE /aws1/cl_emslogtypelist_w=>tt_logtypemap(
          (
            VALUE /aws1/cl_emslogtypelist_w=>ts_logtypemap_maprow(
              value = VALUE /aws1/cl_emslogtypelist_w=>tt_logtypelist(
                ( new /aws1/cl_emslogtypelist_w( |string| ) )
              )
              key = |string|
            )
          )
        )
        iv_enabled = ABAP_TRUE
        iv_encryptionkeyarn = |string|
        iv_loggroupname = |string|
        iv_logstreamnameprefix = |string|
      )
      io_managedpersistencemonconf = new /aws1/cl_emsmanagedpersisten00(
        iv_enabled = ABAP_TRUE
        iv_encryptionkeyarn = |string|
      )
      io_prometheusmonitoringconf = new /aws1/cl_emsprometheusmonconf( |string| )
      io_s3monitoringconfiguration = new /aws1/cl_emss3monitoringconf(
        iv_encryptionkeyarn = |string|
        iv_loguri = |string|
      )
    )
    it_applicationconfiguration = VALUE /aws1/cl_emsconfiguration=>tt_configurationlist(
      (
        new /aws1/cl_emsconfiguration(
          it_configurations = VALUE /aws1/cl_emsconfiguration=>tt_configurationlist(
          )
          it_properties = VALUE /aws1/cl_emssensitiveprpsmap_w=>tt_sensitivepropertiesmap(
            (
              VALUE /aws1/cl_emssensitiveprpsmap_w=>ts_sensitiveprpsmap_maprow(
                value = new /aws1/cl_emssensitiveprpsmap_w( |string| )
                key = |string|
              )
            )
          )
          iv_classification = |string|
        )
      )
    )
  )
  io_executioniampolicy = new /aws1/cl_emsjobrunexeciamply(
    it_policyarns = VALUE /aws1/cl_emspolicyarnlist_w=>tt_policyarnlist(
      ( new /aws1/cl_emspolicyarnlist_w( |string| ) )
    )
    iv_policy = |string|
  )
  io_jobdriver = new /aws1/cl_emsjobdriver(
    io_hive = new /aws1/cl_emshive(
      iv_initqueryfile = |string|
      iv_parameters = |string|
      iv_query = |string|
    )
    io_sparksubmit = new /aws1/cl_emssparksubmit(
      it_entrypointarguments = VALUE /aws1/cl_emsentrptarguments_w=>tt_entrypointarguments(
        ( new /aws1/cl_emsentrptarguments_w( |string| ) )
      )
      iv_entrypoint = |string|
      iv_sparksubmitparameters = |string|
    )
  )
  io_retrypolicy = new /aws1/cl_emsretrypolicy(
    iv_maxattempts = 123
    iv_maxfailedattemptsperhour = 123
  )
  it_tags = VALUE /aws1/cl_emstagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_emstagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_emstagmap_w( |string| )
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_executionrolearn = |string|
  iv_executiontimeoutminutes = 123
  iv_mode = |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_applicationid = lo_result->get_applicationid( ).
  lv_jobrunid = lo_result->get_jobrunid( ).
  lv_jobarn = lo_result->get_arn( ).
ENDIF.