IoT / Client / delete_ota_update

delete_ota_update#

IoT.Client.delete_ota_update(**kwargs)#

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

Request Syntax

response = client.delete_ota_update(
    otaUpdateId='string',
    deleteStream=True|False,
    forceDeleteAWSJob=True|False
)

Parameters:

otaUpdateId (string) –
[REQUIRED]

The ID of the OTA update to delete.
deleteStream (boolean) – 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 (boolean) – When true, deletes the 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

Exceptions