Struct aws_sdk_iotjobsdataplane::operation::update_job_execution::UpdateJobExecutionInput

#[non_exhaustive]
pub struct UpdateJobExecutionInput {
    pub job_id: Option<String>,
    pub thing_name: Option<String>,
    pub status: Option<JobExecutionStatus>,
    pub status_details: Option<HashMap<String, String>>,
    pub step_timeout_in_minutes: Option<i64>,
    pub expected_version: Option<i64>,
    pub include_job_execution_state: Option<bool>,
    pub include_job_document: Option<bool>,
    pub execution_number: Option<i64>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_id: Option<String>

The unique identifier assigned to this job when it was created.

thing_name: Option<String>

The name of the thing associated with the device.

status: Option<JobExecutionStatus>

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

status_details: Option<HashMap<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: Option<i64>

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).

expected_version: Option<i64>

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_execution_state: Option<bool>

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

include_job_document: Option<bool>

Optional. When set to true, the response contains the job document. The default is false.

execution_number: Option<i64>

Optional. A number that identifies a particular job execution on a particular device.

Implementations

impl UpdateJobExecutionInput

pub fn job_id(&self) -> Option<&str>

The unique identifier assigned to this job when it was created.

pub fn thing_name(&self) -> Option<&str>

The name of the thing associated with the device.

pub fn status(&self) -> Option<&JobExecutionStatus>

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

pub fn status_details(&self) -> Option<&HashMap<String, String>>

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

pub fn step_timeout_in_minutes(&self) -> Option<i64>

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).

pub fn expected_version(&self) -> Option<i64>

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.)

pub fn include_job_execution_state(&self) -> Option<bool>

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

pub fn include_job_document(&self) -> Option<bool>

Optional. When set to true, the response contains the job document. The default is false.

pub fn execution_number(&self) -> Option<i64>

Optional. A number that identifies a particular job execution on a particular device.

impl UpdateJobExecutionInput

pub fn builder() -> UpdateJobExecutionInputBuilder

Creates a new builder-style object to manufacture UpdateJobExecutionInput.

Trait Implementations

impl Clone for UpdateJobExecutionInput

fn clone(&self) -> UpdateJobExecutionInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateJobExecutionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateJobExecutionInput

fn eq(&self, other: &UpdateJobExecutionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateJobExecutionInput