Skip to content

describe_recipe async

describe_recipe(
    name: RecipeName,
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    recipe_version: Optional[RecipeVersion] = None,
) -> DescribeRecipeResponse

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

Parameters:

  • name (RecipeName) –

    The name of the recipe to be described.

  • recipe_version (Optional[RecipeVersion], default: None ) –

    The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.

Raises:

Source code in docs_src/capo_databrew/_services/async_data_brew.py
async def describe_recipe(
    self,
    name: "capo_databrew.types.recipe_name.RecipeName",
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    recipe_version: Optional[
        "capo_databrew.types.recipe_version.RecipeVersion"
    ] = None,
) -> "capo_databrew.types.describe_recipe_response.DescribeRecipeResponse":
    """<p>Returns the definition of a specific DataBrew recipe corresponding to a particular version.</p>

    Args:
        name: <p>The name of the recipe to be described.</p>
        recipe_version: <p>The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_databrew.types.describe_recipe_request.DescribeRecipeRequest]",
    ) -> AsyncOperationResponse[
        "capo_databrew.types.describe_recipe_response.DescribeRecipeResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.describe_recipe

        (
            output,
            http_response,
        ) = await capo_databrew._operations.aws_glue_data_brew.describe_recipe.async_describe_recipe(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRecipe")
    )
    input_: capo_databrew.types.describe_recipe_request.DescribeRecipeRequest = {
        "name": name
    }
    if recipe_version is not None:
        input_["recipe_version"] = recipe_version

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output