AWS IoT
API Reference

OTAUpdateInfo

Information about an OTA update.

Contents

additionalParameters

A collection of name/value pairs

Type: String to string map

Required: No

awsIotJobArn

The AWS IoT job ARN associated with the OTA update.

Type: String

Required: No

awsIotJobId

The AWS IoT job ID associated with the OTA update.

Type: String

Required: No

awsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Type: AwsJobExecutionsRolloutConfig object

Required: No

creationDate

The date when the OTA update was created.

Type: Timestamp

Required: No

description

A description of the OTA update.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

Required: No

errorInfo

Error information associated with the OTA update.

Type: ErrorInfo object

Required: No

lastModifiedDate

The date when the OTA update was last updated.

Type: Timestamp

Required: No

otaUpdateArn

The OTA update ARN.

Type: String

Required: No

otaUpdateFiles

A list of files associated with the OTA update.

Type: Array of OTAUpdateFile objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

otaUpdateId

The OTA update ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_-]+

Required: No

otaUpdateStatus

The status of the OTA update.

Type: String

Valid Values: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED

Required: No

targets

The targets of the OTA update.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: No

targetSelection

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.

Type: String

Valid Values: CONTINUOUS | SNAPSHOT

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: