Container for the parameters to the ValidateStateMachineDefinition operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.StepFunctions.AmazonStepFunctionsRequest
Amazon.StepFunctions.Model.ValidateStateMachineDefinitionRequest
Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
Syntax
public class ValidateStateMachineDefinitionRequest : AmazonStepFunctionsRequest IAmazonWebServiceRequest
The ValidateStateMachineDefinitionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ValidateStateMachineDefinitionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Definition | System.String |
Gets and sets the property Definition. The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL). |
|
|
MaxResults | System.Int32 |
Gets and sets the property 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 |
|
|
Severity | Amazon.StepFunctions.ValidateStateMachineDefinitionSeverity |
Gets and sets the property Severity.
Minimum level of diagnostics to return. |
|
|
Type | Amazon.StepFunctions.StateMachineType |
Gets and sets the property Type.
The target type of state machine for this definition. The default is |
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