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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DeleteOTAUpdateRequest

Includes:

Structure

Defined in:

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

SENSITIVE =

[]

Instance Attribute Summary

• #delete_stream ⇒ Boolean

  When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.

• #force_delete_aws_job ⇒ Boolean

  When true, deletes the IoT job created by the OTAUpdate process even if it is “IN_PROGRESS”.

• #ota_update_id ⇒ String

  The ID of the OTA update to delete.

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)

# File 'lib/aws-sdk-iot/types.rb', line 6065

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)

# File 'lib/aws-sdk-iot/types.rb', line 6065

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)

# File 'lib/aws-sdk-iot/types.rb', line 6065

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