Class: Aws::IoT::Types::DeleteOTAUpdateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_stream ⇒ 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.

Returns:

  • (Boolean) 


5294
5295
5296
5297
5298
5299
5300
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5294

class DeleteOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :delete_stream,
  :force_delete_aws_job)
  SENSITIVE = []
  include Aws::Structure
end

#force_delete_aws_job ⇒ 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.

Returns:

  • (Boolean) 


5294
5295
5296
5297
5298
5299
5300
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5294

class DeleteOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :delete_stream,
  :force_delete_aws_job)
  SENSITIVE = []
  include Aws::Structure
end

#ota_update_id ⇒ String

The ID of the OTA update to delete.

Returns:

  • (String) 


5294
5295
5296
5297
5298
5299
5300
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5294

class DeleteOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :delete_stream,
  :force_delete_aws_job)
  SENSITIVE = []
  include Aws::Structure
end