Struct aws_sdk_iot::input::DeleteJobInput

#[non_exhaustive]
pub struct DeleteJobInput {
    pub job_id: Option<String>,
    pub force: bool,
    pub namespace_id: Option<String>,
}

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 ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

force: bool

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted 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 in public preview.

Implementations

impl DeleteJobInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DeleteJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DeleteJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DeleteJobInput

impl DeleteJobInput

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

pub fn force(&self) -> bool

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

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

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 in public preview.

Trait Implementations

impl Clone for DeleteJobInput

fn clone(&self) -> DeleteJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteJobInput

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

Formats the value using the given formatter.

impl PartialEq<DeleteJobInput> for DeleteJobInput

fn eq(&self, other: &DeleteJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DeleteJobInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DeleteJobInput