Skip to content

ValidateStateMachineDefinitionOutput

Source code in docs_src/capo_sfn/types/validate_state_machine_definition_output.py 
15
16
17
18
19
20
21
22
23
class ValidateStateMachineDefinitionOutput(TypedDict, closed=True):
    result: "capo_sfn.types.validate_state_machine_definition_result_code.ValidateStateMachineDefinitionResultCode"
    """<p>The result value will be <code>OK</code> when no syntax errors are found, or <code>FAIL</code> if the workflow definition does not pass verification.</p>"""
    diagnostics: "capo_sfn.types.validate_state_machine_definition_diagnostic_list.ValidateStateMachineDefinitionDiagnosticList"
    """<p>An array of diagnostic errors and warnings found during validation of the state machine definition. Since <b>warnings</b> do not prevent deploying your workflow definition, the <b>result</b> value could be <code>OK</code> even when warning diagnostics are present in the response.</p>"""
    truncated: NotRequired[
        "capo_sfn.types.validate_state_machine_definition_truncated.ValidateStateMachineDefinitionTruncated"
    ]
    """<p>The result value will be <code>true</code> if the number of diagnostics found in the workflow definition exceeds <code>maxResults</code>. When all diagnostics results are returned, the value will be <code>false</code>.</p>"""

diagnostics instance-attribute 

diagnostics: ValidateStateMachineDefinitionDiagnosticList

An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.

result instance-attribute 

result: ValidateStateMachineDefinitionResultCode

The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

truncated instance-attribute 

truncated: NotRequired[ValidateStateMachineDefinitionTruncated]

The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.