list_recipes `async` ¶

list_recipes(
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    max_results: Optional[MaxResults100] = None,
    next_token: Optional[NextToken] = None,
    recipe_version: Optional[RecipeVersion] = None,
) -> ListRecipesResponse

Lists all of the DataBrew recipes that are defined.

Parameters:

max_results (Optional[MaxResults100], default: None ) –

The maximum number of results to return in this request.
next_token (Optional[NextToken], default: None ) –

The token returned by a previous call to retrieve the next set of results.
recipe_version (Optional[RecipeVersion], default: None ) –

Return only those recipes with a version identifier of LATEST_WORKING or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the LATEST_PUBLISHED recipe versions.

Valid values: LATEST_WORKING | LATEST_PUBLISHED

Raises:

ValidationException –

The input parameters for this request failed validation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_databrew/_services/async_data_brew.py

async def list_recipes(
    self,
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    max_results: Optional[
        "capo_databrew.types.max_results100.MaxResults100"
    ] = None,
    next_token: Optional["capo_databrew.types.next_token.NextToken"] = None,
    recipe_version: Optional[
        "capo_databrew.types.recipe_version.RecipeVersion"
    ] = None,
) -> "capo_databrew.types.list_recipes_response.ListRecipesResponse":
    """<p>Lists all of the DataBrew recipes that are defined.</p>

    Args:
        max_results: <p>The maximum number of results to return in this request. </p>
        next_token: <p>The token returned by a previous call to retrieve the next set of results.</p>
        recipe_version: <p>Return only those recipes with a version identifier of <code>LATEST_WORKING</code> or <code>LATEST_PUBLISHED</code>. If <code>RecipeVersion</code> is omitted, <code>ListRecipes</code> returns all of the <code>LATEST_PUBLISHED</code> recipe versions.</p> <p>Valid values: <code>LATEST_WORKING</code> | <code>LATEST_PUBLISHED</code> </p>

    Raises:
        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.list_recipes_request.ListRecipesRequest]",
    ) -> AsyncOperationResponse[
        "capo_databrew.types.list_recipes_response.ListRecipesResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.list_recipes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecipes")
    )
    input_: capo_databrew.types.list_recipes_request.ListRecipesRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    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

list_recipes async ¶

list_recipes `async` ¶