#[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)
This struct is marked as non-exhaustive
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
sourceimpl UpdateJobExecutionInput
impl UpdateJobExecutionInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateJobExecution, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateJobExecution, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<UpdateJobExecution
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture UpdateJobExecutionInput
sourceimpl UpdateJobExecutionInput
impl UpdateJobExecutionInput
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The unique identifier assigned to this job when it was created.
sourcepub fn thing_name(&self) -> Option<&str>
pub fn thing_name(&self) -> Option<&str>
The name of the thing associated with the device.
sourcepub fn status(&self) -> Option<&JobExecutionStatus>
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.
sourcepub fn status_details(&self) -> Option<&HashMap<String, String>>
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.
sourcepub fn step_timeout_in_minutes(&self) -> Option<i64>
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
).
sourcepub fn expected_version(&self) -> Option<i64>
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.)
sourcepub fn include_job_execution_state(&self) -> Option<bool>
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.
sourcepub fn include_job_document(&self) -> Option<bool>
pub fn include_job_document(&self) -> Option<bool>
Optional. When set to true, the response contains the job document. The default is false.
sourcepub fn execution_number(&self) -> Option<i64>
pub fn execution_number(&self) -> Option<i64>
Optional. A number that identifies a particular job execution on a particular device.
Trait Implementations
sourceimpl Clone for UpdateJobExecutionInput
impl Clone for UpdateJobExecutionInput
sourcefn clone(&self) -> UpdateJobExecutionInput
fn clone(&self) -> UpdateJobExecutionInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateJobExecutionInput
impl Debug for UpdateJobExecutionInput
sourceimpl PartialEq<UpdateJobExecutionInput> for UpdateJobExecutionInput
impl PartialEq<UpdateJobExecutionInput> for UpdateJobExecutionInput
sourcefn eq(&self, other: &UpdateJobExecutionInput) -> bool
fn eq(&self, other: &UpdateJobExecutionInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateJobExecutionInput) -> bool
fn ne(&self, other: &UpdateJobExecutionInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for UpdateJobExecutionInput
Auto Trait Implementations
impl RefUnwindSafe for UpdateJobExecutionInput
impl Send for UpdateJobExecutionInput
impl Sync for UpdateJobExecutionInput
impl Unpin for UpdateJobExecutionInput
impl UnwindSafe for UpdateJobExecutionInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more