- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateRecipeCommand
Creates a new DataBrew recipe.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataBrewClient, CreateRecipeCommand } from "@aws-sdk/client-databrew"; // ES Modules import
// const { DataBrewClient, CreateRecipeCommand } = require("@aws-sdk/client-databrew"); // CommonJS import
const client = new DataBrewClient(config);
const input = { // CreateRecipeRequest
Description: "STRING_VALUE",
Name: "STRING_VALUE", // required
Steps: [ // RecipeStepList // required
{ // RecipeStep
Action: { // RecipeAction
Operation: "STRING_VALUE", // required
Parameters: { // ParameterMap
"<keys>": "STRING_VALUE",
},
},
ConditionExpressions: [ // ConditionExpressionList
{ // ConditionExpression
Condition: "STRING_VALUE", // required
Value: "STRING_VALUE",
TargetColumn: "STRING_VALUE", // required
},
],
},
],
Tags: { // TagMap
"<keys>": "STRING_VALUE",
},
};
const command = new CreateRecipeCommand(input);
const response = await client.send(command);
// { // CreateRecipeResponse
// Name: "STRING_VALUE", // required
// };
CreateRecipeCommand Input
See CreateRecipeCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Name Required | string | undefined | A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. |
Steps Required | RecipeStep[] | undefined | 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. |
Description | string | undefined | A description for the recipe. |
Tags | Record<string, string> | undefined | Metadata tags to apply to this recipe. |
CreateRecipeCommand Output
See CreateRecipeCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Name Required | string | undefined | The name of the recipe that you created. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
ServiceQuotaExceededException | client | A service quota is exceeded. |
ValidationException | client | The input parameters for this request failed validation. |
DataBrewServiceException | Base exception class for all service exceptions from DataBrew service. |