class Aws::IoTJobsDataPlane::Types::UpdateJobExecutionRequest

@note When making an API call, you may pass UpdateJobExecutionRequest

data as a 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,
    }

@!attribute [rw] job_id

The unique identifier assigned to this job when it was created.
@return [String]

@!attribute [rw] thing_name

The name of the thing associated with the device.
@return [String]

@!attribute [rw] status

The new status for the job execution (IN\_PROGRESS, FAILED, SUCCESS,
or REJECTED). This must be specified on every update.
@return [String]

@!attribute [rw] status_details

Optional. A collection of name/value pairs that describe the status
of the job execution. If not specified, the statusDetails are
unchanged.
@return [Hash<String,String>]

@!attribute [rw] step_timeout_in_minutes

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`).
@return [Integer]

@!attribute [rw] expected_version

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.)
@return [Integer]

@!attribute [rw] include_job_execution_state

Optional. When included and set to true, the response contains the
JobExecutionState data. The default is false.
@return [Boolean]

@!attribute [rw] include_job_document

Optional. When set to true, the response contains the job document.
The default is false.
@return [Boolean]

@!attribute [rw] execution_number

Optional. A number that identifies a particular job execution on a
particular device.
@return [Integer]

Constants

SENSITIVE