You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTJobsDataPlane::Types::UpdateJobExecutionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTJobsDataPlane::Types::UpdateJobExecutionRequest
- Defined in:
- (unknown)
Overview
When passing UpdateJobExecutionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
job_id: "JobId", # required
thing_name: "ThingName", # required
status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
status_details: {
"DetailsKey" => "DetailsValue",
},
step_timeout_in_minutes: 1,
expected_version: 1,
include_job_execution_state: false,
include_job_document: false,
execution_number: 1,
}
Instance Attribute Summary collapse
-
#execution_number ⇒ Integer
Optional.
-
#expected_version ⇒ Integer
Optional.
-
#include_job_document ⇒ Boolean
Optional.
-
#include_job_execution_state ⇒ Boolean
Optional.
-
#job_id ⇒ String
The unique identifier assigned to this job when it was created.
-
#status ⇒ String
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
-
#status_details ⇒ Hash<String,String>
Optional.
-
#step_timeout_in_minutes ⇒ Integer
Specifies the amount of time this device has to finish execution of this job.
-
#thing_name ⇒ String
The name of the thing associated with the device.
Instance Attribute Details
#execution_number ⇒ Integer
Optional. A number that identifies a particular job execution on a particular device.
#expected_version ⇒ Integer
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.)
#include_job_document ⇒ Boolean
Optional. When set to true, the response contains the job document. The default is false.
#include_job_execution_state ⇒ Boolean
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
#job_id ⇒ String
The unique identifier assigned to this job when it was created.
#status ⇒ String
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
Possible values:
- QUEUED
- IN_PROGRESS
- SUCCEEDED
- FAILED
- TIMED_OUT
- REJECTED
- REMOVED
- CANCELED
#status_details ⇒ Hash<String,String>
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
#step_timeout_in_minutes ⇒ Integer
Specifies the amount of time this device has to finish execution of this
job. If the job execution status is not set to a terminal state before
this timer expires, or before the timer is reset (by again calling
UpdateJobExecution
, setting the status to IN_PROGRESS
and specifying
a new timeout value in this field) the job execution status will be
automatically set to TIMED_OUT
. Note that setting or resetting this
timeout has no effect on that job execution timeout which may have been
specified when the job was created (CreateJob
using field
timeoutConfig
).
#thing_name ⇒ String
The name of the thing associated with the device.