Skip to content

Recipe

Source code in docs_src/capo_databrew/types/recipe.py
class Recipe(TypedDict, closed=True):
    created_by: NotRequired["capo_databrew.types.created_by.CreatedBy"]
    """<p>The Amazon Resource Name (ARN) of the user who created the recipe.</p>"""
    create_date: NotRequired["capo_databrew.types.date.Date"]
    """<p>The date and time that the recipe was created.</p>"""
    last_modified_by: NotRequired["capo_databrew.types.last_modified_by.LastModifiedBy"]
    """<p>The Amazon Resource Name (ARN) of the user who last modified the recipe.</p>"""
    last_modified_date: NotRequired["capo_databrew.types.date.Date"]
    """<p>The last modification date and time of the recipe.</p>"""
    project_name: NotRequired["capo_databrew.types.project_name.ProjectName"]
    """<p>The name of the project that the recipe is associated with.</p>"""
    published_by: NotRequired["capo_databrew.types.published_by.PublishedBy"]
    """<p>The Amazon Resource Name (ARN) of the user who published the recipe.</p>"""
    published_date: NotRequired["capo_databrew.types.date.Date"]
    """<p>The date and time when the recipe was published.</p>"""
    description: NotRequired["capo_databrew.types.recipe_description.RecipeDescription"]
    """<p>The description of the recipe.</p>"""
    name: "capo_databrew.types.recipe_name.RecipeName"
    """<p>The unique name for the recipe.</p>"""
    resource_arn: NotRequired["capo_databrew.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) for the recipe.</p>"""
    steps: NotRequired["capo_databrew.types.recipe_step_list.RecipeStepList"]
    """<p>A list of steps that are defined by the recipe.</p>"""
    tags: NotRequired["capo_databrew.types.tag_map.TagMap"]
    """<p>Metadata tags that have been applied to the recipe.</p>"""
    recipe_version: NotRequired["capo_databrew.types.recipe_version.RecipeVersion"]
    """<p>The identifier for the version for the recipe. Must be one of the following:</p> <ul> <li> <p>Numeric version (<code>X.Y</code>) - <code>X</code> and <code>Y</code> stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both <code>X</code> and <code>Y</code> are required, and "0.0" isn't a valid version.</p> </li> <li> <p> <code>LATEST_WORKING</code> - the most recent valid version being developed in a DataBrew project.</p> </li> <li> <p> <code>LATEST_PUBLISHED</code> - the most recent published version.</p> </li> </ul>"""

create_date instance-attribute

create_date: NotRequired[Date]

The date and time that the recipe was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The Amazon Resource Name (ARN) of the user who created the recipe.

description instance-attribute

description: NotRequired[RecipeDescription]

The description of the recipe.

last_modified_by instance-attribute

last_modified_by: NotRequired[LastModifiedBy]

The Amazon Resource Name (ARN) of the user who last modified the recipe.

last_modified_date instance-attribute

last_modified_date: NotRequired[Date]

The last modification date and time of the recipe.

name instance-attribute

name: RecipeName

The unique name for the recipe.

project_name instance-attribute

project_name: NotRequired[ProjectName]

The name of the project that the recipe is associated with.

published_by instance-attribute

published_by: NotRequired[PublishedBy]

The Amazon Resource Name (ARN) of the user who published the recipe.

published_date instance-attribute

published_date: NotRequired[Date]

The date and time when the recipe was published.

recipe_version instance-attribute

recipe_version: NotRequired[RecipeVersion]

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 instance-attribute

resource_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) for the recipe.

steps instance-attribute

steps: NotRequired[RecipeStepList]

A list of steps that are defined by the recipe.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata tags that have been applied to the recipe.