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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about an OTA update.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_parametersHash<String,String>

A collection of name/value pairs

Returns:

  • (Hash<String,String>)

    A collection of name/value pairs.

#aws_iot_job_arnString

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_idString

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_configTypes::AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Returns:

#creation_dateTime

The date when the OTA update was created.

Returns:

  • (Time)

    The date when the OTA update was created.

#descriptionString

A description of the OTA update.

Returns:

  • (String)

    A description of the OTA update.

#error_infoTypes::ErrorInfo

Error information associated with the OTA update.

Returns:

#last_modified_dateTime

The date when the OTA update was last updated.

Returns:

  • (Time)

    The date when the OTA update was last updated.

#ota_update_arnString

The OTA update ARN.

Returns:

  • (String)

    The OTA update ARN.

#ota_update_filesArray<Types::OTAUpdateFile>

A list of files associated with the OTA update.

Returns:

#ota_update_idString

The OTA update ID.

Returns:

  • (String)

    The OTA update ID.

#ota_update_statusString

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.

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

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

#targetsArray<String>

The targets of the OTA update.

Returns:

  • (Array<String>)

    The targets of the OTA update.