iot/aws.sdk.kotlin.services.iot.model/OtaUpdateInfo

OtaUpdateInfo

class OtaUpdateInfo

Information about an OTA update.

Types

object Companion

Properties

additionalParameters

val additionalParameters: Map<String, String>?

A collection of name/value pairs

val awsIotJobArn: String?

The IoT job ARN associated with the OTA update.

val awsIotJobId: String?

The IoT job ID associated with the OTA update.

awsJobExecutionsRolloutConfig

val awsJobExecutionsRolloutConfig: AwsJobExecutionsRolloutConfig?

Configuration for the rollout of OTA updates.

awsJobPresignedUrlConfig

val awsJobPresignedUrlConfig: AwsJobPresignedUrlConfig?

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

val creationDate: Instant?

The date when the OTA update was created.

val description: String?

A description of the OTA update.

val errorInfo: ErrorInfo?

Error information associated with the OTA update.

lastModifiedDate

val lastModifiedDate: Instant?

The date when the OTA update was last updated.

val otaUpdateArn: String?

The OTA update ARN.

val otaUpdateFiles: List<OtaUpdateFile>?

A list of files associated with the OTA update.

val otaUpdateId: String?

The OTA update ID.

otaUpdateStatus

val otaUpdateStatus: OtaUpdateStatus?

The status of the OTA update.

val protocols: List<Protocol>?

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.

val targets: List<String>?

The targets of the OTA update.

targetSelection

val targetSelection: 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.

Functions

inline fun copy(block: OtaUpdateInfo.Builder.() -> Unit = {}): OtaUpdateInfo

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String