How to customize a workflow's metadata
Customize a workflow’s name
Give your workflow a name with the name
parameter:
If you don’t provide a name, Prefect uses the flow function name.
Customize a workflow’s description
Give your workflow a description with the description
parameter:
If no description is provided, a flow function’s docstring is used as the description.
Customize run names
Give a custom name to each flow run for a flow with the flow_run_name
parameter:
Inputs to the flow function are available as variables in the flow_run_name
template string.
You can also provide a flow_run_name
as a function that returns a string:
Custom flow run names are applied at runtime
When a flow run is created via a schedule or the API, the flow_run_name
defined on the flow is not immediately applied. The name is updated when the flow begins running.