update_task `async` ¶

update_task(
    workspace_name: WorkspaceName,
    task_name: ResourceName,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    description: Optional[Description] = None,
    task_configuration: Optional[TaskConfiguration] = None,
) -> UpdateTaskResponse

Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace.
task_name (ResourceName) –

The name of the task to update.
description (Optional[Description], default: None ) –

A new description for the task.
task_configuration (Optional[TaskConfiguration], default: None ) –

The updated task execution configuration.

Raises:

AccessDeniedException –

Access is denied.
ConflictingOperationException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def update_task(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    task_name: "capo_iotsitewise.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    description: Optional["capo_iotsitewise.types.description.Description"] = None,
    task_configuration: Optional[
        "capo_iotsitewise.types.task_configuration.TaskConfiguration"
    ] = None,
) -> "capo_iotsitewise.types.update_task_response.UpdateTaskResponse":
    """<p>Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        task_name: <p>The name of the task to update.</p>
        description: <p>A new description for the task.</p>
        task_configuration: <p>The updated task execution configuration.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.update_task_request.UpdateTaskRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.update_task_response.UpdateTaskResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_task

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.update_task.async_update_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_iotsitewise.types.update_task_request.UpdateTaskRequest",
    ) -> dict[str, Any]:
        import capo_iotsitewise.types.update_task_request

        return capo_iotsitewise.types.update_task_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateTask", redact_input=_redact_input)
    )
    input_: capo_iotsitewise.types.update_task_request.UpdateTaskRequest = {
        "workspace_name": workspace_name,
        "task_name": task_name,
    }
    if description is not None:
        input_["description"] = description
    if task_configuration is not None:
        input_["task_configuration"] = task_configuration

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_task async ¶

update_task `async` ¶