|
9 | 9 | ValidateStateMachineDefinitionInput, |
10 | 10 | ValidateStateMachineDefinitionInputFilterSensitiveLog, |
11 | 11 | ValidateStateMachineDefinitionOutput, |
| 12 | + ValidateStateMachineDefinitionOutputFilterSensitiveLog, |
12 | 13 | } from "../models/models_0"; |
13 | 14 | import { |
14 | 15 | de_ValidateStateMachineDefinitionCommand, |
@@ -37,26 +38,37 @@ export interface ValidateStateMachineDefinitionCommandOutput |
37 | 38 | __MetadataBearer {} |
38 | 39 |
|
39 | 40 | /** |
40 | | - * <p>Validates the syntax of a state machine definition.</p> |
41 | | - * <p>You can validate that a state machine definition is correct without |
42 | | - * creating a state machine resource. Step Functions will implicitly perform the same |
43 | | - * syntax check when you invoke <code>CreateStateMachine</code> and |
44 | | - * <code>UpdateStateMachine</code>. State machine definitions are specified using a |
45 | | - * JSON-based, structured language. For more information on Amazon States Language see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL). </p> |
| 41 | + * <p>Validates the syntax of a state machine definition specified in <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL), a |
| 42 | + * JSON-based, structured language.</p> |
| 43 | + * <p>You can validate that a state machine definition is correct without creating a state |
| 44 | + * machine resource.</p> |
46 | 45 | * <p>Suggested uses for <code>ValidateStateMachineDefinition</code>:</p> |
47 | 46 | * <ul> |
48 | 47 | * <li> |
49 | 48 | * <p>Integrate automated checks into your code review or Continuous Integration |
50 | | - * (CI) process to validate state machine definitions before starting |
| 49 | + * (CI) process to check state machine definitions before starting |
51 | 50 | * deployments.</p> |
52 | 51 | * </li> |
53 | 52 | * <li> |
54 | | - * <p>Run the validation from a Git pre-commit hook to check your state machine |
55 | | - * definitions before committing them to your source repository.</p> |
| 53 | + * <p>Run validation from a Git pre-commit hook to verify the definition before |
| 54 | + * committing to your source repository.</p> |
56 | 55 | * </li> |
57 | 56 | * </ul> |
| 57 | + * <p>Validation will look for problems in your state machine definition and return a |
| 58 | + * <b>result</b> and a list of <b>diagnostic |
| 59 | + * elements</b>.</p> |
| 60 | + * <p>The <b>result</b> value will be <code>OK</code> when your |
| 61 | + * workflow definition can be successfully created or updated. Note the result can be |
| 62 | + * <code>OK</code> even when diagnostic warnings are present in the response. The |
| 63 | + * <b>result</b> value will be <code>FAIL</code> when the |
| 64 | + * workflow definition contains errors that would prevent you from creating or updating |
| 65 | + * your state machine. </p> |
| 66 | + * <p>The list of <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_ValidateStateMachineDefinitionDiagnostic.html">ValidateStateMachineDefinitionDiagnostic</a> data elements can contain zero or more <b>WARNING</b> and/or <b>ERROR</b> elements.</p> |
58 | 67 | * <note> |
59 | | - * <p>Errors found in the state machine definition will be returned in the response as a list of <b>diagnostic elements</b>, rather than raise an exception.</p> |
| 68 | + * <p>The <b>ValidateStateMachineDefinition API</b> might add |
| 69 | + * new diagnostics in the future, adjust diagnostic codes, or change the message |
| 70 | + * wording. Your automated processes should only rely on the value of the <b>result</b> field value (OK, FAIL). Do <b>not</b> rely on the exact order, count, or |
| 71 | + * wording of diagnostic messages.</p> |
60 | 72 | * </note> |
61 | 73 | * @example |
62 | 74 | * Use a bare-bones client and the command you need to make an API call. |
@@ -118,7 +130,7 @@ export class ValidateStateMachineDefinitionCommand extends $Command |
118 | 130 | }) |
119 | 131 | .s("AWSStepFunctions", "ValidateStateMachineDefinition", {}) |
120 | 132 | .n("SFNClient", "ValidateStateMachineDefinitionCommand") |
121 | | - .f(ValidateStateMachineDefinitionInputFilterSensitiveLog, void 0) |
| 133 | + .f(ValidateStateMachineDefinitionInputFilterSensitiveLog, ValidateStateMachineDefinitionOutputFilterSensitiveLog) |
122 | 134 | .ser(se_ValidateStateMachineDefinitionCommand) |
123 | 135 | .de(de_ValidateStateMachineDefinitionCommand) |
124 | 136 | .build() { |
|
0 commit comments