DeleteJobExecution
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
Request Syntax
DELETE /things/thingName/jobs/jobId/executionNumber/executionNumber?force=force&namespaceId=namespaceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- executionNumber
-
The ID of the job execution to be deleted. The
executionNumberrefers to the execution of a particular job on a particular device.Note that once a job execution is deleted, the
executionNumbermay be reused by IoT, so be sure you get and use the correct value here.Required: Yes
- force
-
(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
-
The ID of the job whose execution on a particular device will be deleted.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- namespaceId
-
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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
namespaceIdfeature is only supported by AWS IoT Greengrass at this time. For more information, see Setting up AWS IoT Greengrass core devices.Pattern:
[a-zA-Z0-9_-]+ - thingName
-
The name of the thing whose job execution will be deleted.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- InvalidStateTransitionException
-
An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the
forceparameter.HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
