|
140 | 140 | }, |
141 | 141 | { |
142 | 142 | "target": "com.amazonaws.sfn#UpdateStateMachineAlias" |
| 143 | + }, |
| 144 | + { |
| 145 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinition" |
143 | 146 | } |
144 | 147 | ], |
145 | 148 | "traits": { |
|
5304 | 5307 | }, |
5305 | 5308 | { |
5306 | 5309 | "target": "com.amazonaws.sfn#InvalidArn" |
| 5310 | + }, |
| 5311 | + { |
| 5312 | + "target": "com.amazonaws.sfn#ValidationException" |
5307 | 5313 | } |
5308 | 5314 | ], |
5309 | 5315 | "traits": { |
|
7193 | 7199 | "smithy.api#output": {} |
7194 | 7200 | } |
7195 | 7201 | }, |
| 7202 | + "com.amazonaws.sfn#ValidateStateMachineDefinition": { |
| 7203 | + "type": "operation", |
| 7204 | + "input": { |
| 7205 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionInput" |
| 7206 | + }, |
| 7207 | + "output": { |
| 7208 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionOutput" |
| 7209 | + }, |
| 7210 | + "errors": [ |
| 7211 | + { |
| 7212 | + "target": "com.amazonaws.sfn#ValidationException" |
| 7213 | + } |
| 7214 | + ], |
| 7215 | + "traits": { |
| 7216 | + "smithy.api#documentation": "<p>Validates the syntax of a state machine definition.</p>\n <p>You can validate that a state machine definition is correct without \n creating a state machine resource. Step Functions will implicitly perform the same\n syntax check when you invoke <code>CreateStateMachine</code> and\n <code>UpdateStateMachine</code>. State machine definitions are specified using a\n 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>\n <p>Suggested uses for <code>ValidateStateMachineDefinition</code>:</p>\n <ul>\n <li>\n <p>Integrate automated checks into your code review or Continuous Integration\n (CI) process to validate state machine definitions before starting\n deployments.</p>\n </li>\n <li>\n <p>Run the validation from a Git pre-commit hook to check your state machine\n definitions before committing them to your source repository.</p>\n </li>\n </ul>\n <note>\n <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>\n </note>" |
| 7217 | + } |
| 7218 | + }, |
| 7219 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionCode": { |
| 7220 | + "type": "string" |
| 7221 | + }, |
| 7222 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnostic": { |
| 7223 | + "type": "structure", |
| 7224 | + "members": { |
| 7225 | + "severity": { |
| 7226 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionSeverity", |
| 7227 | + "traits": { |
| 7228 | + "smithy.api#documentation": "<p>A value of <code>ERROR</code> means that you cannot create or update a state machine with this definition.</p>", |
| 7229 | + "smithy.api#required": {} |
| 7230 | + } |
| 7231 | + }, |
| 7232 | + "code": { |
| 7233 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionCode", |
| 7234 | + "traits": { |
| 7235 | + "smithy.api#documentation": "<p>Identifying code for the diagnostic.</p>", |
| 7236 | + "smithy.api#required": {} |
| 7237 | + } |
| 7238 | + }, |
| 7239 | + "message": { |
| 7240 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionMessage", |
| 7241 | + "traits": { |
| 7242 | + "smithy.api#documentation": "<p>Message describing the diagnostic condition.</p>", |
| 7243 | + "smithy.api#required": {} |
| 7244 | + } |
| 7245 | + }, |
| 7246 | + "location": { |
| 7247 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionLocation", |
| 7248 | + "traits": { |
| 7249 | + "smithy.api#documentation": "<p>Location of the issue in the state machine, if available.</p>\n <p>For errors specific to a field, the location could be in the format: <code>/States/<StateName>/<FieldName></code>, for example: <code>/States/FailState/ErrorPath</code>.</p>" |
| 7250 | + } |
| 7251 | + } |
| 7252 | + }, |
| 7253 | + "traits": { |
| 7254 | + "smithy.api#documentation": "<p>Describes an error found during validation. Validation errors found in the definition\n return in the response as <b>diagnostic elements</b>, rather\n than raise an exception.</p>" |
| 7255 | + } |
| 7256 | + }, |
| 7257 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnosticList": { |
| 7258 | + "type": "list", |
| 7259 | + "member": { |
| 7260 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnostic" |
| 7261 | + } |
| 7262 | + }, |
| 7263 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionInput": { |
| 7264 | + "type": "structure", |
| 7265 | + "members": { |
| 7266 | + "definition": { |
| 7267 | + "target": "com.amazonaws.sfn#Definition", |
| 7268 | + "traits": { |
| 7269 | + "smithy.api#documentation": "<p>The Amazon States Language definition of the state machine. For more information, see\n <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html\">Amazon States Language</a> (ASL).</p>", |
| 7270 | + "smithy.api#required": {} |
| 7271 | + } |
| 7272 | + }, |
| 7273 | + "type": { |
| 7274 | + "target": "com.amazonaws.sfn#StateMachineType", |
| 7275 | + "traits": { |
| 7276 | + "smithy.api#documentation": "<p>The target type of state machine for this definition. The default is <code>STANDARD</code>.</p>" |
| 7277 | + } |
| 7278 | + } |
| 7279 | + }, |
| 7280 | + "traits": { |
| 7281 | + "smithy.api#input": {} |
| 7282 | + } |
| 7283 | + }, |
| 7284 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionLocation": { |
| 7285 | + "type": "string" |
| 7286 | + }, |
| 7287 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionMessage": { |
| 7288 | + "type": "string" |
| 7289 | + }, |
| 7290 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionOutput": { |
| 7291 | + "type": "structure", |
| 7292 | + "members": { |
| 7293 | + "result": { |
| 7294 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionResultCode", |
| 7295 | + "traits": { |
| 7296 | + "smithy.api#documentation": "<p>The result value will be <code>OK</code> when no syntax errors are found, or\n <code>FAIL</code> if the workflow definition does not pass verification.</p>", |
| 7297 | + "smithy.api#required": {} |
| 7298 | + } |
| 7299 | + }, |
| 7300 | + "diagnostics": { |
| 7301 | + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnosticList", |
| 7302 | + "traits": { |
| 7303 | + "smithy.api#documentation": "<p>If the result is <code>OK</code>, this field will be empty. When there are errors,\n this field will contain an array of <b>Diagnostic</b> objects\n to help you troubleshoot.</p>", |
| 7304 | + "smithy.api#required": {} |
| 7305 | + } |
| 7306 | + } |
| 7307 | + }, |
| 7308 | + "traits": { |
| 7309 | + "smithy.api#output": {} |
| 7310 | + } |
| 7311 | + }, |
| 7312 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionResultCode": { |
| 7313 | + "type": "enum", |
| 7314 | + "members": { |
| 7315 | + "OK": { |
| 7316 | + "target": "smithy.api#Unit", |
| 7317 | + "traits": { |
| 7318 | + "smithy.api#enumValue": "OK" |
| 7319 | + } |
| 7320 | + }, |
| 7321 | + "FAIL": { |
| 7322 | + "target": "smithy.api#Unit", |
| 7323 | + "traits": { |
| 7324 | + "smithy.api#enumValue": "FAIL" |
| 7325 | + } |
| 7326 | + } |
| 7327 | + } |
| 7328 | + }, |
| 7329 | + "com.amazonaws.sfn#ValidateStateMachineDefinitionSeverity": { |
| 7330 | + "type": "enum", |
| 7331 | + "members": { |
| 7332 | + "ERROR": { |
| 7333 | + "target": "smithy.api#Unit", |
| 7334 | + "traits": { |
| 7335 | + "smithy.api#enumValue": "ERROR" |
| 7336 | + } |
| 7337 | + } |
| 7338 | + } |
| 7339 | + }, |
7196 | 7340 | "com.amazonaws.sfn#ValidationException": { |
7197 | 7341 | "type": "structure", |
7198 | 7342 | "members": { |
|
0 commit comments