Skip to content

create_pipeline

create_pipeline(
    workspace_name: WorkspaceName,
    pipeline_name: ResourceName,
    computations: ComputeNodeList,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    description: Optional[Description] = None,
    environment_variables: Optional[EnvironmentVariablesMap] = None,
    tags: Optional[TagMap] = None,
    client_token: Optional[ClientToken] = None,
) -> CreatePipelineResponse

Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

Parameters:

  • workspace_name (WorkspaceName) –

    The name of the workspace.

  • pipeline_name (ResourceName) –

    The name of the pipeline to create. Must be unique within the workspace.

  • description (Optional[Description], default: None ) –

    A description of the pipeline.

  • environment_variables (Optional[EnvironmentVariablesMap], default: None ) –

    Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.

  • computations (ComputeNodeList) –

    The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

  • tags (Optional[TagMap], default: None ) –

    A list of key-value pairs that contain metadata for the pipeline. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

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.

  • LimitExceededException –

    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.

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

  • 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/io_t_site_wise.py
def create_pipeline(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName",
    computations: "capo_iotsitewise.types.compute_node_list.ComputeNodeList",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    description: Optional["capo_iotsitewise.types.description.Description"] = None,
    environment_variables: Optional[
        "capo_iotsitewise.types.environment_variables_map.EnvironmentVariablesMap"
    ] = None,
    tags: Optional["capo_iotsitewise.types.tag_map.TagMap"] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.create_pipeline_response.CreatePipelineResponse":
    """<p>Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.</p> <p>You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        pipeline_name: <p>The name of the pipeline to create. Must be unique within the workspace.</p>
        description: <p>A description of the pipeline.</p>
        environment_variables: <p>Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.</p>
        computations: <p>The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.</p>
        tags: <p>A list of key-value pairs that contain metadata for the pipeline. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your AWS IoT SiteWise resources</a> in the AWS IoT SiteWise User Guide.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.</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.create_pipeline_request.CreatePipelineRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.create_pipeline_response.CreatePipelineResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_pipeline

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

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

        return capo_iotsitewise.types.create_pipeline_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreatePipeline", redact_input=_redact_input),
    )
    input_: capo_iotsitewise.types.create_pipeline_request.CreatePipelineRequest = {
        "workspace_name": workspace_name,
        "pipeline_name": pipeline_name,
        "computations": computations,
    }
    if description is not None:
        input_["description"] = description
    if environment_variables is not None:
        input_["environment_variables"] = environment_variables
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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