Skip to content

InspectionData

Source code in docs_src/capo_sfn/types/inspection_data.py
class InspectionData(TypedDict, closed=True):
    input: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The raw state input.</p>"""
    after_arguments: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The input after Step Functions applies an Arguments filter. This event will only be present when QueryLanguage for the state machine or individual states is set to JSONata. For more info, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/data-transform.html">Transforming data with Step Functions</a>.</p>"""
    after_input_path: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-inputpath">InputPath</a> filter. Not populated when QueryLanguage is JSONata.</p>"""
    after_parameters: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters">Parameters</a> filter. Not populated when QueryLanguage is JSONata.</p>"""
    result: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The state's raw result.</p>"""
    after_result_selector: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective result after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector">ResultSelector</a> filter. Not populated when QueryLanguage is JSONata.</p>"""
    after_result_path: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective result combined with the raw state input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultpath.html">ResultPath</a> filter. Not populated when QueryLanguage is JSONata.</p>"""
    request: NotRequired["capo_sfn.types.inspection_data_request.InspectionDataRequest"]
    """<p>The raw HTTP request that is sent when you test an HTTP Task.</p>"""
    response: NotRequired[
        "capo_sfn.types.inspection_data_response.InspectionDataResponse"
    ]
    """<p>The raw HTTP response that is returned when you test an HTTP Task.</p>"""
    variables: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>JSON string that contains the set of workflow variables after execution of the state. The set will include variables assigned in the state and variables set up as test state input.</p>"""
    error_details: NotRequired[
        "capo_sfn.types.inspection_error_details.InspectionErrorDetails"
    ]
    """<p>An object containing data about a handled exception in the tested state.</p>"""
    after_items_path: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective input after the ItemsPath filter is applied. Not populated when the QueryLanguage is JSONata.</p>"""
    after_item_selector: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>An array containing the inputs for each Map iteration, transformed by the ItemSelector specified in a Map state.</p>"""
    after_item_batcher: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective input after the ItemBatcher filter is applied in a Map state.</p>"""
    after_items_pointer: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The effective input after the ItemsPointer filter is applied in a Map state.</p>"""
    tolerated_failure_count: NotRequired[
        "capo_sfn.types.inspection_tolerated_failure_count.InspectionToleratedFailureCount"
    ]
    """<p>The tolerated failure threshold for a Map state as defined in number of Map state iterations.</p>"""
    tolerated_failure_percentage: NotRequired[
        "capo_sfn.types.inspection_tolerated_failure_percentage.InspectionToleratedFailurePercentage"
    ]
    """<p>The tolerated failure threshold for a Map state as defined in percentage of Map state iterations.</p>"""
    max_concurrency: NotRequired[
        "capo_sfn.types.inspection_max_concurrency.InspectionMaxConcurrency"
    ]
    """<p>The max concurrency of the Map state.</p>"""

after_arguments instance-attribute

after_arguments: NotRequired[SensitiveData]

The input after Step Functions applies an Arguments filter. This event will only be present when QueryLanguage for the state machine or individual states is set to JSONata. For more info, see Transforming data with Step Functions.

after_input_path instance-attribute

after_input_path: NotRequired[SensitiveData]

The input after Step Functions applies the InputPath filter. Not populated when QueryLanguage is JSONata.

after_item_batcher instance-attribute

after_item_batcher: NotRequired[SensitiveData]

The effective input after the ItemBatcher filter is applied in a Map state.

after_item_selector instance-attribute

after_item_selector: NotRequired[SensitiveData]

An array containing the inputs for each Map iteration, transformed by the ItemSelector specified in a Map state.

after_items_path instance-attribute

after_items_path: NotRequired[SensitiveData]

The effective input after the ItemsPath filter is applied. Not populated when the QueryLanguage is JSONata.

after_items_pointer instance-attribute

after_items_pointer: NotRequired[SensitiveData]

The effective input after the ItemsPointer filter is applied in a Map state.

after_parameters instance-attribute

after_parameters: NotRequired[SensitiveData]

The effective input after Step Functions applies the Parameters filter. Not populated when QueryLanguage is JSONata.

after_result_path instance-attribute

after_result_path: NotRequired[SensitiveData]

The effective result combined with the raw state input after Step Functions applies the ResultPath filter. Not populated when QueryLanguage is JSONata.

after_result_selector instance-attribute

after_result_selector: NotRequired[SensitiveData]

The effective result after Step Functions applies the ResultSelector filter. Not populated when QueryLanguage is JSONata.

error_details instance-attribute

error_details: NotRequired[InspectionErrorDetails]

An object containing data about a handled exception in the tested state.

input instance-attribute

input: NotRequired[SensitiveData]

The raw state input.

max_concurrency instance-attribute

max_concurrency: NotRequired[InspectionMaxConcurrency]

The max concurrency of the Map state.

request instance-attribute

request: NotRequired[InspectionDataRequest]

The raw HTTP request that is sent when you test an HTTP Task.

response instance-attribute

response: NotRequired[InspectionDataResponse]

The raw HTTP response that is returned when you test an HTTP Task.

result instance-attribute

result: NotRequired[SensitiveData]

The state's raw result.

tolerated_failure_count instance-attribute

tolerated_failure_count: NotRequired[InspectionToleratedFailureCount]

The tolerated failure threshold for a Map state as defined in number of Map state iterations.

tolerated_failure_percentage instance-attribute

tolerated_failure_percentage: NotRequired[InspectionToleratedFailurePercentage]

The tolerated failure threshold for a Map state as defined in percentage of Map state iterations.

variables instance-attribute

variables: NotRequired[SensitiveData]

JSON string that contains the set of workflow variables after execution of the state. The set will include variables assigned in the state and variables set up as test state input.