Skip to content

TestStateOutput

Source code in docs_src/capo_sfn/types/test_state_output.py
class TestStateOutput(TypedDict, closed=True):
    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>"""
    error: NotRequired["capo_sfn.types.sensitive_error.SensitiveError"]
    """<p>The error returned when the execution of a state fails.</p>"""
    cause: NotRequired["capo_sfn.types.sensitive_cause.SensitiveCause"]
    """<p>A detailed explanation of the cause for the error when the execution of a state fails.</p>"""
    inspection_data: NotRequired["capo_sfn.types.inspection_data.InspectionData"]
    """<p>Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The <code>inspectionLevel</code> request parameter specifies which details are returned.</p>"""
    next_state: NotRequired["capo_sfn.types.state_name.StateName"]
    """<p>The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.</p>"""
    status: NotRequired["capo_sfn.types.test_execution_status.TestExecutionStatus"]
    """<p>The execution status of the state.</p>"""

cause instance-attribute

cause: NotRequired[SensitiveCause]

A detailed explanation of the cause for the error when the execution of a state fails.

error instance-attribute

error: NotRequired[SensitiveError]

The error returned when the execution of a state fails.

inspection_data instance-attribute

inspection_data: NotRequired[InspectionData]

Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.

next_state instance-attribute

next_state: NotRequired[StateName]

The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.

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.

status instance-attribute

status: NotRequired[TestExecutionStatus]

The execution status of the state.