Skip to content

ValidateStateMachineDefinitionDiagnostic

Source code in docs_src/capo_sfn/types/validate_state_machine_definition_diagnostic.py 
16
17
18
19
20
21
22
23
24
25
26
class ValidateStateMachineDefinitionDiagnostic(TypedDict, closed=True):
    severity: "capo_sfn.types.validate_state_machine_definition_severity.ValidateStateMachineDefinitionSeverity"
    """<p>A value of <code>ERROR</code> means that you cannot create or update a state machine with this definition.</p> <p> <code>WARNING</code> level diagnostics alert you to potential issues, but they will not prevent you from creating or updating your state machine.</p>"""
    code: "capo_sfn.types.validate_state_machine_definition_code.ValidateStateMachineDefinitionCode"
    """<p>Identifying code for the diagnostic.</p>"""
    message: "capo_sfn.types.validate_state_machine_definition_message.ValidateStateMachineDefinitionMessage"
    """<p>Message describing the diagnostic condition.</p>"""
    location: NotRequired[
        "capo_sfn.types.validate_state_machine_definition_location.ValidateStateMachineDefinitionLocation"
    ]
    """<p>Location of the issue in the state machine, if available.</p> <p>For errors specific to a field, the location could be in the format: <code>/States/<StateName>/<FieldName></code>, for example: <code>/States/FailState/ErrorPath</code>.</p>"""

code instance-attribute 

code: ValidateStateMachineDefinitionCode

Identifying code for the diagnostic.

location instance-attribute 

location: NotRequired[ValidateStateMachineDefinitionLocation]

Location of the issue in the state machine, if available.

For errors specific to a field, the location could be in the format: /States//, for example: /States/FailState/ErrorPath.

message instance-attribute 

message: ValidateStateMachineDefinitionMessage

Message describing the diagnostic condition.

severity instance-attribute 

severity: ValidateStateMachineDefinitionSeverity

A value of ERROR means that you cannot create or update a state machine with this definition.

WARNING level diagnostics alert you to potential issues, but they will not prevent you from creating or updating your state machine.