DELETE

/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}

http://iot.{region}.amazonaws.com/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}

Deletes a job execution. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteJobExecution</a> action.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

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

thingNamestringrequired

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

executionNumberintegerrequired

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

Query Params

forceboolean

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

namespaceIdstring

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. <code>$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/</code> <note> The <code>namespaceId</code> feature is in public preview. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://iot.{region}.amazonaws.com/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}