You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::CancelJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::CancelJobRequest
- Defined in:
- (unknown)
Overview
When passing CancelJobRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
job_id: "JobId", # required
reason_code: "ReasonCode",
comment: "Comment",
force: false,
}
Instance Attribute Summary collapse
-
#comment ⇒ String
An optional comment string describing why the job was canceled.
-
#force ⇒ Boolean
(Optional) If
true
job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. -
#job_id ⇒ String
The unique identifier you assigned to this job when it was created.
-
#reason_code ⇒ String
(Optional)A reason code string that explains why the job was canceled.
Instance Attribute Details
#comment ⇒ String
An optional comment string describing why the job was canceled.
#force ⇒ Boolean
(Optional) If true
job executions with status \"IN_PROGRESS\" and
\"QUEUED\" are canceled, otherwise only job executions with status
\"QUEUED\" are canceled. The default is false
.
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.
#job_id ⇒ String
The unique identifier you assigned to this job when it was created.
#reason_code ⇒ String
(Optional)A reason code string that explains why the job was canceled.