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

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

Overview

Note:

When making an API call, you may pass DeleteOTAUpdateRequest data as a hash:

{
  ota_update_id: "OTAUpdateId", # required
  delete_stream: false,
  force_delete_aws_job: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_streamBoolean

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)


5990
5991
5992
5993
5994
5995
5996
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5990

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

#force_delete_aws_jobBoolean

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)


5990
5991
5992
5993
5994
5995
5996
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5990

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

#ota_update_idString

The ID of the OTA update to delete.

Returns:

  • (String)


5990
5991
5992
5993
5994
5995
5996
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5990

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