Struct aws_sdk_iot::client::fluent_builders::CancelJob
source · [−]pub struct CancelJob { /* private fields */ }
Expand description
Fluent builder constructing a request to CancelJob
.
Cancels a job.
Requires permission to access the CancelJob action.
Implementations
sourceimpl CancelJob
impl CancelJob
sourcepub async fn send(self) -> Result<CancelJobOutput, SdkError<CancelJobError>>
pub async fn send(self) -> Result<CancelJobOutput, SdkError<CancelJobError>>
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.
sourcepub fn job_id(self, input: impl Into<String>) -> Self
pub fn job_id(self, input: impl Into<String>) -> Self
The unique identifier you assigned to this job when it was created.
sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The unique identifier you assigned to this job when it was created.
sourcepub fn reason_code(self, input: impl Into<String>) -> Self
pub fn reason_code(self, input: impl Into<String>) -> Self
(Optional)A reason code string that explains why the job was canceled.
sourcepub fn set_reason_code(self, input: Option<String>) -> Self
pub fn set_reason_code(self, input: Option<String>) -> Self
(Optional)A reason code string that explains why the job was canceled.
sourcepub fn comment(self, input: impl Into<String>) -> Self
pub fn comment(self, input: impl Into<String>) -> Self
An optional comment string describing why the job was canceled.
sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
An optional comment string describing why the job was canceled.
sourcepub fn force(self, input: bool) -> Self
pub fn force(self, input: 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.
sourcepub fn set_force(self, input: Option<bool>) -> Self
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
Auto Trait Implementations
impl !RefUnwindSafe for CancelJob
impl Send for CancelJob
impl Sync for CancelJob
impl Unpin for CancelJob
impl !UnwindSafe for CancelJob
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more