Skip to content

WorkflowExecutionInfo

Source code in docs_src/capo_swf/types/workflow_execution_info.py
class WorkflowExecutionInfo(TypedDict, closed=True):
    execution: "capo_swf.types.workflow_execution.WorkflowExecution"
    """<p>The workflow execution this information is about.</p>"""
    workflow_type: "capo_swf.types.workflow_type.WorkflowType"
    """<p>The type of the workflow execution.</p>"""
    start_timestamp: "capo_swf.types.timestamp.Timestamp"
    """<p>The time when the execution was started.</p>"""
    close_timestamp: NotRequired["capo_swf.types.timestamp.Timestamp"]
    """<p>The time when the workflow execution was closed. Set only if the execution status is CLOSED.</p>"""
    execution_status: "capo_swf.types.execution_status.ExecutionStatus"
    """<p>The current status of the execution.</p>"""
    close_status: NotRequired["capo_swf.types.close_status.CloseStatus"]
    """<p>If the execution status is closed then this specifies how the execution was closed:</p> <ul> <li> <p> <code>COMPLETED</code> – the execution was successfully completed.</p> </li> <li> <p> <code>CANCELED</code> – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.</p> </li> <li> <p> <code>TERMINATED</code> – the execution was force terminated.</p> </li> <li> <p> <code>FAILED</code> – the execution failed to complete.</p> </li> <li> <p> <code>TIMED_OUT</code> – the execution did not complete in the alloted time and was automatically timed out.</p> </li> <li> <p> <code>CONTINUED_AS_NEW</code> – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.</p> </li> </ul>"""
    parent: NotRequired["capo_swf.types.workflow_execution.WorkflowExecution"]
    """<p>If this workflow execution is a child of another execution then contains the workflow execution that started this execution.</p>"""
    tag_list: NotRequired["capo_swf.types.tag_list.TagList"]
    """<p>The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.</p>"""
    cancel_requested: "capo_swf.types.canceled.Canceled"
    """<p>Set to true if a cancellation is requested for this workflow execution.</p>"""

cancel_requested instance-attribute

cancel_requested: Canceled

Set to true if a cancellation is requested for this workflow execution.

close_status instance-attribute

close_status: NotRequired[CloseStatus]

If the execution status is closed then this specifies how the execution was closed:

  • COMPLETED – the execution was successfully completed.

  • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

  • TERMINATED – the execution was force terminated.

  • FAILED – the execution failed to complete.

  • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

  • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

close_timestamp instance-attribute

close_timestamp: NotRequired[Timestamp]

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

execution instance-attribute

execution: WorkflowExecution

The workflow execution this information is about.

execution_status instance-attribute

execution_status: ExecutionStatus

The current status of the execution.

parent instance-attribute

parent: NotRequired[WorkflowExecution]

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

start_timestamp instance-attribute

start_timestamp: Timestamp

The time when the execution was started.

tag_list instance-attribute

tag_list: NotRequired[TagList]

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

workflow_type instance-attribute

workflow_type: WorkflowType

The type of the workflow execution.