Allow setting a custom flow run name

Opened from the Prefect Public Slack Community

andreas.ntonas: Hi! In Prefect 2.0, when creating a flow_run for a deployment using https://orion-docs.prefect.io/api-ref/prefect/client/#prefect.client.OrionClient.create_flow_run_from_deployment|API’s prefect.client.create_flow_run_from_deployment() is it possible to set the name for the flow_run? I know that there is such an option when calling create_flow_run(name="My flow run name") that takes as input a flow_model, what about when creating a run from a deployment though?

anna: In theory, it is possible but we currently don’t expose any functionality to do that. Let me open an issue to check if we can expose that

<@ULVA73B9P> open “Allow setting custom flow run name when creating a flow run from a deployment”

Original thread can be found here.

[kevin868]

@abrookins I added the docs in #7109, since it wasn’t addressed in PR #7084 Hope it didn’t duplicate work you’ve started already. Cheers!

[abrookins]

We’re assessing these different use cases, but while we do, I’ll note that if you create a flow run from a deployment using create_flow_run_from_deployment(), if you pass a value for the name argument, we will use that to set a custom flow run name. I see that we should update the docstring on the method to make that clear, so we’ll get on that!

@anna-geller I’ve reached out to the user who originally asked this question in Slack to make sure they know about the parameter.