Skip to content

OTAUpdateInfo

Source code in docs_src/capo_iot/types/ota_update_info.py
class OTAUpdateInfo(TypedDict, closed=True):
    ota_update_id: NotRequired["capo_iot.types.ota_update_id.OTAUpdateId"]
    """<p>The OTA update ID.</p>"""
    ota_update_arn: NotRequired["capo_iot.types.ota_update_arn.OTAUpdateArn"]
    """<p>The OTA update ARN.</p>"""
    creation_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The date when the OTA update was created.</p>"""
    last_modified_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The date when the OTA update was last updated.</p>"""
    description: NotRequired[
        "capo_iot.types.ota_update_description.OTAUpdateDescription"
    ]
    """<p>A description of the OTA update.</p>"""
    targets: NotRequired["capo_iot.types.targets.Targets"]
    """<p>The targets of the OTA update.</p>"""
    protocols: NotRequired["capo_iot.types.protocols.Protocols"]
    """<p>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.</p>"""
    aws_job_executions_rollout_config: NotRequired[
        "capo_iot.types.aws_job_executions_rollout_config.AwsJobExecutionsRolloutConfig"
    ]
    """<p>Configuration for the rollout of OTA updates.</p>"""
    aws_job_presigned_url_config: NotRequired[
        "capo_iot.types.aws_job_presigned_url_config.AwsJobPresignedUrlConfig"
    ]
    """<p>Configuration information for pre-signed URLs. Valid when <code>protocols</code> contains HTTP.</p>"""
    target_selection: NotRequired["capo_iot.types.target_selection.TargetSelection"]
    """<p>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. </p>"""
    ota_update_files: NotRequired["capo_iot.types.ota_update_files.OTAUpdateFiles"]
    """<p>A list of files associated with the OTA update.</p>"""
    ota_update_status: NotRequired["capo_iot.types.ota_update_status.OTAUpdateStatus"]
    """<p>The status of the OTA update.</p>"""
    aws_iot_job_id: NotRequired["capo_iot.types.aws_iot_job_id.AwsIotJobId"]
    """<p>The IoT job ID associated with the OTA update.</p>"""
    aws_iot_job_arn: NotRequired["capo_iot.types.aws_iot_job_arn.AwsIotJobArn"]
    """<p>The IoT job ARN associated with the OTA update.</p>"""
    error_info: NotRequired["capo_iot.types.error_info.ErrorInfo"]
    """<p>Error information associated with the OTA update.</p>"""
    additional_parameters: NotRequired[
        "capo_iot.types.additional_parameter_map.AdditionalParameterMap"
    ]
    """<p>A collection of name/value pairs</p>"""

additional_parameters instance-attribute

additional_parameters: NotRequired[AdditionalParameterMap]

A collection of name/value pairs

aws_iot_job_arn instance-attribute

aws_iot_job_arn: NotRequired[AwsIotJobArn]

The IoT job ARN associated with the OTA update.

aws_iot_job_id instance-attribute

aws_iot_job_id: NotRequired[AwsIotJobId]

The IoT job ID associated with the OTA update.

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. Valid when protocols contains HTTP.

creation_date instance-attribute

creation_date: NotRequired[DateType]

The date when the OTA update was created.

description instance-attribute

description: NotRequired[OTAUpdateDescription]

A description of the OTA update.

error_info instance-attribute

error_info: NotRequired[ErrorInfo]

Error information associated with the OTA update.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateType]

The date when the OTA update was last updated.

ota_update_arn instance-attribute

ota_update_arn: NotRequired[OTAUpdateArn]

The OTA update ARN.

ota_update_files instance-attribute

ota_update_files: NotRequired[OTAUpdateFiles]

A list of files associated with the OTA update.

ota_update_id instance-attribute

ota_update_id: NotRequired[OTAUpdateId]

The OTA update ID.

ota_update_status instance-attribute

ota_update_status: NotRequired[OTAUpdateStatus]

The status of the OTA update.

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.

target_selection instance-attribute

target_selection: NotRequired[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.

targets instance-attribute

targets: NotRequired[Targets]

The targets of the OTA update.