Module Values.ValidateStateMachineDefinitionOutputSource

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 ValidateStateMachineDefinition: 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.

Sourcetype nonrec t = {
  1. result : ValidateStateMachineDefinitionResultCode.t option;
    (*

    The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

    *)
  2. diagnostics : ValidateStateMachineDefinitionDiagnosticList.t option;
    (*

    An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.

    *)
  3. truncated : ValidateStateMachineDefinitionTruncated.t option;
    (*

    The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

    *)
}
Sourcetype nonrec error = [
  1. | `ValidationException of ValidationException.t
  2. | `Unknown_operation_error of string * string option
]
Sourceval make : ?result:??? -> ?diagnostics:??? -> ?truncated:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of ValidateStateMachineDefinitionTruncated.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of ValidateStateMachineDefinitionCode.t ]) list ] list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t