trigger_pipeline
Execute a ZenML pipeline run by specifying the pipeline name or ID, with options to select a specific snapshot or override the stack configuration.
Instructions
Trigger a pipeline to run from the server.
Args:
pipeline_name_or_id: The name or ID of the pipeline to trigger
snapshot_name_or_id: The name or ID of a specific snapshot to run (preferred)
stack_name_or_id: Optional stack override for the run
template_id: ⚠️ DEPRECATED - Use `snapshot_name_or_id` instead.
The ID of a run template to use. Run Templates are deprecated
and will be removed in a future version.
Usage examples:
* Run the latest runnable snapshot for a pipeline:
```python
trigger_pipeline(pipeline_name_or_id=<NAME>)
```
* Run the latest runnable snapshot for a pipeline on a specific stack:
```python
trigger_pipeline(
pipeline_name_or_id=<NAME>,
stack_name_or_id=<STACK_NAME_OR_ID>
)
```
* Run a specific snapshot (RECOMMENDED):
```python
trigger_pipeline(
pipeline_name_or_id=<NAME>,
snapshot_name_or_id=<SNAPSHOT_NAME_OR_ID>
)
```
* Run a specific template (DEPRECATED - use snapshot_name_or_id instead):
```python
trigger_pipeline(pipeline_name_or_id=<NAME>, template_id=<ID>)
```Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline_name_or_id | Yes | ||
| snapshot_name_or_id | No | ||
| stack_name_or_id | No | ||
| template_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |