v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Cancels a job.

Requires permission to access the CancelJob action.

put/jobs/{jobId}/cancel

Path parameters

jobIdstring required

The unique identifier you assigned to this job when it was created.

Query parameters

forceboolean
<p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p> <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>

Request body

reasonCodestring

(Optional)A reason code string that explains why the job was canceled.

commentstring

An optional comment string describing why the job was canceled.

Response

Success

jobArnstring

The job ARN.

jobIdstring

The unique identifier you assigned to this job when it was created.

descriptionstring

A short text description of the job.