Skip to content

StartPipelineExecutionRequest

Source code in docs_src/capo_iotsitewise/types/start_pipeline_execution_request.py
class StartPipelineExecutionRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace containing the pipeline.</p>"""
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName"
    """<p>The name of the pipeline to execute.</p>"""
    execution_environment_variable_overrides: NotRequired[
        "capo_iotsitewise.types.execution_environment_variables.ExecutionEnvironmentVariables"
    ]
    """<p>Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.</p>"""
    execution_mount_overrides: NotRequired[
        "capo_iotsitewise.types.mount_overrides.MountOverrides"
    ]
    """<p>Runtime mount overrides for the execution. Overrides are merged by mount name into each listed compute node's task-defined mounts: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged. Compute nodes not listed use their task-defined mounts as-is.</p>"""
    execution_priority: NotRequired[
        "capo_iotsitewise.types.execution_priority.ExecutionPriority"
    ]
    """<p>Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.</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.

execution_environment_variable_overrides instance-attribute

execution_environment_variable_overrides: NotRequired[ExecutionEnvironmentVariables]

Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

execution_mount_overrides instance-attribute

execution_mount_overrides: NotRequired[MountOverrides]

Runtime mount overrides for the execution. Overrides are merged by mount name into each listed compute node's task-defined mounts: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged. Compute nodes not listed use their task-defined mounts as-is.

execution_priority instance-attribute

execution_priority: NotRequired[ExecutionPriority]

Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

pipeline_name instance-attribute

pipeline_name: ResourceName

The name of the pipeline to execute.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace containing the pipeline.