Skip to content

CreateOtaTaskRequest

Source code in docs_src/capo_iot_managed_integrations/types/create_ota_task_request.py
class CreateOtaTaskRequest(TypedDict, closed=True):
    description: NotRequired[
        "capo_iot_managed_integrations.types.ota_description.OtaDescription"
    ]
    """<p>The description of the over-the-air (OTA) task.</p>"""
    s3_url: "capo_iot_managed_integrations.types.s3_url.S3Url"
    """<p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>"""
    protocol: NotRequired[
        "capo_iot_managed_integrations.types.ota_protocol.OtaProtocol"
    ]
    """<p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>"""
    target: NotRequired["capo_iot_managed_integrations.types.target.Target"]
    """<p>The device targeted for the over-the-air (OTA) task.</p>"""
    task_configuration_id: NotRequired[
        "capo_iot_managed_integrations.types.ota_task_configuration_id.OtaTaskConfigurationId"
    ]
    """<p>The identifier for the over-the-air (OTA) task configuration.</p>"""
    ota_mechanism: NotRequired[
        "capo_iot_managed_integrations.types.ota_mechanism.OtaMechanism"
    ]
    """<p>The deployment mechanism for the over-the-air (OTA) task.</p>"""
    ota_type: "capo_iot_managed_integrations.types.ota_type.OtaType"
    """<p>The frequency type for the over-the-air (OTA) task.</p>"""
    ota_target_query_string: NotRequired[
        "capo_iot_managed_integrations.types.ota_target_query_string.OtaTargetQueryString"
    ]
    """<p>The query string to add things to the thing group.</p>"""
    client_token: NotRequired[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ]
    """<p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>"""
    ota_scheduling_config: NotRequired[
        "capo_iot_managed_integrations.types.ota_task_scheduling_config.OtaTaskSchedulingConfig"
    ]
    ota_task_execution_retry_config: NotRequired[
        "capo_iot_managed_integrations.types.ota_task_execution_retry_config.OtaTaskExecutionRetryConfig"
    ]
    tags: NotRequired["capo_iot_managed_integrations.types.tags_map.TagsMap"]
    """<p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

description instance-attribute

description: NotRequired[OtaDescription]

The description of the over-the-air (OTA) task.

ota_mechanism instance-attribute

ota_mechanism: NotRequired[OtaMechanism]

The deployment mechanism for the over-the-air (OTA) task.

ota_scheduling_config instance-attribute

ota_scheduling_config: NotRequired[OtaTaskSchedulingConfig]

ota_target_query_string instance-attribute

ota_target_query_string: NotRequired[OtaTargetQueryString]

The query string to add things to the thing group.

ota_task_execution_retry_config instance-attribute

ota_task_execution_retry_config: NotRequired[OtaTaskExecutionRetryConfig]

ota_type instance-attribute

ota_type: OtaType

The frequency type for the over-the-air (OTA) task.

protocol instance-attribute

protocol: NotRequired[OtaProtocol]

The connection protocol the over-the-air (OTA) task uses to update the device.

s3_url instance-attribute

s3_url: S3Url

The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

tags instance-attribute

tags: NotRequired[TagsMap]

A set of key/value pairs that are used to manage the over-the-air (OTA) task.

target instance-attribute

target: NotRequired[Target]

The device targeted for the over-the-air (OTA) task.

task_configuration_id instance-attribute

task_configuration_id: NotRequired[OtaTaskConfigurationId]

The identifier for the over-the-air (OTA) task configuration.