CancelJobExecutionRequest
import type { CancelJobExecutionRequest } from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";
§Properties
(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
(Optional) If true
the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force
to true
, then an InvalidStateTransitionException
will be thrown.
The default is false
.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.