Struct aws_sdk_iot::client::fluent_builders::CancelJob

pub struct CancelJob<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CancelJob.

Cancels a job.

Requires permission to access the CancelJob action.

Implementations

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

pub async fn send(self) -> Result<CancelJobOutput, SdkError<CancelJobError>> where
    R::Policy: SmithyRetryPolicy<CancelJobInputOperationOutputAlias, CancelJobOutput, CancelJobError, CancelJobInputOperationRetryAlias>, 

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

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

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

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

pub fn reason_code(self, inp: impl Into<String>) -> Self

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

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

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

pub fn comment(self, inp: impl Into<String>) -> Self

An optional comment string describing why the job was canceled.

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

An optional comment string describing why the job was canceled.

pub fn force(self, inp: bool) -> Self

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

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

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

Trait Implementations

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

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

Formats the value using the given formatter.