update_pipeline ¶

def update_pipeline(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    description: Optional["capo_iotsitewise.types.description.Description"] = None,
    environment_variables: Optional[
        "capo_iotsitewise.types.environment_variables_map.EnvironmentVariablesMap"
    ] = None,
    computations: Optional[
        "capo_iotsitewise.types.compute_node_list.ComputeNodeList"
    ] = None,
) -> "capo_iotsitewise.types.update_pipeline_response.UpdatePipelineResponse":
    """<p>Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        pipeline_name: <p>The name of the pipeline to update.</p>
        description: <p>A new description for the pipeline.</p>
        environment_variables: <p>Updated environment variables shared across all compute nodes.</p>
        computations: <p>Updated list of compute nodes forming the pipeline DAG.</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.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.update_pipeline_request.UpdatePipelineRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.update_pipeline_response.UpdatePipelineResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_pipeline

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.update_pipeline.update_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_iotsitewise.types.update_pipeline_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdatePipeline", redact_input=_redact_input),
    )
    input_: capo_iotsitewise.types.update_pipeline_request.UpdatePipelineRequest = {
        "workspace_name": workspace_name,
        "pipeline_name": pipeline_name,
    }
    if description is not None:
        input_["description"] = description
    if environment_variables is not None:
        input_["environment_variables"] = environment_variables
    if computations is not None:
        input_["computations"] = computations

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