Skip to content

CreatePipelineRequest

Source code in docs_src/capo_iotsitewise/types/create_pipeline_request.py
class CreatePipelineRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace.</p>"""
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName"
    """<p>The name of the pipeline to create. Must be unique within the workspace.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>A description of the pipeline.</p>"""
    environment_variables: NotRequired[
        "capo_iotsitewise.types.environment_variables_map.EnvironmentVariablesMap"
    ]
    """<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: "capo_iotsitewise.types.compute_node_list.ComputeNodeList"
    """<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: NotRequired["capo_iotsitewise.types.tag_map.TagMap"]
    """<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: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<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>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

computations instance-attribute

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.

description instance-attribute

description: NotRequired[Description]

A description of the pipeline.

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariablesMap]

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

pipeline_name instance-attribute

pipeline_name: ResourceName

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

tags instance-attribute

tags: NotRequired[TagMap]

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.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace.