delete_ota_update

IoT.Client.delete_ota_update(**kwargs)

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

See also: AWS API Documentation

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

• (dict) --

Exceptions

• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ResourceNotFoundException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.VersionConflictException