Skip to content

WorkflowExecutionConfiguration

Source code in docs_src/capo_swf/types/workflow_execution_configuration.py
class WorkflowExecutionConfiguration(TypedDict, closed=True):
    task_start_to_close_timeout: "capo_swf.types.duration_in_seconds.DurationInSeconds"
    """<p>The maximum duration allowed for decision tasks for this workflow execution.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>"""
    execution_start_to_close_timeout: (
        "capo_swf.types.duration_in_seconds.DurationInSeconds"
    )
    """<p>The total duration for this workflow execution.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>"""
    task_list: "capo_swf.types.task_list.TaskList"
    """<p>The task list used for the decision tasks generated for this workflow execution.</p>"""
    task_priority: NotRequired["capo_swf.types.task_priority.TaskPriority"]
    """<p>The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>"""
    child_policy: "capo_swf.types.child_policy.ChildPolicy"
    """<p>The policy to use for the child workflow executions if this workflow execution is terminated, by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p> <p>The supported child policies are:</p> <ul> <li> <p> <code>TERMINATE</code> – The child executions are terminated.</p> </li> <li> <p> <code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p> </li> <li> <p> <code>ABANDON</code> – No action is taken. The child executions continue to run.</p> </li> </ul>"""
    lambda_role: NotRequired["capo_swf.types.arn.Arn"]
    """<p>The IAM role attached to the child workflow execution.</p>"""

child_policy instance-attribute

child_policy: ChildPolicy

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

execution_start_to_close_timeout instance-attribute

execution_start_to_close_timeout: DurationInSeconds

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

lambda_role instance-attribute

lambda_role: NotRequired[Arn]

The IAM role attached to the child workflow execution.

task_list instance-attribute

task_list: TaskList

The task list used for the decision tasks generated for this workflow execution.

task_priority instance-attribute

task_priority: NotRequired[TaskPriority]

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

task_start_to_close_timeout instance-attribute

task_start_to_close_timeout: DurationInSeconds

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.