Skip to content

WorkflowRun

Source code in docs_src/capo_glue/types/workflow_run.py
class WorkflowRun(TypedDict, closed=True):
    name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>Name of the workflow that was run.</p>"""
    workflow_run_id: NotRequired["capo_glue.types.id_string.IdString"]
    """<p>The ID of this workflow run.</p>"""
    previous_run_id: NotRequired["capo_glue.types.id_string.IdString"]
    """<p>The ID of the previous workflow run.</p>"""
    workflow_run_properties: NotRequired[
        "capo_glue.types.workflow_run_properties.WorkflowRunProperties"
    ]
    """<p>The workflow run properties which were set during the run.</p>"""
    started_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time when the workflow run was started.</p>"""
    completed_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time when the workflow run completed.</p>"""
    status: NotRequired["capo_glue.types.workflow_run_status.WorkflowRunStatus"]
    """<p>The status of the workflow run.</p>"""
    error_message: NotRequired["capo_glue.types.error_string.ErrorString"]
    """<p>This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: <code>foo</code>."</p>"""
    statistics: NotRequired[
        "capo_glue.types.workflow_run_statistics.WorkflowRunStatistics"
    ]
    """<p>The statistics of the run.</p>"""
    graph: NotRequired["capo_glue.types.workflow_graph.WorkflowGraph"]
    """<p>The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.</p>"""
    starting_event_batch_condition: NotRequired[
        "capo_glue.types.starting_event_batch_condition.StartingEventBatchCondition"
    ]
    """<p>The batch condition that started the workflow run.</p>"""

completed_on instance-attribute

completed_on: NotRequired[TimestampValue]

The date and time when the workflow run completed.

error_message instance-attribute

error_message: NotRequired[ErrorString]

This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

graph instance-attribute

graph: NotRequired[WorkflowGraph]

The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

name instance-attribute

name: NotRequired[NameString]

Name of the workflow that was run.

previous_run_id instance-attribute

previous_run_id: NotRequired[IdString]

The ID of the previous workflow run.

started_on instance-attribute

started_on: NotRequired[TimestampValue]

The date and time when the workflow run was started.

starting_event_batch_condition instance-attribute

starting_event_batch_condition: NotRequired[StartingEventBatchCondition]

The batch condition that started the workflow run.

statistics instance-attribute

statistics: NotRequired[WorkflowRunStatistics]

The statistics of the run.

status instance-attribute

status: NotRequired[WorkflowRunStatus]

The status of the workflow run.

workflow_run_id instance-attribute

workflow_run_id: NotRequired[IdString]

The ID of this workflow run.

workflow_run_properties instance-attribute

workflow_run_properties: NotRequired[WorkflowRunProperties]

The workflow run properties which were set during the run.