Skip to content

/AWS1/IF_SGM=>STOPJOB()

About StopJob

Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in progress. To delete a stopped job, call DeleteJob.

The following operations are related to StopJob:

  • CreateJob

  • DescribeJob

  • DeleteJob

Method Signature

METHODS /AWS1/IF_SGM~STOPJOB
  IMPORTING
    !IV_JOBNAME TYPE /AWS1/SGMJOBNAME OPTIONAL
    !IV_JOBCATEGORY TYPE /AWS1/SGMJOBCATEGORY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmstopjobresponse
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobname TYPE /AWS1/SGMJOBNAME /AWS1/SGMJOBNAME

The name of the job to stop.

iv_jobcategory TYPE /AWS1/SGMJOBCATEGORY /AWS1/SGMJOBCATEGORY

The category of the job to stop.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmstopjobresponse /AWS1/CL_SGMSTOPJOBRESPONSE

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->stopjob(
  iv_jobcategory = |string|
  iv_jobname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.