ValidateStateMachineDefinitionDiagnostic Class

Describes potential issues found during state machine validation. Rather than raise an exception, validation will return a list of diagnostic elements containing diagnostic information.

The ValidateStateMachineDefinitionlAPI might add new diagnostics in the future, adjust diagnostic codes, or change the message wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or wording of diagnostic messages.

List of warning codes

NO_DOLLAR: No .$ on a field that appears to be a JSONPath or Intrinsic Function.
NO_PATH: Field value looks like a path, but field name does not end with 'Path'.
PASS_RESULT_IS_STATIC: Attempt to use a path in the result of a pass state.

List of error codes

INVALID_JSON_DESCRIPTION: JSON syntax problem found.
MISSING_DESCRIPTION: Received a null or empty workflow input.
SCHEMA_VALIDATION_FAILED: Schema validation reported errors.
INVALID_RESOURCE: The value of a Task-state resource field is invalid.
MISSING_END_STATE: The workflow does not have a terminal state.
DUPLICATE_STATE_NAME: The same state name appears more than once.
INVALID_STATE_NAME: The state name does not follow the naming convention.
STATE_MACHINE_NAME_EMPTY: The state machine name has not been specified.
STATE_MACHINE_NAME_INVALID: The state machine name does not follow the naming convention.
STATE_MACHINE_NAME_TOO_LONG: The state name exceeds the allowed length.
STATE_MACHINE_NAME_ALREADY_EXISTS: The state name already exists.
DUPLICATE_LABEL_NAME: A label name appears more than once.
INVALID_LABEL_NAME: You have provided an invalid label name.
MISSING_TRANSITION_TARGET: The value of "Next" field doesn't match a known state name.
TOO_DEEPLY_NESTED: The states are too deeply nested.

Inheritance Hierarchy

System.Object
Amazon.StepFunctions.Model.ValidateStateMachineDefinitionDiagnostic

Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

public class ValidateStateMachineDefinitionDiagnostic

The ValidateStateMachineDefinitionDiagnostic type exposes the following members

Constructors

	Name	Description
	ValidateStateMachineDefinitionDiagnostic()

Properties

Name	Type	Description
Code	System.String	Gets and sets the property Code. Identifying code for the diagnostic.
Location	System.String	Gets and sets the property Location. 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	System.String	Gets and sets the property Message. Message describing the diagnostic condition.
Severity	Amazon.StepFunctions.ValidateStateMachineDefinitionSeverity	Gets and sets the property Severity. 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5