Skip to content

/AWS1/IF_QST=>STARTAUTOMATIONJOB()

About StartAutomationJob

Starts a new job for a specified automation. The job runs the automation with the provided input payload.

Method Signature

METHODS /AWS1/IF_QST~STARTAUTOMATIONJOB
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_AUTOMATIONGROUPID TYPE /AWS1/QSTAUTOMATEID OPTIONAL
    !IV_AUTOMATIONID TYPE /AWS1/QSTAUTOMATEID OPTIONAL
    !IV_INPUTPAYLOAD TYPE /AWS1/QSTSENSITIVEIOPAYLOAD OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qststartautojobrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account that contains the automation.

iv_automationgroupid TYPE /AWS1/QSTAUTOMATEID /AWS1/QSTAUTOMATEID

The ID of the automation group that contains the automation to run.

iv_automationid TYPE /AWS1/QSTAUTOMATEID /AWS1/QSTAUTOMATEID

The ID of the automation to run.

Optional arguments:

iv_inputpayload TYPE /AWS1/QSTSENSITIVEIOPAYLOAD /AWS1/QSTSENSITIVEIOPAYLOAD

The input payload for the automation job, provided as a JSON string.

RETURNING

oo_output TYPE REF TO /aws1/cl_qststartautojobrsp /AWS1/CL_QSTSTARTAUTOJOBRSP

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->startautomationjob(
  iv_automationgroupid = |string|
  iv_automationid = |string|
  iv_awsaccountid = |string|
  iv_inputpayload = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_arn( ).
  lv_automateid = lo_result->get_jobid( ).
  lv_statuscode = lo_result->get_status( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.