Struct aws_sdk_iot::operation::cancel_job::CancelJobInput

#[non_exhaustive]
pub struct CancelJobInput {
    pub job_id: Option<String>,
    pub reason_code: Option<String>,
    pub comment: Option<String>,
    pub force: Option<bool>,
}

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 you assigned to this job when it was created.

reason_code: Option<String>

(Optional)A reason code string that explains why the job was canceled.

comment: Option<String>

An optional comment string describing why the job was canceled.

force: Option<bool>

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Implementations

impl CancelJobInput

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

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

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

(Optional)A reason code string that explains why the job was canceled.

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

An optional comment string describing why the job was canceled.

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

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

impl CancelJobInput

pub fn builder() -> CancelJobInputBuilder

Creates a new builder-style object to manufacture CancelJobInput.

Trait Implementations

impl Clone for CancelJobInput

fn clone(&self) -> CancelJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJobInput

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

Formats the value using the given formatter.

impl PartialEq for CancelJobInput

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