updateRecipe

Updates a specific data prep recipe by ID.

updateRecipe uses this Data Prep Recipe API resource.

Parameter NameTypeDescriptionRequired?
idStringThe ID of the recipe.Yes
recipeObjectObjectThe recipe to update. Use a Recipe Input resource.Yes
  • A Promise object that resolves with the Recipe response.

Use updateRecipe to allow users to change licenses, labels, and more. This example adds an update button to a page with recipes. The page must contain form elements for the information required to update the recipe. Updating a recipe displays a toast message using the lightning/platformShowToastEvent module.

This button calls the updateRecipe() method.