Flow Run

Description

triggers a Flow Run using this endpoint

Use Cases

We recommend creating a Flow Run Task for every "flow" within Prefect Cloud.

This way, you can use Orchestra to trigger your Python nested in Prefect, rather than use Prefect Cloud's in-built scheduler (and orchestration), which allows Orchestra to be the single pane of glass for assessing your data pipelines.

• You can co-ordinate tasks outside of Prefect Cloud, like ingestion tools (for operations that move data to your data warehouse) or reverse ELT tools (for moving data outside of the warehouse)

• You can use Orchestra to trigger jobs in dbt after ingesting data using Prefect Cloud

• Run a dbt Job, use Prefect to run some python (for IP address enriching) and then run another dbt job

• When Prefect Cloud jobs run, Data Warehouse cost is incurred (when writing directly to the warehouse). Running these operations on a schedule you set explicitly ensures these costs do not go out of hand

• Leverage Prefect for executing python and retain Orchestra as the metadata and orchestration framework

Parameters

Name	Data type	Restrictions	Example
Deployment ID	ID	GUID	daf4069c-9404-460b-a785-************

Setup guide

Head to the 'Deployments' page, and select the deployment you want to run.

In the top right corner click the 3 dots to copy the deployment ID. See image below:

NOTE: Orchestra does not support cancelling Prefect Cloud flow runs. Please get in touch to talk about this feature

Error handling

API Requests

Orchestra will fail the Task if the response code isn't a 2xx code.

Code	Description	Handling
401	Unauthorised	We will raise an error and parse the raw error message from the Prefect Cloud response as the Orchestra message
404	Not Found	We will raise an error with the HTTP Reason as the Orchestra message
Other error code		We will raise an error with the HTTP Reason as the Orchestra message