set_flow_run_state
Update the execution status of a Prefect workflow run by setting its state to values like SCHEDULED, RUNNING, COMPLETED, or FAILED with an optional message.
Instructions
Set a flow run's state.
Args: flow_run_id: The flow run UUID state: The new state to set (e.g., "SCHEDULED", "RUNNING", "COMPLETED", "FAILED") message: An optional message explaining the state change
Returns: Result of the state change operation
Input Schema
Name | Required | Description | Default |
---|---|---|---|
flow_run_id | Yes | ||
message | No | ||
state | Yes |
Input Schema (JSON Schema)
{
"properties": {
"flow_run_id": {
"title": "Flow Run Id",
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"flow_run_id",
"state"
],
"type": "object"
}