You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::CancelJobExecutionRequestWhen passing CancelJobExecutionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
job_id: "JobId", thing_name: "ThingName", force: false,
expected_version: 1,
status_details: {
"DetailsKey" => "DetailsValue",
},
}
Instance Attribute Summary collapse
(Optional) The expected current version of the job execution.
(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.
The ID of the job to be canceled.
A collection of name/value pairs that describe the status of the job execution.
The name of the thing whose execution of the job will be canceled.
(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.)
#force ⇒ Boolean(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.
#job_id ⇒ StringThe ID of the job to be canceled.
#status_details ⇒ Hash<String,String>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
#thing_name ⇒ StringThe name of the thing whose execution of the job will be canceled.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4