Skip to content

update_recipe

update_recipe(
    name: RecipeName,
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[RecipeDescription] = None,
    steps: Optional[RecipeStepList] = None,
) -> UpdateRecipeResponse

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

Parameters:

  • description (Optional[RecipeDescription], default: None ) –

    A description of the recipe.

  • name (RecipeName) –

    The name of the recipe to be updated.

  • steps (Optional[RecipeStepList], default: None ) –

    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.

Raises:

Source code in docs_src/capo_databrew/_services/data_brew.py
def update_recipe(
    self,
    name: "capo_databrew.types.recipe_name.RecipeName",
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[
        "capo_databrew.types.recipe_description.RecipeDescription"
    ] = None,
    steps: Optional["capo_databrew.types.recipe_step_list.RecipeStepList"] = None,
) -> "capo_databrew.types.update_recipe_response.UpdateRecipeResponse":
    """<p>Modifies the definition of the <code>LATEST_WORKING</code> version of a DataBrew recipe.</p>

    Args:
        description: <p>A description of the recipe.</p>
        name: <p>The name of the recipe to be updated.</p>
        steps: <p>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.</p>

    Raises:
        capo_databrew.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_databrew.errors.validation_exception.ValidationException: <p>The input parameters for this request failed validation.</p>
        capo_databrew.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_databrew.types.update_recipe_request.UpdateRecipeRequest]",
    ) -> OperationResponse[
        "capo_databrew.types.update_recipe_response.UpdateRecipeResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.update_recipe

        output, http_response = (
            capo_databrew._operations.aws_glue_data_brew.update_recipe.update_recipe(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRecipe")
    )
    input_: capo_databrew.types.update_recipe_request.UpdateRecipeRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if steps is not None:
        input_["steps"] = steps

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output