Struct aws_sdk_iotjobsdataplane::client::fluent_builders::UpdateJobExecution

pub struct UpdateJobExecution<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to UpdateJobExecution.

Updates the status of a job execution.

Implementations

impl<C, M, R> UpdateJobExecution<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<UpdateJobExecutionOutput, SdkError<UpdateJobExecutionError>> where
    R::Policy: SmithyRetryPolicy<UpdateJobExecutionInputOperationOutputAlias, UpdateJobExecutionOutput, UpdateJobExecutionError, UpdateJobExecutionInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn job_id(self, input: impl Into<String>) -> Self

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

pub fn set_job_id(self, input: Option<String>) -> Self

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

pub fn thing_name(self, input: impl Into<String>) -> Self

The name of the thing associated with the device.

pub fn set_thing_name(self, input: Option<String>) -> Self

The name of the thing associated with the device.

pub fn status(self, input: JobExecutionStatus) -> Self

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

pub fn set_status(self, input: Option<JobExecutionStatus>) -> Self

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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to statusDetails.

To override the contents of this collection use set_status_details.

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

pub fn set_status_details(self, input: Option<HashMap<String, String>>) -> Self

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, input: i64) -> Self

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 set_step_timeout_in_minutes(self, input: Option<i64>) -> Self

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, input: i64) -> Self

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 set_expected_version(self, input: Option<i64>) -> Self

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, input: bool) -> Self

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

pub fn set_include_job_execution_state(self, input: Option<bool>) -> Self

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

pub fn include_job_document(self, input: bool) -> Self

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

pub fn set_include_job_document(self, input: Option<bool>) -> Self

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

pub fn execution_number(self, input: i64) -> Self

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

pub fn set_execution_number(self, input: Option<i64>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for UpdateJobExecution<C, M, R>

fn clone(&self) -> UpdateJobExecution<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateJobExecution<C, M, R>

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

Formats the value using the given formatter.