aws_sdk_iot/client/

delete_job_execution.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteJobExecution`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_id(impl Into<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::set_job_id):<br>required: **true**<br><p>The ID of the job whose execution on a particular device will be deleted.</p><br>
    ///   - [`thing_name(impl Into<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::thing_name) / [`set_thing_name(Option<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::set_thing_name):<br>required: **true**<br><p>The name of the thing whose job execution will be deleted.</p><br>
    ///   - [`execution_number(i64)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::execution_number) / [`set_execution_number(Option<i64>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::set_execution_number):<br>required: **true**<br><p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p> <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p><br>
    ///   - [`force(bool)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::set_force):<br>required: **false**<br><p>(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.</p><note>  <p>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.</p> </note><br>
    ///   - [`namespace_id(impl Into<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::namespace_id) / [`set_namespace_id(Option<String>)`](crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::set_namespace_id):<br>required: **false**<br><p>The namespace used to indicate that a job is a customer-managed job.</p> <p>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.</p> <p><code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code></p><note>  <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a></p> </note><br>
    /// - On success, responds with [`DeleteJobExecutionOutput`](crate::operation::delete_job_execution::DeleteJobExecutionOutput)
    /// - On failure, responds with [`SdkError<DeleteJobExecutionError>`](crate::operation::delete_job_execution::DeleteJobExecutionError)
    pub fn delete_job_execution(&self) -> crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder {
        crate::operation::delete_job_execution::builders::DeleteJobExecutionFluentBuilder::new(self.handle.clone())
    }
}