CreateOTAUpdateRequest
¶
Source code in docs_src/capo_iot/types/create_ota_update_request.py
additional_parameters
instance-attribute
¶
additional_parameters: NotRequired[AdditionalParameterMap]
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
aws_job_abort_config
instance-attribute
¶
aws_job_abort_config: NotRequired[AwsJobAbortConfig]
The criteria that determine when and how a job abort takes place.
aws_job_executions_rollout_config
instance-attribute
¶
aws_job_executions_rollout_config: NotRequired[AwsJobExecutionsRolloutConfig]
Configuration for the rollout of OTA updates.
aws_job_presigned_url_config
instance-attribute
¶
aws_job_presigned_url_config: NotRequired[AwsJobPresignedUrlConfig]
Configuration information for pre-signed URLs.
aws_job_timeout_config
instance-attribute
¶
aws_job_timeout_config: NotRequired[AwsJobTimeoutConfig]
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.
description
instance-attribute
¶
description: NotRequired[OTAUpdateDescription]
The description of the OTA update.
ota_update_id
instance-attribute
¶
ota_update_id: OTAUpdateId
The ID of the OTA update to be created.
protocols
instance-attribute
¶
protocols: NotRequired[Protocols]
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.
role_arn
instance-attribute
¶
role_arn: RoleArn
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
target_selection
instance-attribute
¶
target_selection: NotRequired[TargetSelection]
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.