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
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 | |