ValidateFlowDefinition
Validates the definition of a flow.
Request Syntax
POST /flows/validate-definition HTTP/1.1
Content-type: application/json
{
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- definition
-
The definition of a flow to validate.
Type: FlowDefinition object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"validations": [
{
"details": { ... },
"message": "string",
"severity": "string",
"type": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- validations
-
Contains an array of objects, each of which contains an error identified by validation.
Type: Array of FlowValidation objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
