DeleteOTAUpdate
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
Request Syntax
DELETE /otaUpdates/otaUpdateId?deleteStream=deleteStream&forceDeleteAWSJob=forceDeleteAWSJob HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- deleteStream
-
When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.
- forceDeleteAWSJob
-
When true, deletes the AWS IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.
- otaUpdateId
-
The ID of the OTA update to delete.
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
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
- message
-
The message for the exception.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
- message
-
The message for the exception.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
- message
-
The message for the exception.
HTTP Status Code: 401
- VersionConflictException
-
An exception thrown when the version of an entity specified with the
expectedVersionparameter does not match the latest version in the system.- message
-
The message for the exception.
HTTP Status Code: 409
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
