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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::OTAUpdateInfo

Defined in:

(unknown)

Overview

Information about an OTA update.

Returned by:

• GetOTAUpdateResponse#ota_update_info

Instance Attribute Summary

• #additional_parameters ⇒ Hash<String,String>

  A collection of name/value pairs.

• #aws_iot_job_arn ⇒ String

  The AWS IoT job ARN associated with the OTA update.

• #aws_iot_job_id ⇒ String

  The AWS IoT job ID associated with the OTA update.

• #aws_job_executions_rollout_config ⇒ Types::AwsJobExecutionsRolloutConfig

  Configuration for the rollout of OTA updates.

• #aws_job_presigned_url_config ⇒ Types::AwsJobPresignedUrlConfig

  Configuration information for pre-signed URLs.

• #creation_date ⇒ Time

  The date when the OTA update was created.

• #description ⇒ String

  A description of the OTA update.

• #error_info ⇒ Types::ErrorInfo

  Error information associated with the OTA update.

• #last_modified_date ⇒ Time

  The date when the OTA update was last updated.

• #ota_update_arn ⇒ String

  The OTA update ARN.

• #ota_update_files ⇒ Array<Types::OTAUpdateFile>

  A list of files associated with the OTA update.

• #ota_update_id ⇒ String

  The OTA update ID.

• #ota_update_status ⇒ String

  The status of the OTA update.

• #protocols ⇒ Array<String>

  The protocol used to transfer the OTA update image.

• #target_selection ⇒ String

  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).

• #targets ⇒ Array<String>

  The targets of the OTA update.

Instance Attribute Details

#additional_parameters ⇒ Hash<String,String>

A collection of name/value pairs

Returns:

• (Hash<String,String>) —

  A collection of name/value pairs.

#aws_iot_job_arn ⇒ String

The AWS IoT job ARN associated with the OTA update.

Returns:

• (String) —

  The AWS IoT job ARN associated with the OTA update.

#aws_iot_job_id ⇒ String

The AWS IoT job ID associated with the OTA update.

Returns:

• (String) —

  The AWS IoT job ID associated with the OTA update.

#aws_job_executions_rollout_config ⇒ Types::AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Returns:

• (Types::AwsJobExecutionsRolloutConfig) —

  Configuration for the rollout of OTA updates.

#aws_job_presigned_url_config ⇒ Types::AwsJobPresignedUrlConfig

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

Returns:

• (Types::AwsJobPresignedUrlConfig) —

  Configuration information for pre-signed URLs.

#creation_date ⇒ Time

The date when the OTA update was created.

Returns:

• (Time) —

  The date when the OTA update was created.

#description ⇒ String

A description of the OTA update.

Returns:

• (String) —

  A description of the OTA update.

#error_info ⇒ Types::ErrorInfo

Error information associated with the OTA update.

Returns:

• (Types::ErrorInfo) —

  Error information associated with the OTA update.

#last_modified_date ⇒ Time

The date when the OTA update was last updated.

Returns:

• (Time) —

  The date when the OTA update was last updated.

#ota_update_arn ⇒ String

The OTA update ARN.

Returns:

• (String) —

  The OTA update ARN.

#ota_update_files ⇒ Array<Types::OTAUpdateFile>

A list of files associated with the OTA update.

Returns:

• (Array<Types::OTAUpdateFile>) —

  A list of files associated with the OTA update.

#ota_update_id ⇒ String

The OTA update ID.

Returns:

• (String) —

  The OTA update ID.

#ota_update_status ⇒ String

The status of the OTA update.

Possible values:

• CREATE_PENDING
• CREATE_IN_PROGRESS
• CREATE_COMPLETE
• CREATE_FAILED

Returns:

• (String) —

  The status of the OTA update.

#protocols ⇒ Array<String>

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

Returns:

• (Array<String>) —

  The protocol used to transfer the OTA update image.

#target_selection ⇒ String

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.

Possible values:

• CONTINUOUS
• SNAPSHOT

Returns:

• (String) —

  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).

#targets ⇒ Array<String>

The targets of the OTA update.

Returns:

• (Array<String>) —

  The targets of the OTA update.