Skip to main content

Workflow Handles

A workflow handle represents the state of a particular active or completed workflow execution. You obtain a workflow handle when using DBOS.start_workflow to start a workflow in the background. If you know a workflow's identity, you can also retrieve its handle using DBOS.retrieve_workflow.

Methods​

get_workflow_id​

handle.get_workflow_id() -> str

Retrieve the identity of the workflow.

get_result​

handle.get_result() -> R

Wait for the workflow to complete, then return its result.

get_status​

handle.get_status() -> WorkflowStatus

Retrieve the workflow's status. This is the following object:

class WorkflowStatus:
    workflow_id: str # The workflow's ID
    status: str # The workflow's current state. One of PENDING, SUCCESS, ERROR, RETRIES_EXCEEDED, or CANCELLED
    name: str # The fully qualified name of the workflow function
    class_name: Optional[str] # If the workflow function is a class method, the name of the class
    config_name: Optional[str] # If the workflow function is a method of a configured class, the name of the class configuration
    authenticated_user: Optional[str] # The authenticated user running the workflow
    assumed_role: Optional[str] # The role with which the workflow is run
    authenticatedRoles: Optional[List[str]] # All roles which the authenticated user could assume