Struct CancelJobExecutionRequest 

pub struct CancelJobExecutionRequest {
    pub expected_version: Option<i64>,
    pub force: Option<bool>,
    pub job_id: String,
    pub status_details: Option<HashMap<String, String>>,
    pub thing_name: String,
}

Fields

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

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.

job_id: String

The ID of the job to be canceled.

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.

thing_name: String

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

Trait Implementations

impl Clone for CancelJobExecutionRequest

fn clone(&self) -> CancelJobExecutionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJobExecutionRequest

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

Formats the value using the given formatter.

impl Default for CancelJobExecutionRequest

fn default() -> CancelJobExecutionRequest

Returns the “default value” for a type.

impl PartialEq for CancelJobExecutionRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CancelJobExecutionRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CancelJobExecutionRequest