CreateRecipe
Creates a new DataBrew recipe.
Request Syntax
POST /recipes HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Name": "string",
"Steps": [
{
"Action": {
"Operation": "string",
"Parameters": {
"string" : "string"
}
},
"ConditionExpressions": [
{
"Condition": "string",
"TargetColumn": "string",
"Value": "string"
}
]
}
],
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Name
-
A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Steps
-
An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions.
Type: Array of RecipeStep objects
Required: Yes
- Description
-
A description for the recipe.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- Tags
-
Metadata tags to apply to this recipe.
Type: String to string map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Name": "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.
- Name
-
The name of the recipe that you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- ServiceQuotaExceededException
-
A service quota is exceeded.
HTTP Status Code: 402
- ValidationException
-
The input parameters for this request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
