Struct aws_sdk_iot::client::fluent_builders::DeleteJobExecution

source ·

pub struct DeleteJobExecution { /* private fields */ }

Expand description

Fluent builder constructing a request to DeleteJobExecution.

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Implementations§

source §

impl DeleteJobExecution

source

pub async fn customize(
self
) -> Result<CustomizableOperation<DeleteJobExecution, AwsResponseRetryClassifier>, SdkError<DeleteJobExecutionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<DeleteJobExecutionOutput, SdkError<DeleteJobExecutionError>>

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.

source

pub fn job_id(self, input: impl Into<String>) -> Self

The ID of the job whose execution on a particular device will be deleted.

source

pub fn set_job_id(self, input: Option<String>) -> Self

The ID of the job whose execution on a particular device will be deleted.

source

pub fn thing_name(self, input: impl Into<String>) -> Self

The name of the thing whose job execution will be deleted.

source

pub fn set_thing_name(self, input: Option<String>) -> Self

The name of the thing whose job execution will be deleted.

source

pub fn execution_number(self, input: i64) -> Self

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.

source

pub fn set_execution_number(self, input: Option<i64>) -> Self

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.

source

pub fn force(self, input: bool) -> Self

(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.

source

pub fn set_force(self, input: Option<bool>) -> Self

(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.

source

pub fn namespace_id(self, input: impl Into<String>) -> Self

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.

source

pub fn set_namespace_id(self, input: Option<String>) -> Self

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.