/AWS1/IF_QST=>DESCRIBEAUTOMATIONJOB()

About DescribeAutomationJob

Retrieves the status and details of a specified automation job, including its status and outputs.

Method Signature

METHODS /AWS1/IF_QST~DESCRIBEAUTOMATIONJOB
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_AUTOMATIONGROUPID TYPE /AWS1/QSTAUTOMATEID OPTIONAL
    !IV_AUTOMATIONID TYPE /AWS1/QSTAUTOMATEID OPTIONAL
    !IV_INCLUDEINPUTPAYLOAD TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IV_INCLUDEOUTPUTPAYLOAD TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IV_JOBID TYPE /AWS1/QSTAUTOMATEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescrautojobrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /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 job.

iv_automationgroupid TYPE /AWS1/QSTAUTOMATEID /AWS1/QSTAUTOMATEID

The ID of the automation group that contains the automation.

iv_automationid TYPE /AWS1/QSTAUTOMATEID /AWS1/QSTAUTOMATEID

The ID of the automation that the job belongs to.

iv_jobid TYPE /AWS1/QSTAUTOMATEID /AWS1/QSTAUTOMATEID

The ID of the automation job to describe.

Optional arguments:

iv_includeinputpayload TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null.

iv_includeoutputpayload TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstdescrautojobrsp /AWS1/CL_QSTDESCRAUTOJOBRSP

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->describeautomationjob(
  iv_automationgroupid = |string|
  iv_automationid = |string|
  iv_awsaccountid = |string|
  iv_includeinputpayload = ABAP_TRUE
  iv_includeoutputpayload = ABAP_TRUE
  iv_jobid = |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_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_startedat( ).
  lv_timestamp = lo_result->get_endedat( ).
  lv_automationjobstatus = lo_result->get_jobstatus( ).
  lv_sensitiveiopayload = lo_result->get_inputpayload( ).
  lv_sensitiveiopayload = lo_result->get_outputpayload( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.