update_ota_task ¶

update_ota_task(
    identifier: OtaTaskId,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[OtaDescription] = None,
    task_configuration_id: Optional[OtaTaskConfigurationId] = None,
) -> None

Update an over-the-air (OTA) task.

Parameters:

identifier (OtaTaskId) –

The over-the-air (OTA) task id.
description (Optional[OtaDescription], default: None ) –

The description of the over-the-air (OTA) task.
task_configuration_id (Optional[OtaTaskConfigurationId], default: None ) –

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

Raises:

AccessDeniedException –

User is not authorized.
InternalServerException –

Internal error from the service that indicates an unexpected error or that the service is unavailable.
ResourceNotFoundException –

The specified resource does not exist.
ThrottlingException –

The rate exceeds the limit.
ValidationException –

A validation error occurred when performing the API request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py

def update_ota_task(
    self,
    identifier: "capo_iot_managed_integrations.types.ota_task_id.OtaTaskId",
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[
        "capo_iot_managed_integrations.types.ota_description.OtaDescription"
    ] = None,
    task_configuration_id: Optional[
        "capo_iot_managed_integrations.types.ota_task_configuration_id.OtaTaskConfigurationId"
    ] = None,
) -> None:
    """<p>Update an over-the-air (OTA) task.</p>

    Args:
        identifier: <p>The over-the-air (OTA) task id.</p>
        description: <p>The description of the over-the-air (OTA) task.</p>
        task_configuration_id: <p>The identifier for the over-the-air (OTA) task configuration.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.update_ota_task_request.UpdateOtaTaskRequest]",
    ) -> OperationResponse[None]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.update_ota_task

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.update_ota_task.update_ota_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateOtaTask")
    )
    input_: capo_iot_managed_integrations.types.update_ota_task_request.UpdateOtaTaskRequest = {
        "identifier": identifier
    }
    if description is not None:
        input_["description"] = description
    if task_configuration_id is not None:
        input_["task_configuration_id"] = task_configuration_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output