You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoT::Types::OTAUpdateInfo

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

Overview

Information about an OTA update.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_parametersHash<String,String>

A collection of name/value pairs

Returns:

  • (Hash<String,String>)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#aws_iot_job_arnString

The AWS IoT job ARN associated with the OTA update.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#aws_iot_job_idString

The AWS IoT job ID associated with the OTA update.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#creation_dateTime

The date when the OTA update was created.

Returns:

  • (Time)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#descriptionString

A description of the OTA update.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#error_infoTypes::ErrorInfo

Error information associated with the OTA update.

Returns:



5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#last_modified_dateTime

The date when the OTA update was last updated.

Returns:

  • (Time)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#ota_update_arnString

The OTA update ARN.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#ota_update_filesArray<Types::OTAUpdateFile>

A list of files associated with the OTA update.

Returns:



5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#ota_update_idString

The OTA update ID.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#ota_update_statusString

The status of the OTA update.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#target_selectionString

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end

#targetsArray<String>

The targets of the OTA update.

Returns:

  • (Array<String>)


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5823

class OTAUpdateInfo < Struct.new(
  :ota_update_id,
  :ota_update_arn,
  :creation_date,
  :last_modified_date,
  :description,
  :targets,
  :target_selection,
  :ota_update_files,
  :ota_update_status,
  :aws_iot_job_id,
  :aws_iot_job_arn,
  :error_info,
  :additional_parameters)
  include Aws::Structure
end