History¶

SWF workflow execution history parsing.

`ActivityTaskCancelRequestedEvent`	Activity task cancellated requested workflow execution history event.
`ActivityTaskCancelledEvent`	Activity task cancelled workflow execution history event.
`ActivityTaskCompletedEvent`	Activity task completed workflow execution history event.
`ActivityTaskFailedEvent`	Activity task failed workflow execution history event.
`ActivityTaskScheduledEvent`	Activity task scheduled workflow execution history event.
`ActivityTaskStartedEvent`	Activity task started workflow execution history event.
`ActivityTaskTimedOutEvent`	Activity task timed-out workflow execution history event.
`CancelExecutionFailureCause`	Cancel workflow execution decision failure cause.
`CancelTaskFailureCause`	Cancel activity task decision failure cause.
`CancelTimerFailedEvent`	Timer cancellation failed workflow execution history event.
`CancelTimerFailureCause`	Cancel timer decision failure cause.
`CancelWorkflowExecutionFailedEvent`	Workflow execution cancellation failed workflow execution history event.
`ChildWorkflowExecutionCancelledEvent`	Child workflow execution cancelled workflow execution history event.
`ChildWorkflowExecutionCompletedEvent`	Child workflow execution completed workflow execution history event.
`ChildWorkflowExecutionFailedEvent`	Child workflow execution failed workflow execution history event.
`ChildWorkflowExecutionStartedEvent`	Child workflow execution started workflow execution history event.
`ChildWorkflowExecutionTerminatedEvent`	Child workflow execution terminated workflow execution history event.
`ChildWorkflowExecutionTimedOutEvent`	Child workflow execution timed-out workflow execution history event.
`CompleteWorkflowExecutionFailedEvent`	Workflow execution completion failed workflow execution history event.
`ContinueAsNewWorkflowExecutionFailedEvent`	Workflow execution continue-as-new failed workflow execution history event.
`DecisionFailureCause`	Generic decision failure cause.
`DecisionTaskCompletedEvent`	Decision task completed workflow execution history event.
`DecisionTaskScheduledEvent`	Decision task scheduled workflow execution history event.
`DecisionTaskStartedEvent`	Decision task started workflow execution history event.
`DecisionTaskTimedOutEvent`	Decision task timed-out workflow execution history event.
`Event`	Workflow execution history event.
`ExecutionTerminationCause`	Workflow execution termination cause.
`ExternalWorkflowExecutionCancelRequestedEvent`	External workflow execution cancellation requested workflow execution history event.
`ExternalWorkflowExecutionSignaledEvent`	External workflow execution signaled workflow execution history event.
`FailWorkflowExecutionFailedEvent`	Workflow execution failure failed workflow execution history event.
`MarkerRecordedEvent`	Marker recorded workflow execution history event.
`RecordMarkerFailedEvent`	Marker recording failed workflow execution history event.
`RequestCancelActivityTaskFailedEvent`	Activity task cancellation request failed workflow execution history event.
`RequestCancelExternalWorkflowExecutionFailedEvent`	External workflow execution cancellation request failed workflow execution history event.
`RequestCancelExternalWorkflowExecutionInitiatedEvent`	External workflow execution cancellation request initiation workflow execution history event.
`ScheduleActivityTaskFailedEvent`	Activity task scheduling failed workflow execution history event.
`ScheduleLambdaFailureCause`	Schedule Lambda function invocation decision failure cause.
`ScheduleTaskFailureCause`	Schedule activity task decision failure cause.
`SignalExternalWorkflowExecutionFailedEvent`	External workflow execution signalling failed workflow execution history event.
`SignalExternalWorkflowExecutionInitiatedEvent`	External workflow execution signalling initiated workflow execution history event.
`SignalFailureCause`	Signal workflow execution decision failure cause.
`StartActivityTaskFailedEvent`	Activity task starting failed workflow execution history event.
`StartChildExecutionFailureCause`	Start child workflow execution decision failure cause.
`StartChildWorkflowExecutionFailedEvent`	Child workflow execution starting failed workflow execution history event.
`StartChildWorkflowExecutionInitiatedEvent`	Child workflow execution starting initiated workflow execution history event.
`StartLambdaFailureCause`	Lambda function invocation failure cause.
`StartTimerFailedEvent`	Timer starting failed workflow execution history event.
`StartTimerFailureCause`	Start timer decision failure cause.
`TimeoutType`	Task/execution timeout type.
`TimerCancelledEvent`	Timer cancelled workflow execution history event.
`TimerFiredEvent`	Timer fired workflow execution history event.
`TimerStartedEvent`	Timer started workflow execution history event.
`WorkflowExecutionCancelRequestedEvent`	Workflow execution cancellation requested workflow execution history event.
`WorkflowExecutionCancelledEvent`	Workflow execution cancelled workflow execution history event.
`WorkflowExecutionCompletedEvent`	Workflow execution completed workflow execution history event.
`WorkflowExecutionContinuedAsNewEvent`	Workflow execution continued as new workflow execution history event.
`WorkflowExecutionFailedEvent`	Workflow execution failed workflow execution history event.
`WorkflowExecutionSignaledEvent`	Workflow execution signaled workflow execution history event.
`WorkflowExecutionStartedEvent`	Workflow execution started workflow execution history event.
`WorkflowExecutionTerminatedEvent`	Workflow execution terminated workflow execution history event.
`WorkflowExecutionTimedOutEvent`	Workflow execution timed-out workflow execution history event.
`get_execution_history`	Get workflow execution history; retrieved semi-lazily.
`get_last_execution_history_event`	Get last workflow execution history event.

class swf_typed.ActivityTaskCancelRequestedEvent(id: int, occured: datetime, task_id: str, decision_event_id: int)[source]¶

Activity task cancellated requested workflow execution history event.

decision_event_id: int¶: Task cancellation decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_id: str¶: ID of task whose cancellation was requested.

type: ClassVar[str] = 'ActivityTaskCancelRequested'¶: Event type.

class swf_typed.ActivityTaskCancelledEvent(id: int, occured: datetime, task_scheduled_event_id: int, task_started_event_id: int, task_cancel_requested_event_id: int = None, details: str = None)[source]¶

Activity task cancelled workflow execution history event.

details: str = None¶: Cancellation details, usually for explanation.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_cancel_requested_event_id: int = None¶: Task cancellation request event ID.

task_scheduled_event_id: int¶: Task schedule event ID.

task_started_event_id: int¶: Task start event ID.

type: ClassVar[str] = 'ActivityTaskCanceled'¶: Event type.

class swf_typed.ActivityTaskCompletedEvent(id: int, occured: datetime, task_scheduled_event_id: int, task_started_event_id: int, task_result: str = None)[source]¶

Activity task completed workflow execution history event.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_result: str = None¶: Task result.

task_scheduled_event_id: int¶: Task schedule event ID.

task_started_event_id: int¶: Task start event ID.

type: ClassVar[str] = 'ActivityTaskCompleted'¶: Event type.

class swf_typed.ActivityTaskFailedEvent(id: int, occured: datetime, task_scheduled_event_id: int, task_started_event_id: int, reason: str = None, details: str = None)[source]¶

Activity task failed workflow execution history event.

details: str = None¶: Failure details, usually for explanation.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

reason: str = None¶: Failure reason, usually for classification.

task_scheduled_event_id: int¶: Task schedule event ID.

task_started_event_id: int¶: Task start event ID.

type: ClassVar[str] = 'ActivityTaskFailed'¶: Event type.

class swf_typed.ActivityTaskScheduledEvent(id: int, occured: datetime, task_id: str, activity: _activities.ActivityId, task_configuration: _tasks.PartialTaskConfiguration, decision_event_id: int, task_input: str = None, control: str = None)[source]¶

Activity task scheduled workflow execution history event.

activity: _activities.ActivityId¶: Task activity type.

control: str = None¶: Message from task scheduling decider.

decision_event_id: int¶: Task schedule decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

task_configuration: _tasks.PartialTaskConfiguration¶: Task configuration (task-list guaranteed).

task_id: str¶: Scheduled task ID.

task_input: str = None¶: Task input.

type: ClassVar[str] = 'ActivityTaskScheduled'¶: Event type.

class swf_typed.ActivityTaskStartedEvent(id: int, occured: datetime, task_scheduled_event_id: int, worker_identity: str = None)[source]¶

Activity task started workflow execution history event.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_scheduled_event_id: int¶: Task schedule event ID.

type: ClassVar[str] = 'ActivityTaskStarted'¶: Event type.

worker_identity: str = None¶: Identity of worker which acquired task.

class swf_typed.ActivityTaskTimedOutEvent(id: int, occured: datetime, timeout_type: TimeoutType, task_scheduled_event_id: int, task_started_event_id: int, details: str = None)[source]¶

Activity task timed-out workflow execution history event.

details: str = None¶: Most recent progress message from worker (see send_heartbeat).

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_scheduled_event_id: int¶: Task schedule event ID.

task_started_event_id: int¶: Task start event ID.

timeout_type: TimeoutType¶: Task timeout type.

type: ClassVar[str] = 'ActivityTaskTimedOut'¶: Event type.

class swf_typed.CancelExecutionFailureCause(*values)[source]¶

Cancel workflow execution decision failure cause.

rate_exceeded = 'REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'¶

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_execution = 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'¶

class swf_typed.CancelTaskFailureCause(*values)[source]¶

Cancel activity task decision failure cause.

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_task = 'ACTIVITY_ID_UNKNOWN'¶

class swf_typed.CancelTimerFailedEvent(id: int, occured: datetime, timer_id: str, cause: CancelTimerFailureCause, decision_event_id: int)[source]¶

Timer cancellation failed workflow execution history event.

cause: CancelTimerFailureCause¶: Failure cause.

decision_event_id: int¶: Timer cancellation decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

timer_id: str¶: ID of timer whose cancellation failed.

type: ClassVar[str] = 'CancelTimerFailed'¶: Event type.

class swf_typed.CancelTimerFailureCause(*values)[source]¶

Cancel timer decision failure cause.

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_timer = 'TIMER_ID_UNKNOWN'¶

class swf_typed.CancelWorkflowExecutionFailedEvent(id: int, occured: datetime, cause: DecisionFailureCause, decision_event_id: int)[source]¶

Workflow execution cancellation failed workflow execution history event.

cause: DecisionFailureCause¶: Failure cause.

decision_event_id: int¶: Execution cancellation decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'CancelWorkflowExecutionFailed'¶: Event type.

class swf_typed.ChildWorkflowExecutionCancelledEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int, execution_started_event_id: int, details: str = None)[source]¶

Child workflow execution cancelled workflow execution history event.

details: str = None¶: Cancellation details, usually for explanation.

execution: _executions.ExecutionId¶: Cancelled execution.

execution_started_event_id: int¶: Child execution start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ChildWorkflowExecutionCanceled'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.ChildWorkflowExecutionCompletedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int, execution_started_event_id: int, execution_result: str = None)[source]¶

Child workflow execution completed workflow execution history event.

execution: _executions.ExecutionId¶: Completed execution.

execution_result: str = None¶: Child execution result.

execution_started_event_id: int¶: Child execution start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ChildWorkflowExecutionCompleted'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.ChildWorkflowExecutionFailedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int, execution_started_event_id: int, reason: str = None, details: str = None)[source]¶

Child workflow execution failed workflow execution history event.

details: str = None¶: Failure details, usually for explanation.

execution: _executions.ExecutionId¶: Failed execution.

execution_started_event_id: int¶: Child execution start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

reason: str = None¶: Failure reason, usually for classification.

type: ClassVar[str] = 'ChildWorkflowExecutionFailed'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.ChildWorkflowExecutionStartedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int)[source]¶

Child workflow execution started workflow execution history event.

execution: _executions.ExecutionId¶: Started execution.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ChildWorkflowExecutionStarted'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.ChildWorkflowExecutionTerminatedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int, execution_started_event_id: int)[source]¶

Child workflow execution terminated workflow execution history event.

execution: _executions.ExecutionId¶: Terminated execution.

execution_started_event_id: int¶: Child execution start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ChildWorkflowExecutionTerminated'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.ChildWorkflowExecutionTimedOutEvent(id: int, occured: datetime, execution: _executions.ExecutionId, workflow: _workflows.WorkflowId, initiated_event_id: int, execution_started_event_id: int)[source]¶

Child workflow execution timed-out workflow execution history event.

execution: _executions.ExecutionId¶: Timed-out execution.

execution_started_event_id: int¶: Child execution start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

property timeout_type: TimeoutType¶: Timeout type.

type: ClassVar[str] = 'ChildWorkflowExecutionTimedOut'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.CompleteWorkflowExecutionFailedEvent(id: int, occured: datetime, cause: DecisionFailureCause, decision_event_id: int)[source]¶

Workflow execution completion failed workflow execution history event.

cause: DecisionFailureCause¶: Failure cause.

decision_event_id: int¶: Execution complete decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'CompleteWorkflowExecutionFailed'¶: Event type.

class swf_typed.ContinueAsNewWorkflowExecutionFailedEvent(id: int, occured: datetime, cause: ContinueAsNewWorkflowExecutionFailureCause, decision_event_id: int)[source]¶

Workflow execution continue-as-new failed workflow execution history event.

cause: ContinueAsNewWorkflowExecutionFailureCause¶: Failure cause.

decision_event_id: int¶: Continue as new execution decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'ContinueAsNewWorkflowExecutionFailed'¶: Event type.

class swf_typed.DecisionFailureCause(*values)[source]¶

Generic decision failure cause.

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unhandled_decision = 'UNHANDLED_DECISION'¶

class swf_typed.DecisionTaskCompletedEvent(id: int, occured: datetime, decision_task_scheduled_event_id: int, decision_task_started_event_id: int, decision_context: str = None)[source]¶

Decision task completed workflow execution history event.

decision_context: str = None¶: Context provided by decider, accessible when describing execution.

decision_task_scheduled_event_id: int¶: Decision task schedule event ID.

decision_task_started_event_id: int¶: Decision task start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'DecisionTaskCompleted'¶: Event type.

class swf_typed.DecisionTaskScheduledEvent(id: int, occured: datetime, decision_task_list: str, decision_task_timeout: timedelta | None = _Sentinel(), decision_task_priority: int = None)[source]¶

Decision task scheduled workflow execution history event.

decision_task_list: str¶: Task-list which decision task was placed on.

decision_task_priority: int = None¶: Decision task priority.

decision_task_timeout: timedelta | None = _Sentinel()¶: Decision runtime timeout.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'DecisionTaskScheduled'¶: Event type.

class swf_typed.DecisionTaskStartedEvent(id: int, occured: datetime, decision_task_scheduled_event_id: int, decider_identity: str = None)[source]¶

Decision task started workflow execution history event.

decider_identity: str = None¶: Identity of decider which acquired task.

decision_task_scheduled_event_id: int¶: Decision task schedule event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'DecisionTaskStarted'¶: Event type.

class swf_typed.DecisionTaskTimedOutEvent(id: int, occured: datetime, decision_task_scheduled_event_id: int, decision_task_started_event_id: int)[source]¶

Decision task timed-out workflow execution history event.

decision_task_scheduled_event_id: int¶: Decision task schedule event ID.

decision_task_started_event_id: int¶: Decision task start event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

property timeout_type: TimeoutType¶: Timeout type.

type: ClassVar[str] = 'DecisionTaskTimedOut'¶: Event type.

class swf_typed.Event(id: int, occured: datetime)[source]¶

Workflow execution history event.

abstract classmethod from_api(data) → Event[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str]¶: Event type.

class swf_typed.ExecutionTerminationCause(*values)[source]¶

Workflow execution termination cause.

child_execution_policy_applied = 'CHILD_POLICY_APPLIED'¶

event_limit_exceeded = 'EVENT_LIMIT_EXCEEDED'¶

operator_initiated = 'OPERATOR_INITIATED'¶

class swf_typed.ExternalWorkflowExecutionCancelRequestedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, initiated_event_id: int)[source]¶

External workflow execution cancellation requested workflow execution history event.

execution: _executions.ExecutionId¶: Execution whose cancellation is requested.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Execution cancellation begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ExternalWorkflowExecutionCancelRequested'¶: Event type.

class swf_typed.ExternalWorkflowExecutionSignaledEvent(id: int, occured: datetime, execution: _executions.ExecutionId, initiated_event_id: int)[source]¶

External workflow execution signaled workflow execution history event.

execution: _executions.ExecutionId¶: Signalled execution.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: External workflow signal begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'ExternalWorkflowExecutionSignaled'¶: Event type.

class swf_typed.FailWorkflowExecutionFailedEvent(id: int, occured: datetime, cause: DecisionFailureCause, decision_event_id: int)[source]¶

Workflow execution failure failed workflow execution history event.

cause: DecisionFailureCause¶: Failure cause.

decision_event_id: int¶: Workflow fail decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'FailWorkflowExecutionFailed'¶: Event type.

class swf_typed.MarkerRecordedEvent(id: int, occured: datetime, marker_name: str, decision_event_id: int, details: str = None)[source]¶

Marker recorded workflow execution history event.

decision_event_id: int¶: Marker record decision event ID.

details: str = None¶: Attached marker data.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

marker_name: str¶: Marker name.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'MarkerRecorded'¶: Event type.

class swf_typed.RecordMarkerFailedEvent(id: int, occured: datetime, marker_name: str, decision_event_id: int)[source]¶

Marker recording failed workflow execution history event.

property cause: DecisionFailureCause¶: Failure cause.

decision_event_id: int¶: Marker record decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

marker_name: str¶: Marker name.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'RecordMarkerFailed'¶: Event type.

class swf_typed.RequestCancelActivityTaskFailedEvent(id: int, occured: datetime, task_id: str, cause: CancelTaskFailureCause, decision_event_id: int)[source]¶

Activity task cancellation request failed workflow execution history event.

cause: CancelTaskFailureCause¶: Failure cause.

decision_event_id: int¶: Task cancellation request decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_id: str¶: ID of task whose cancellation was requested.

type: ClassVar[str] = 'RequestCancelActivityTaskFailed'¶: Event type.

class swf_typed.RequestCancelExternalWorkflowExecutionFailedEvent(id: int, occured: datetime, execution: _executions.ExecutionId, cause: CancelExecutionFailureCause, initiated_event_id: int, decision_event_id: int, control: str = None)[source]¶

External workflow execution cancellation request failed workflow execution history event.

cause: CancelExecutionFailureCause¶: Failure cause.

control: str = None¶: Message from cancellation requesting decider.

decision_event_id: int¶: Cancellation request decision event ID.

execution: _executions.ExecutionId¶: Execution whose cancellation was requested.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Cancellation request begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'RequestCancelExternalWorkflowExecutionFailed'¶: Event type.

class swf_typed.RequestCancelExternalWorkflowExecutionInitiatedEvent(id: int, occured: datetime, execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId'), decision_event_id: int, control: str = None)[source]¶

External workflow execution cancellation request initiation workflow execution history event.

control: str = None¶: Message from cancellation requesting decider.

decision_event_id: int¶: Cancellation request decision event ID.

execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId')¶: Execution whose cancellation was requested.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'RequestCancelExternalWorkflowExecutionInitiated'¶: Event type.

class swf_typed.ScheduleActivityTaskFailedEvent(id: int, occured: datetime, task_id: str, activity: _activities.ActivityId, cause: ScheduleTaskFailureCause, decision_event_id: int)[source]¶

Activity task scheduling failed workflow execution history event.

activity: _activities.ActivityId¶: Task activity type.

cause: ScheduleTaskFailureCause¶: Failure cause.

decision_event_id: int¶: Task schedule decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

task_id: str¶: ID of task to be scheduled.

type: ClassVar[str] = 'ScheduleActivityTaskFailed'¶: Event type.

class swf_typed.ScheduleLambdaFailureCause(*values)[source]¶

Schedule Lambda function invocation decision failure cause.

lambda_service_unavailable = 'LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION'¶

open_tasks_limit_exceeded = 'OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED'¶

rate_exceeded = 'LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED'¶

task_id_exists = 'ID_ALREADY_IN_USE'¶

class swf_typed.ScheduleTaskFailureCause(*values)[source]¶

Schedule activity task decision failure cause.

activity_deprecated = 'ACTIVITY_TYPE_DEPRECATED'¶

heartbeat_timeout_undefined = 'DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED'¶

open_tasks_limit_exceeded = 'OPEN_ACTIVITIES_LIMIT_EXCEEDED'¶

rate_exceeded = 'ACTIVITY_CREATION_RATE_EXCEEDED'¶

runtime_timeout_undefined = 'DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED'¶

scheduled_timeout_undefined = 'DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED'¶

task_id_exists = 'ACTIVITY_ID_ALREADY_IN_USE'¶

task_list_undefined = 'DEFAULT_TASK_LIST_UNDEFINED'¶

total_timeout_undefined = 'DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED'¶

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_activity = 'ACTIVITY_TYPE_DOES_NOT_EXIST'¶

class swf_typed.SignalExternalWorkflowExecutionFailedEvent(id: int, occured: datetime, execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId'), cause: SignalFailureCause, initiated_event_id: int, decision_event_id: int, control: str = None)[source]¶

External workflow execution signalling failed workflow execution history event.

cause: SignalFailureCause¶: Failure cause.

control: str = None¶: Message from signalling decider.

decision_event_id: int¶: External workflow signal decision event ID.

execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId')¶: Execution to be signalled.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: External workflow signal begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'SignalExternalWorkflowExecutionFailed'¶: Event type.

class swf_typed.SignalExternalWorkflowExecutionInitiatedEvent(id: int, occured: datetime, execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId'), signal_name: str, decision_event_id: int, signal_input: str = None, control: str = None)[source]¶

External workflow execution signalling initiated workflow execution history event.

control: str = None¶: Message from signalling decider.

decision_event_id: int¶: External workflow signal decision event ID.

execution: ForwardRef('_executions.ExecutionId') | ForwardRef('_executions.CurrentExecutionId')¶: Execution to be signalled.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

signal_input: str = None¶: Attached signal data.

signal_name: str¶: Signal name.

type: ClassVar[str] = 'SignalExternalWorkflowExecutionInitiated'¶: Event type.

class swf_typed.SignalFailureCause(*values)[source]¶

Signal workflow execution decision failure cause.

rate_exceeded = 'SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'¶

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_execution = 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'¶

class swf_typed.StartActivityTaskFailedEvent(id: int, occured: datetime, task_id: str = None, cause: str = None, task_scheduled_event_id: int = None)[source]¶

Activity task starting failed workflow execution history event.

cause: str = None¶: Failure cause.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

task_id: str = None¶: ID of task to be started.

task_scheduled_event_id: int = None¶: Task schedule decision event ID.

type: ClassVar[str] = 'StartActivityTaskFailed'¶: Event type.

class swf_typed.StartChildExecutionFailureCause(*values)[source]¶

Start child workflow execution decision failure cause.

child_execution_policy_undefined = 'DEFAULT_CHILD_POLICY_UNDEFINED'¶

decision_task_timeout_undefined = 'DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED'¶

execution_exists = 'WORKFLOW_ALREADY_RUNNING'¶

open_child_executions_limit_exceeded = 'OPEN_CHILDREN_LIMIT_EXCEEDED'¶

open_executions_limit_exceeded = 'OPEN_WORKFLOWS_LIMIT_EXCEEDED'¶

rate_exceeded = 'CHILD_CREATION_RATE_EXCEEDED'¶

task_list_undefined = 'DEFAULT_TASK_LIST_UNDEFINED'¶

timeout_undefined = 'DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED'¶

unauthorised = 'OPERATION_NOT_PERMITTED'¶

unknown_workflow = 'WORKFLOW_TYPE_DOES_NOT_EXIST'¶

workflow_deprecated = 'WORKFLOW_TYPE_DEPRECATED'¶

class swf_typed.StartChildWorkflowExecutionFailedEvent(id: int, occured: datetime, execution: _executions.CurrentExecutionId, workflow: _workflows.WorkflowId, cause: StartChildExecutionFailureCause, initiated_event_id: int, decision_event_id: int, control: str = None)[source]¶

Child workflow execution starting failed workflow execution history event.

cause: StartChildExecutionFailureCause¶: Failure cause.

control: str = None¶: Message from child execution starting decider.

decision_event_id: int¶: Child workflow start decision event ID.

execution: _executions.CurrentExecutionId¶: Execution to be started.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

initiated_event_id: int¶: Child execution start begun event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'StartChildWorkflowExecutionFailed'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.StartChildWorkflowExecutionInitiatedEvent(id: int, occured: datetime, execution: _executions.CurrentExecutionId, workflow: _workflows.WorkflowId, execution_configuration: _executions.PartialExecutionConfiguration, decision_event_id: int, execution_input: str = None, execution_tags: List[str] = None, control: str = None)[source]¶

Child workflow execution starting initiated workflow execution history event.

control: str = None¶: Message from child execution starting decider.

decision_event_id: int¶: Child execution start decision event ID.

execution: _executions.CurrentExecutionId¶: Execution to be started.

execution_configuration: _executions.PartialExecutionConfiguration¶: Child execution configuration (termination policy and decision task-list guaranteed).

execution_input: str = None¶: Child execution input.

execution_tags: List[str] = None¶: Child execution tags.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'StartChildWorkflowExecutionInitiated'¶: Event type.

workflow: _workflows.WorkflowId¶: Child execution workflow type.

class swf_typed.StartLambdaFailureCause(*values)[source]¶

Lambda function invocation failure cause.

assume_iam_role_failed = 'ASSUME_ROLE_FAILED'¶

class swf_typed.StartTimerFailedEvent(id: int, occured: datetime, timer_id: str, cause: StartTimerFailureCause, decision_event_id: int)[source]¶

Timer starting failed workflow execution history event.

cause: StartTimerFailureCause¶: Failure cause.

decision_event_id: int¶: Timer start decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

timer_id: str¶: Timer ID.

type: ClassVar[str] = 'StartTimerFailed'¶: Event type.

class swf_typed.StartTimerFailureCause(*values)[source]¶

Start timer decision failure cause.

open_timers_limit_exceeded = 'OPEN_TIMERS_LIMIT_EXCEEDED'¶

rate_exceeded = 'TIMER_CREATION_RATE_EXCEEDED'¶

timer_in_use = 'TIMER_ID_ALREADY_IN_USE'¶

unauthorised = 'OPERATION_NOT_PERMITTED'¶

class swf_typed.TimeoutType(*values)[source]¶

Task/execution timeout type.

heartbeat = 'HEARTBEAT'¶

runtime = 'START_TO_CLOSE'¶

schedule = 'SCHEDULE_TO_START'¶

total = 'SCHEDULE_TO_CLOSE'¶

class swf_typed.TimerCancelledEvent(id: int, occured: datetime, timer_id: str, timer_started_event_id: int, decision_event_id: int)[source]¶

Timer cancelled workflow execution history event.

decision_event_id: int¶: Timer start decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

timer_id: str¶: Cancelled timer ID.

timer_started_event_id: int¶: Timer start event ID.

type: ClassVar[str] = 'TimerCanceled'¶: Event type.

class swf_typed.TimerFiredEvent(id: int, occured: datetime, timer_id: str, timer_started_event_id: int)[source]¶

Timer fired workflow execution history event.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

timer_id: str¶: Fired timer ID.

timer_started_event_id: int¶: Timer start event ID.

type: ClassVar[str] = 'TimerFired'¶: Event type.

class swf_typed.TimerStartedEvent(id: int, occured: datetime, timer_id: str, timer_duration: timedelta, decision_event_id: int, control: str = None)[source]¶

Timer started workflow execution history event.

control: str = None¶: Message from timer starting decider.

decision_event_id: int¶: Timer start decision event ID.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

timer_duration: timedelta¶: Timer duration.

timer_id: str¶: Started timer ID.

type: ClassVar[str] = 'TimerStarted'¶: Event type.

class swf_typed.WorkflowExecutionCancelRequestedEvent(id: int, occured: datetime, cause: ExecutionTerminationCause = None, cancelling_execution: _executions.ExecutionId = None, cancel_decision_event_id: int = None)[source]¶

Workflow execution cancellation requested workflow execution history event.

cancel_decision_event_id: int = None¶: Cancellation request decision event ID in execution which requested the cancellation.

cancelling_execution: _executions.ExecutionId = None¶: Execution which requested the cancellation.

cause: ExecutionTerminationCause = None¶: Cancellation request cause.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'WorkflowExecutionCancelRequested'¶: Event type.

class swf_typed.WorkflowExecutionCancelledEvent(id: int, occured: datetime, decision_event_id: int, details: str = None)[source]¶

Workflow execution cancelled workflow execution history event.

decision_event_id: int¶: Execution cancel decision event ID.

details: str = None¶: Execution cancellation details, usually for explanation.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'WorkflowExecutionCanceled'¶: Event type.

class swf_typed.WorkflowExecutionCompletedEvent(id: int, occured: datetime, decision_event_id: int, execution_result: str = None)[source]¶

Workflow execution completed workflow execution history event.

decision_event_id: int¶: Execution complete decision event ID.

execution_result: str = None¶: Execution result.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

type: ClassVar[str] = 'WorkflowExecutionCompleted'¶: Event type.

class swf_typed.WorkflowExecutionContinuedAsNewEvent(id: int, occured: datetime, execution_run_id: str, execution_configuration: _executions.PartialExecutionConfiguration, workflow: _workflows.WorkflowId, decision_event_id: int, execution_input: str = None, execution_tags: List[str] = None)[source]¶

Workflow execution continued as new workflow execution history event.

decision_event_id: int¶: Continue as new execution decision event ID.

execution_configuration: _executions.PartialExecutionConfiguration¶: New execution configuration (termination policy and decision task-list guaranteed).

execution_input: str = None¶: New execution input.

execution_run_id: str¶: New execution run ID.

execution_tags: List[str] = None¶: New execution tags.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

type: ClassVar[str] = 'WorkflowExecutionContinuedAsNew'¶: Event type.

workflow: _workflows.WorkflowId¶: New execution workflow type.

class swf_typed.WorkflowExecutionFailedEvent(id: int, occured: datetime, decision_event_id: int, reason: str = None, details: str = None)[source]¶

Workflow execution failed workflow execution history event.

decision_event_id: int¶: Execution fail decision event ID.

details: str = None¶: Failure details, usually for explanation.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime¶: Event occured date.

reason: str = None¶: Failure reason, usually for classification.

type: ClassVar[str] = 'WorkflowExecutionFailed'¶: Event type.

class swf_typed.WorkflowExecutionSignaledEvent(id: int, occured: datetime, signal_name: str, signal_input: str = None, signalling_execution: _executions.ExecutionId = None, signal_decision_event_id: int = None)[source]¶

Workflow execution signaled workflow execution history event.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

signal_decision_event_id: int = None¶: Signal decision event ID in execution which sent the signal.

signal_input: str = None¶: Attached signal data.

signal_name: str¶: Signal name.

signalling_execution: _executions.ExecutionId = None¶: Execution which sent the signal.

type: ClassVar[str] = 'WorkflowExecutionSignaled'¶: Event type.

class swf_typed.WorkflowExecutionStartedEvent(id: int, occured: datetime, workflow: _workflows.WorkflowId, execution_configuration: _executions.PartialExecutionConfiguration, execution_input: str = None, execution_tags: List[str] = None, continued_execution_run_id: str = None, parent_execution: _executions.ExecutionId = None, parent_initiated_event_id: int = None)[source]¶

Workflow execution started workflow execution history event.

continued_execution_run_id: str = None¶: Run ID of execution which this execution continues from.

execution_configuration: _executions.PartialExecutionConfiguration¶: Execution configuration (termination policy and decision task-list guaranteed).

execution_input: str = None¶: Execution input.

execution_tags: List[str] = None¶: Execution tags.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

parent_execution: _executions.ExecutionId = None¶: Parent execution (which started this execution).

parent_initiated_event_id: int = None¶: ID of event in parent execution which begins the starting of this execution.

type: ClassVar[str] = 'WorkflowExecutionStarted'¶: Event type.

workflow: _workflows.WorkflowId¶: Execution workflow type.

class swf_typed.WorkflowExecutionTerminatedEvent(id: int, occured: datetime, child_execution_policy: _executions.ChildExecutionTerminationPolicy, cause: ExecutionTerminationCause = None, reason: str = None, details: str = None)[source]¶

Workflow execution terminated workflow execution history event.

cause: ExecutionTerminationCause = None¶: Failure cause.

child_execution_policy: _executions.ChildExecutionTerminationPolicy¶: Child execution policy (how open child executions were handled).

details: str = None¶: Termination details, usually for explanation.

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

reason: str = None¶: Termination reason, usually for classification.

type: ClassVar[str] = 'WorkflowExecutionTerminated'¶: Event type.

class swf_typed.WorkflowExecutionTimedOutEvent(id: int, occured: datetime, child_execution_policy: _executions.ChildExecutionTerminationPolicy)[source]¶

Workflow execution timed-out workflow execution history event.

child_execution_policy: _executions.ChildExecutionTerminationPolicy¶: Child execution policy (how open child executions were handled).

classmethod from_api(data)[source]¶: Deserialise from SWF API response data.

id: int¶: Event ID.

occured: datetime.datetime¶: Event occured date.

property timeout_type: TimeoutType¶: Timeout type.

type: ClassVar[str] = 'WorkflowExecutionTimedOut'¶: Event type.

swf_typed.get_execution_history(execution: _executions.ExecutionId, domain: str, reverse: bool = False, client: botocore.client.BaseClient = None) → Generator[Event, None, None][source]¶

Get workflow execution history; retrieved semi-lazily.

Parameters:

execution – workflow execution to get history of
domain – domain of workflow execution
reverse – return latest events first
client – SWF client

Returns:

workflow execution history events

swf_typed.get_last_execution_history_event(execution: _executions.ExecutionId, domain: str, client: botocore.client.BaseClient = None) → Event[source]¶

Get last workflow execution history event.

Parameters:

execution – workflow execution to get history event of
domain – domain of workflow execution
client – SWF client

Returns:

most recent workflow execution history event