Struct aws_sdk_iot::operation::cancel_job_execution::CancelJobExecutionInput

#[non_exhaustive]
pub struct CancelJobExecutionInput {
    pub job_id: Option<String>,
    pub thing_name: Option<String>,
    pub force: Option<bool>,
    pub expected_version: Option<i64>,
    pub status_details: Option<HashMap<String, String>>,
}

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 ID of the job to be canceled.

thing_name: Option<String>

The name of the thing whose execution of the job will be canceled.

force: Option<bool>

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

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

status_details: Option<HashMap<String, String>>

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Implementations

impl CancelJobExecutionInput

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

The ID of the job to be canceled.

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

The name of the thing whose execution of the job will be canceled.

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

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

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 status_details(&self) -> Option<&HashMap<String, String>>

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

impl CancelJobExecutionInput

pub fn builder() -> CancelJobExecutionInputBuilder

Creates a new builder-style object to manufacture CancelJobExecutionInput.

Trait Implementations

impl Clone for CancelJobExecutionInput

fn clone(&self) -> CancelJobExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJobExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for CancelJobExecutionInput

fn eq(&self, other: &CancelJobExecutionInput) -> 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 CancelJobExecutionInput