STARTBATCHJOB()`¶

About StartBatchJob¶

Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.

Method Signature¶

METHODS /AWS1/IF_M2~STARTBATCHJOB
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/M2_IDENTIFIER OPTIONAL
    !IO_BATCHJOBIDENTIFIER TYPE REF TO /AWS1/CL_M2_BATCHJOBIDENTIFIER OPTIONAL
    !IT_JOBPARAMS TYPE /AWS1/CL_M2_BTCJOBPARAMSMAP_W=>TT_BATCHJOBPARAMETERSMAP OPTIONAL
    !IV_AUTHSECRETSMANAGERARN TYPE /AWS1/M2_AUTHSECRETSMANAGERARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_m2_startbatchjobrsp
  RAISING
    /AWS1/CX_M2_ACCESSDENIEDEX
    /AWS1/CX_M2_CONFLICTEXCEPTION
    /AWS1/CX_M2_INTERNALSERVEREX
    /AWS1/CX_M2_RESOURCENOTFOUNDEX
    /AWS1/CX_M2_THROTTLINGEX
    /AWS1/CX_M2_VALIDATIONEX
    /AWS1/CX_M2_CLIENTEXC
    /AWS1/CX_M2_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/M2_IDENTIFIER` `/AWS1/M2_IDENTIFIER`¶

The unique identifier of the application associated with this batch job.

`io_batchjobidentifier` `TYPE REF TO /AWS1/CL_M2_BATCHJOBIDENTIFIER` `/AWS1/CL_M2_BATCHJOBIDENTIFIER`¶

The unique identifier of the batch job.

Optional arguments:¶

`it_jobparams` `TYPE /AWS1/CL_M2_BTCJOBPARAMSMAP_W=>TT_BATCHJOBPARAMETERSMAP` `TT_BATCHJOBPARAMETERSMAP`¶

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

`iv_authsecretsmanagerarn` `TYPE /AWS1/M2_AUTHSECRETSMANAGERARN` `/AWS1/M2_AUTHSECRETSMANAGERARN`¶

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_m2_startbatchjobrsp` `/AWS1/CL_M2_STARTBATCHJOBRSP`¶

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->startbatchjob(
  io_batchjobidentifier = new /aws1/cl_m2_batchjobidentifier(
    io_filebatchjobidentifier = new /aws1/cl_m2_filebatchjobid(
      iv_filename = |string|
      iv_folderpath = |string|
    )
    io_restartbatchjobidentifier = new /aws1/cl_m2_restartbatchjobid(
      io_jobsteprestartmarker = new /aws1/cl_m2_jobsteprestrtmar00(
        iv_fromprocstep = |string|
        iv_fromstep = |string|
        iv_skip = ABAP_TRUE
        iv_stepcheckpoint = 123
        iv_toprocstep = |string|
        iv_tostep = |string|
      )
      iv_executionid = |string|
    )
    io_s3batchjobidentifier = new /aws1/cl_m2_s3batchjobid(
      io_identifier = new /aws1/cl_m2_jobidentifier(
        iv_filename = |string|
        iv_scriptname = |string|
      )
      iv_bucket = |string|
      iv_keyprefix = |string|
    )
    io_scriptbatchjobidentifier = new /aws1/cl_m2_scriptbatchjobid( |string| )
  )
  it_jobparams = VALUE /aws1/cl_m2_btcjobparamsmap_w=>tt_batchjobparametersmap(
    (
      VALUE /aws1/cl_m2_btcjobparamsmap_w=>ts_batchjobparamsmap_maprow(
        value = new /aws1/cl_m2_btcjobparamsmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_authsecretsmanagerarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_identifier = lo_result->get_executionid( ).
ENDIF.

/AWS1/IF_M2=>STARTBATCHJOB()¶