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'
            }
        }
    },
    executionMountOverrides={
        'computeNodes': {
            'string': [
                {
                    'name': 'string',
                    'relativePath': 'string',
                    'source': {
                        's3AccessPoint': {
                            'accessPointArn': 'string',
                            'prefix': 'string'
                        }
                    },
                    'storageType': 'SHARED_STORAGE'
                },
            ]
        }
    },
    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

  • executionMountOverrides (dict) –

    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.

    • computeNodes (dict) – [REQUIRED]

      The mount overrides for each compute node, keyed by compute node name.

      • (string) –

        The compute node name from the pipeline definition.

        • (list) –

          The mount overrides applied to this compute node for this execution. Each entry is merged into the compute node’s task-defined mounts by mount name: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged.

          • (dict) –

            Attaches a data source to the container filesystem for a task at a customer-supplied relative path under the service-owned mount root.

            • name (string) – [REQUIRED]

              A unique name for the mount within the task.

            • relativePath (string) – [REQUIRED]

              The relative path under the service-owned mount root where this mount is attached inside the container.

            • source (dict) – [REQUIRED]

              The data source for the mount.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: s3AccessPoint.

              • s3AccessPoint (dict) –

                Configuration for a mount that reads from an Amazon S3 access point.

                • accessPointArn (string) – [REQUIRED]

                  The Amazon Resource Name (ARN) of the S3 access point.

                • prefix (string) –

                  An optional key prefix to scope the mount to a subset of objects at the access point.

            • storageType (string) – [REQUIRED]

              The type of storage used for the mount.

  • 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