recipe_versions
Creates, updates, deletes, gets or lists a recipe_versions resource.
Overview
| Name | recipe_versions |
| Type | Resource |
| Id | aws.databrew.recipe_versions |
Fields
The following fields are returned by SELECT queries:
- list_recipe_versions
| 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 |
|---|---|---|---|---|
list_recipe_versions | select | name, region | maxResults, nextToken | Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING. |
delete_recipe_version | delete | name, recipe_version, region | Deletes a single 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. |
recipe_version | string | The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported. |
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. |
SELECT examples
- list_recipe_versions
Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.
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.recipe_versions
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;
DELETE examples
- delete_recipe_version
Deletes a single version of a DataBrew recipe.
DELETE FROM aws.databrew.recipe_versions
WHERE name = '{{ name }}' --required
AND recipe_version = '{{ recipe_version }}' --required
AND region = '{{ region }}' --required
;