prefect.deployments.flow_runs
Functions
run_deployment
timeout=0
.
Note that if you specify a timeout, this function will return the flow run
metadata whether or not the flow run finished executing.
If called within a flow or task, the flow run this function creates will
be linked to the current flow run as a subflow. Disable this behavior by
passing as_subflow=False
.
Args:
name
: The deployment id or deployment name in the form:"flow name/deployment name"
parameters
: Parameter overrides for this flow run. Merged with the deployment defaults.scheduled_time
: The time to schedule the flow run for, defaults to scheduling the flow run to start now.flow_run_name
: A name for the created flow runtimeout
: The amount of time to wait (in seconds) for the flow run to complete before returning. Settingtimeout
to 0 will return the flow run metadata immediately. Settingtimeout
to None will allow this function to poll indefinitely. Defaults to None.poll_interval
: The number of seconds between pollstags
: A list of tags to associate with this flow run; tags can be used in automations and for organizational purposes.idempotency_key
: A unique value to recognize retries of the same run, and prevent creating multiple flow runs.work_queue_name
: The name of a work queue to use for this run. Defaults to the default work queue for the deployment.as_subflow
: Whether to link the flow run as a subflow of the current flow or task run.job_variables
: A dictionary of dot delimited infrastructure overrides that will be applied at runtime; for exampleenv.CONFIG_KEY=config_value
ornamespace='prefect'