IoTSiteWise / Client / start_pipeline_execution

start_pipeline_execution

IoTSiteWise.Client.start_pipeline_execution(**kwargs)

Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.

See also: AWS API Documentation

Request Syntax

response = client.start_pipeline_execution(
    workspaceName='string',
    pipelineName='string',
    executionEnvironmentVariableOverrides={
        'global': {
            'string': 'string'
        },
        'computeNodes': {
            'string': {
                'string': 'string'
            }
        }
    },
    executionPriority=123,
    clientToken='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace containing the pipeline.

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline to execute.

  • executionEnvironmentVariableOverrides (dict) –

    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.

    • global (dict) –

      Global environment variables that apply to all compute nodes in the pipeline execution.

      • (string) –

        Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

        • (string) –

          Environment variable value

    • computeNodes (dict) –

      Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.

      • (string) –

        The compute node name from the pipeline definition.

        • (dict) –

          Environment variable overrides specific to this compute node.

          • (string) –

            Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

            • (string) –

              Environment variable value

  • executionPriority (integer) – Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

  • clientToken (string) –

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineExecutionId': 'string'
}

Response Structure

  • (dict) –

    Response structure for StartPipelineExecution operation.

    • pipelineExecutionId (string) –

      The unique identifier of the created pipeline execution.

Exceptions