#[non_exhaustive]pub struct DeleteJobExecutionInput {
pub job_id: Option<String>,
pub thing_name: Option<String>,
pub execution_number: Option<i64>,
pub force: Option<bool>,
pub namespace_id: Option<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 whose execution on a particular device will be deleted.
thing_name: Option<String>
The name of the thing whose job execution will be deleted.
execution_number: Option<i64>
The ID of the job execution to be deleted. The executionNumber
refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber
may be reused by IoT, so be sure you get and use the correct value here.
force: Option<bool>
(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
namespace_id: Option<String>
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
Implementations§
source§impl DeleteJobExecutionInput
impl DeleteJobExecutionInput
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The ID of the job whose execution on a particular device will be deleted.
sourcepub fn thing_name(&self) -> Option<&str>
pub fn thing_name(&self) -> Option<&str>
The name of the thing whose job execution will be deleted.
sourcepub fn execution_number(&self) -> Option<i64>
pub fn execution_number(&self) -> Option<i64>
The ID of the job execution to be deleted. The executionNumber
refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber
may be reused by IoT, so be sure you get and use the correct value here.
sourcepub fn force(&self) -> Option<bool>
pub fn force(&self) -> Option<bool>
(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
sourcepub fn namespace_id(&self) -> Option<&str>
pub fn namespace_id(&self) -> Option<&str>
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
source§impl DeleteJobExecutionInput
impl DeleteJobExecutionInput
sourcepub fn builder() -> DeleteJobExecutionInputBuilder
pub fn builder() -> DeleteJobExecutionInputBuilder
Creates a new builder-style object to manufacture DeleteJobExecutionInput
.
Trait Implementations§
source§impl Clone for DeleteJobExecutionInput
impl Clone for DeleteJobExecutionInput
source§fn clone(&self) -> DeleteJobExecutionInput
fn clone(&self) -> DeleteJobExecutionInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DeleteJobExecutionInput
impl Debug for DeleteJobExecutionInput
source§impl PartialEq for DeleteJobExecutionInput
impl PartialEq for DeleteJobExecutionInput
source§fn eq(&self, other: &DeleteJobExecutionInput) -> bool
fn eq(&self, other: &DeleteJobExecutionInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DeleteJobExecutionInput
Auto Trait Implementations§
impl Freeze for DeleteJobExecutionInput
impl RefUnwindSafe for DeleteJobExecutionInput
impl Send for DeleteJobExecutionInput
impl Sync for DeleteJobExecutionInput
impl Unpin for DeleteJobExecutionInput
impl UnwindSafe for DeleteJobExecutionInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more