DeleteJobExecutionRequest

import type { DeleteJobExecutionRequest } from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";

interface DeleteJobExecutionRequest {

executionNumber: number;

force?: boolean | null;

jobId: string;

namespaceId?: string | null;

thingName: string;

}

§Properties

executionNumber: number

[src]

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?: boolean | null

[src]

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

Note: 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.

jobId: string

[src]

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

namespaceId?: string | null

[src]

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_/

Note: The namespaceId feature is in public preview.

thingName: string

[src]

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