Skip to content

StateExitedEventDetails

Source code in docs_src/capo_sfn/types/state_exited_event_details.py
class StateExitedEventDetails(TypedDict, closed=True):
    name: "capo_sfn.types.name.Name"
    r"""<p>The name of the state.</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>"""
    output: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>"""
    output_details: NotRequired[
        "capo_sfn.types.history_event_execution_data_details.HistoryEventExecutionDataDetails"
    ]
    """<p>Contains details about the output of an execution history event.</p>"""
    assigned_variables: NotRequired[
        "capo_sfn.types.assigned_variables.AssignedVariables"
    ]
    """<p>Map of variable name and value as a serialized JSON representation.</p>"""
    assigned_variables_details: NotRequired[
        "capo_sfn.types.assigned_variables_details.AssignedVariablesDetails"
    ]
    """<p>Provides details about input or output in an execution history event.</p>"""

assigned_variables instance-attribute

assigned_variables: NotRequired[AssignedVariables]

Map of variable name and value as a serialized JSON representation.

assigned_variables_details instance-attribute

assigned_variables_details: NotRequired[AssignedVariablesDetails]

Provides details about input or output in an execution history event.

name instance-attribute

name: Name

The name of the state.

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 _.

output instance-attribute

output: NotRequired[SensitiveData]

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

output_details instance-attribute

output_details: NotRequired[HistoryEventExecutionDataDetails]

Contains details about the output of an execution history event.