VALIDATESTATEMACHINEDEFN()`¶

About ValidateStateMachineDefinition¶

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.

Method Signature¶

METHODS /AWS1/IF_SFN~VALIDATESTATEMACHINEDEFN
  IMPORTING
    !IV_DEFINITION TYPE /AWS1/SFNDEFINITION OPTIONAL
    !IV_TYPE TYPE /AWS1/SFNSTATEMACHINETYPE OPTIONAL
    !IV_SEVERITY TYPE /AWS1/SFNVLDTSTATEMACHINEDEF01 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SFNVLDTSTATEMACHINEDEF05 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sfnvldtstatemachine01
  RAISING
    /AWS1/CX_SFNVALIDATIONEX
    /AWS1/CX_SFNCLIENTEXC
    /AWS1/CX_SFNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_definition` `TYPE /AWS1/SFNDEFINITION` `/AWS1/SFNDEFINITION`¶

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

Optional arguments:¶

`iv_type` `TYPE /AWS1/SFNSTATEMACHINETYPE` `/AWS1/SFNSTATEMACHINETYPE`¶

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

`iv_severity` `TYPE /AWS1/SFNVLDTSTATEMACHINEDEF01` `/AWS1/SFNVLDTSTATEMACHINEDEF01`¶

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

`iv_maxresults` `TYPE /AWS1/SFNVLDTSTATEMACHINEDEF05` `/AWS1/SFNVLDTSTATEMACHINEDEF05`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sfnvldtstatemachine01` `/AWS1/CL_SFNVLDTSTATEMACHINE01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->validatestatemachinedefn(
  iv_definition = |string|
  iv_maxresults = 123
  iv_severity = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_validatestatemachinedef = lo_result->get_result( ).
  LOOP AT lo_result->get_diagnostics( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_validatestatemachinedef_1 = lo_row_1->get_severity( ).
      lv_validatestatemachinedef_2 = lo_row_1->get_code( ).
      lv_validatestatemachinedef_3 = lo_row_1->get_message( ).
      lv_validatestatemachinedef_4 = lo_row_1->get_location( ).
    ENDIF.
  ENDLOOP.
  lv_validatestatemachinedef_5 = lo_result->get_truncated( ).
ENDIF.

/AWS1/IF_SFN=>VALIDATESTATEMACHINEDEFN()¶