View on GitHub
CreateOTAUpdateRequest Structure Reference
CreateOTAUpdateRequest
public struct CreateOTAUpdateRequest : AWSShapeUndocumented
-
Declaration
Swift
public static var _members: [AWSShapeMember] -
A list of additional OTA update parameters which are name-value pairs.
Declaration
Swift
public let additionalParameters: [String : String]? -
The criteria that determine when and how a job abort takes place.
Declaration
Swift
public let awsJobAbortConfig: AwsJobAbortConfig? -
Configuration for the rollout of OTA updates.
Declaration
Swift
public let awsJobExecutionsRolloutConfig: AwsJobExecutionsRolloutConfig? -
Configuration information for pre-signed URLs.
Declaration
Swift
public let awsJobPresignedUrlConfig: AwsJobPresignedUrlConfig? -
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
Declaration
Swift
public let awsJobTimeoutConfig: AwsJobTimeoutConfig? -
The description of the OTA update.
Declaration
Swift
public let description: String? -
The files to be streamed by the OTA update.
Declaration
Swift
public let files: [OTAUpdateFile] -
The ID of the OTA update to be created.
Declaration
Swift
public let otaUpdateId: 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.
Declaration
Swift
public let protocols: [Protocol]? -
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
Declaration
Swift
public let roleArn: String -
Metadata which can be used to manage updates.
Declaration
Swift
public let tags: [Tag]? -
The devices targeted to receive OTA updates.
Declaration
Swift
public let targets: [String] -
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Declaration
Swift
public let targetSelection: TargetSelection? -
init(additionalParameters:awsJobAbortConfig:awsJobExecutionsRolloutConfig:awsJobPresignedUrlConfig:awsJobTimeoutConfig:description:files:otaUpdateId:protocols:roleArn:tags:targets:targetSelection:)Undocumented
Declaration
Swift
public init(additionalParameters: [String : String]? = nil, awsJobAbortConfig: AwsJobAbortConfig? = nil, awsJobExecutionsRolloutConfig: AwsJobExecutionsRolloutConfig? = nil, awsJobPresignedUrlConfig: AwsJobPresignedUrlConfig? = nil, awsJobTimeoutConfig: AwsJobTimeoutConfig? = nil, description: String? = nil, files: [OTAUpdateFile], otaUpdateId: String, protocols: [Protocol]? = nil, roleArn: String, tags: [Tag]? = nil, targets: [String], targetSelection: TargetSelection? = nil) -
Declaration
Swift
public func validate(name: String) throws