Class: Aws::States::Types::ValidateStateMachineDefinitionDiagnostic

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-states/types.rb

Overview

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

<note markdown=“1”> 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.

</note>

**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.

[1]: docs.aws.amazon.com/step-functions/latest/apireference/API_ValidateStateMachineDefinition.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:code, :message, :location]

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ String

Identifying code for the diagnostic.

Returns:

  • (String) 


4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/aws-sdk-states/types.rb', line 4815

class ValidateStateMachineDefinitionDiagnostic < Struct.new(
  :severity,
  :code,
  :message,
  :location)
  SENSITIVE = [:code, :message, :location]
  include Aws::Structure
end

#location ⇒ String

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

For errors specific to a field, the location could be in the format: ‘/States/<StateName>/<FieldName>`, for example: `/States/FailState/ErrorPath`.

Returns:

  • (String) 


4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/aws-sdk-states/types.rb', line 4815

class ValidateStateMachineDefinitionDiagnostic < Struct.new(
  :severity,
  :code,
  :message,
  :location)
  SENSITIVE = [:code, :message, :location]
  include Aws::Structure
end

#message ⇒ String

Message describing the diagnostic condition.

Returns:

  • (String) 


4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/aws-sdk-states/types.rb', line 4815

class ValidateStateMachineDefinitionDiagnostic < Struct.new(
  :severity,
  :code,
  :message,
  :location)
  SENSITIVE = [:code, :message, :location]
  include Aws::Structure
end

#severity ⇒ String

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.

Returns:

  • (String) 


4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'lib/aws-sdk-states/types.rb', line 4815

class ValidateStateMachineDefinitionDiagnostic < Struct.new(
  :severity,
  :code,
  :message,
  :location)
  SENSITIVE = [:code, :message, :location]
  include Aws::Structure
end