Skip to content

ExecutionListItem

Source code in docs_src/capo_sfn/types/execution_list_item.py
class ExecutionListItem(TypedDict, closed=True):
    execution_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) that identifies the execution.</p>"""
    state_machine_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the state machine that ran the execution.</p>"""
    name: "capo_sfn.types.name.Name"
    r"""<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p> </li> <li> <p>surrogates (<code>U+D800-DFFF</code>)</p> </li> <li> <p>invalid characters (<code> U+10FFFF</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"""
    status: "capo_sfn.types.execution_status.ExecutionStatus"
    """<p>The current status of the execution.</p>"""
    start_date: "capo_sfn.types.timestamp.Timestamp"
    """<p>The date the execution started.</p>"""
    stop_date: NotRequired["capo_sfn.types.timestamp.Timestamp"]
    """<p>If the execution already ended, the date the execution stopped.</p>"""
    map_run_arn: NotRequired["capo_sfn.types.long_arn.LongArn"]
    """<p>The Amazon Resource Name (ARN) of a Map Run. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>mapRunArn</code> isn't returned.</p>"""
    item_count: NotRequired["capo_sfn.types.unsigned_integer.UnsignedInteger"]
    """<p>The total number of items processed in a child workflow execution. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>itemCount</code> field isn't returned.</p>"""
    state_machine_version_arn: NotRequired["capo_sfn.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p> <p>If the state machine execution was started with an unqualified ARN, it returns null.</p> <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>"""
    state_machine_alias_arn: NotRequired["capo_sfn.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p> <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>"""
    redrive_count: NotRequired["capo_sfn.types.redrive_count.RedriveCount"]
    """<p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is only updated when you successfully redrive an execution.</p>"""
    redrive_date: NotRequired["capo_sfn.types.timestamp.Timestamp"]
    """<p>The date the execution was last redriven.</p>"""

execution_arn instance-attribute

execution_arn: Arn

The Amazon Resource Name (ARN) that identifies the execution.

item_count instance-attribute

item_count: NotRequired[UnsignedInteger]

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

map_run_arn instance-attribute

map_run_arn: NotRequired[LongArn]

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

name instance-attribute

name: Name

The name of the execution.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF)

  • surrogates (U+D800-DFFF)

  • invalid characters ( U+10FFFF)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

redrive_count instance-attribute

redrive_count: NotRequired[RedriveCount]

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

redrive_date instance-attribute

redrive_date: NotRequired[Timestamp]

The date the execution was last redriven.

start_date instance-attribute

start_date: Timestamp

The date the execution started.

state_machine_alias_arn instance-attribute

state_machine_alias_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

state_machine_arn instance-attribute

state_machine_arn: Arn

The Amazon Resource Name (ARN) of the state machine that ran the execution.

state_machine_version_arn instance-attribute

state_machine_version_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the state machine version associated with the execution.

If the state machine execution was started with an unqualified ARN, it returns null.

If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

status instance-attribute

The current status of the execution.

stop_date instance-attribute

stop_date: NotRequired[Timestamp]

If the execution already ended, the date the execution stopped.