trigger_pipeline
Trigger a pipeline run in ZenML by providing a pipeline name, snapshot, or stack override. Start the latest or a specific snapshot execution.
Instructions
Trigger a pipeline to run from the server.
Args:
pipeline_name_or_id: Optional name or ID of the pipeline to trigger. A
snapshot or template can be triggered without it.
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 template-based trigger parameter. Use
`snapshot_name_or_id` for new integrations. ZenML 0.96.4 still
retains run-template CRUD APIs.
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(
snapshot_name_or_id=<SNAPSHOT_NAME_OR_ID>
)
```
* Run a specific template (DEPRECATED - use snapshot_name_or_id instead):
```python
trigger_pipeline(template_id=<ID>)
```
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| template_id | No | ||
| stack_name_or_id | No | ||
| pipeline_name_or_id | No | ||
| snapshot_name_or_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||