Skip to content

ValidateStateMachineDefinitionInput

Source code in docs_src/capo_sfn/types/validate_state_machine_definition_input.py 
16
17
18
19
20
21
22
23
24
25
26
class ValidateStateMachineDefinitionInput(TypedDict, closed=True):
    definition: "capo_sfn.types.definition.Definition"
    """<p>The Amazon States Language definition of the state machine. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL).</p>"""
    type: NotRequired["capo_sfn.types.state_machine_type.StateMachineType"]
    """<p>The target type of state machine for this definition. The default is <code>STANDARD</code>.</p>"""
    severity: NotRequired[
        "capo_sfn.types.validate_state_machine_definition_severity.ValidateStateMachineDefinitionSeverity"
    ]
    """<p>Minimum level of diagnostics to return. <code>ERROR</code> returns only <code>ERROR</code> diagnostics, whereas <code>WARNING</code> returns both <code>WARNING</code> and <code>ERROR</code> diagnostics. The default is <code>ERROR</code>. </p>"""
    max_results: "capo_sfn.types.validate_state_machine_definition_max_result.ValidateStateMachineDefinitionMaxResult"
    """<p>The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.</p> <p>If the number of diagnostics returned in the response exceeds <code>maxResults</code>, the value of the <code>truncated</code> field in the response will be set to <code>true</code>.</p>"""

definition instance-attribute 

definition: Definition

The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).

max_results instance-attribute 

max_results: ValidateStateMachineDefinitionMaxResult

The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.

If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

severity instance-attribute 

severity: NotRequired[ValidateStateMachineDefinitionSeverity]

Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.

type instance-attribute 

type: NotRequired[StateMachineType]

The target type of state machine for this definition. The default is STANDARD.