Skip to content

Validate State Machine Definition

sfn_validate_state_machine_definition R Documentation

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language

Description

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language.

You can validate that a state machine definition is correct without creating a state machine resource.

Suggested uses for validate_state_machine_definition:

  • Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments.

  • Run validation from a Git pre-commit hook to verify the definition before committing to your source repository.

Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements.

The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine.

The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements.

The ValidateStateMachineDefinition API 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.

Usage

sfn_validate_state_machine_definition(definition, type, severity,
  maxResults)

Arguments

definition

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

type

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

severity

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

maxResults

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.

Value

A list with the following syntax: 

list(
  result = "OK"|"FAIL",
  diagnostics = list(
    list(
      severity = "ERROR"|"WARNING",
      code = "string",
      message = "string",
      location = "string"
    )
  ),
  truncated = TRUE|FALSE
)

Request syntax

svc$validate_state_machine_definition(
  definition = "string",
  type = "STANDARD"|"EXPRESS",
  severity = "ERROR"|"WARNING",
  maxResults = 123
)