CANCELJOB()`¶

About CancelJob¶

CancelJob cancels a job that is currently running or pending. If the job is already in a terminal state (Completed, Failed, or Cancelled), the operation returns successfully with the current status.

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

Method Signature¶

METHODS /AWS1/IF_LOC~CANCELJOB
  IMPORTING
    !IV_JOBID TYPE /AWS1/LOCJOBID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loccanceljobresponse
  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_jobid` `TYPE /AWS1/LOCJOBID` `/AWS1/LOCJOBID`¶

The unique identifier of the job to cancel.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_loccanceljobresponse` `/AWS1/CL_LOCCANCELJOBRESPONSE`¶

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->canceljob( |string| ).

This is an example of reading all possible response values

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

/AWS1/IF_LOC=>CANCELJOB()¶