v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1417171268.6 KB

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

delete/2012-09-25/jobs/{Id}

Path parameters

Idstring required
<p>The identifier of the job that you want to cancel.</p> <p>To get a list of the jobs (including their <code>jobId</code>) that have a status of <code>Submitted</code>, use the <a>ListJobsByStatus</a> API action.</p>

Response

Success

CancelJobResponse required

The response body contains a JSON object. If the job is successfully canceled, the value of <code>Success</code> is <code>true</code>.