recipes

Creates, updates, deletes, gets or lists a recipes resource.

Overview

Name	recipes
Type	Resource
Id	aws.databrew.recipes

Fields

The following fields are returned by SELECT queries:

describe_recipe

Name	Datatype	Description
create_date	string (date-time)	The date and time that the recipe was created.
created_by	string	The identifier (user name) of the user who created the recipe.
description	string	The description of the recipe.
last_modified_by	string	The identifier (user name) of the user who last modified the recipe.
last_modified_date	string (date-time)	The date and time that the recipe was last modified.
name	string	The name of the recipe.
project_name	string	The name of the project associated with this recipe.
published_by	string	The identifier (user name) of the user who last published the recipe.
published_date	string (date-time)	The date and time when the recipe was last published.
recipe_version	string	The recipe version identifier.
resource_arn	string	The ARN of the recipe.
steps	array	One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.
tags	object	Metadata tags associated with this project.

list_recipes

Name	Datatype	Description
create_date	string (date-time)	The date and time that the recipe was created.
created_by	string	The Amazon Resource Name (ARN) of the user who created the recipe.
description	string	The description of the recipe.
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last modified the recipe.
last_modified_date	string (date-time)	The last modification date and time of the recipe.
name	string	The unique name for the recipe.
project_name	string	The name of the project that the recipe is associated with.
published_by	string	The Amazon Resource Name (ARN) of the user who published the recipe.
published_date	string (date-time)	The date and time when the recipe was published.
recipe_version	string	The identifier for the version for the recipe. Must be one of the following: Numeric version (X.Y) - X and Y stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both X and Y are required, and "0.0" isn't a valid version. LATEST_WORKING - the most recent valid version being developed in a DataBrew project. LATEST_PUBLISHED - the most recent published version.
resource_arn	string	The Amazon Resource Name (ARN) for the recipe.
steps	array	A list of steps that are defined by the recipe.
tags	object	Metadata tags that have been applied to the recipe.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_recipe	select	name, region	recipeVersion	Returns the definition of a specific DataBrew recipe corresponding to a particular version.
list_recipes	select	region	maxResults, nextToken, recipeVersion	Lists all of the DataBrew recipes that are defined.
create_recipe	insert	region		Creates a new DataBrew recipe.
update_recipe	update	name, region		Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the recipe to be updated.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	The token returned by a previous call to retrieve the next set of results.
recipeVersion	string	Return only those recipes with a version identifier of LATEST_WORKING or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the LATEST_PUBLISHED recipe versions. Valid values: LATEST_WORKING | LATEST_PUBLISHED

SELECT examples

describe_recipe

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

SELECT
create_date,
created_by,
description,
last_modified_by,
last_modified_date,
name,
project_name,
published_by,
published_date,
recipe_version,
resource_arn,
steps,
tags
FROM aws.databrew.recipes
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND recipeVersion = '{{ recipeVersion }}'
;

list_recipes

Lists all of the DataBrew recipes that are defined.

SELECT
create_date,
created_by,
description,
last_modified_by,
last_modified_date,
name,
project_name,
published_by,
published_date,
recipe_version,
resource_arn,
steps,
tags
FROM aws.databrew.recipes
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND recipeVersion = '{{ recipeVersion }}'
;

INSERT examples

create_recipe

Creates a new DataBrew recipe.

INSERT INTO aws.databrew.recipes (
Description,
Name,
Steps,
Tags,
region
)
SELECT 
'{{ Description }}',
'{{ Name }}',
'{{ Steps }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: recipes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recipes resource.
  - name: Description
    value: "{{ Description }}"
  - name: Name
    value: "{{ Name }}"
  - name: Steps
    value:
      - Action:
          Operation: "{{ Operation }}"
          Parameters: "{{ Parameters }}"
        ConditionExpressions: "{{ ConditionExpressions }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_recipe

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

UPDATE aws.databrew.recipes
SET 
Description = '{{ Description }}',
Steps = '{{ Steps }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
name;