Struct aws_sdk_iot::input::CancelJobExecutionInput [−][src]
#[non_exhaustive]pub struct CancelJobExecutionInput {
pub job_id: Option<String>,
pub thing_name: Option<String>,
pub force: bool,
pub expected_version: Option<i64>,
pub status_details: Option<HashMap<String, String>>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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: 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
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CancelJobExecution, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CancelJobExecution, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CancelJobExecution
>
Creates a new builder-style object to manufacture CancelJobExecutionInput
The name of the thing whose execution of the job will be canceled.
(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.
(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.)
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for CancelJobExecutionInput
impl Send for CancelJobExecutionInput
impl Sync for CancelJobExecutionInput
impl Unpin for CancelJobExecutionInput
impl UnwindSafe for CancelJobExecutionInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more