list_recipes `async` ¶

list_recipes(
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    recipe_provider: Optional[RecipeProvider] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    domain: Optional[Domain] = None,
) -> ListRecipesResponse

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Parameters:

recipe_provider (Optional[RecipeProvider], default: None ) –

The default is SERVICE.
next_token (Optional[NextToken], default: None ) –

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
max_results (Optional[MaxResults], default: None ) –

The maximum number of recipes to return.
domain (Optional[Domain], default: None ) –

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
InvalidNextTokenException –

The token is not valid.
UnknownServiceError –

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

Source code in docs_src/capo_personalize/_services/async_personalize.py

async def list_recipes(
    self,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    recipe_provider: Optional[
        "capo_personalize.types.recipe_provider.RecipeProvider"
    ] = None,
    next_token: Optional["capo_personalize.types.next_token.NextToken"] = None,
    max_results: Optional["capo_personalize.types.max_results.MaxResults"] = None,
    domain: Optional["capo_personalize.types.domain.Domain"] = None,
) -> "capo_personalize.types.list_recipes_response.ListRecipesResponse":
    """<p>Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).</p>

    Args:
        recipe_provider: <p>The default is <code>SERVICE</code>.</p>
        next_token: <p>A token returned from the previous call to <code>ListRecipes</code> for getting the next set of recipes (if they exist).</p>
        max_results: <p>The maximum number of recipes to return.</p>
        domain: <p> Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned. </p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.list_recipes_request.ListRecipesRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.list_recipes_response.ListRecipesResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_recipes

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.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_personalize.types.list_recipes_request.ListRecipesRequest = {}
    if recipe_provider is not None:
        input_["recipe_provider"] = recipe_provider
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if domain is not None:
        input_["domain"] = domain

    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` ¶