| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Personalize.ListRecipes
Description
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
This operation returns paginated results.
Synopsis
- data ListRecipes = ListRecipes' {}
- newListRecipes :: ListRecipes
- listRecipes_domain :: Lens' ListRecipes (Maybe Domain)
- listRecipes_maxResults :: Lens' ListRecipes (Maybe Natural)
- listRecipes_nextToken :: Lens' ListRecipes (Maybe Text)
- listRecipes_recipeProvider :: Lens' ListRecipes (Maybe RecipeProvider)
- data ListRecipesResponse = ListRecipesResponse' {
- nextToken :: Maybe Text
- recipes :: Maybe [RecipeSummary]
- httpStatus :: Int
- newListRecipesResponse :: Int -> ListRecipesResponse
- listRecipesResponse_nextToken :: Lens' ListRecipesResponse (Maybe Text)
- listRecipesResponse_recipes :: Lens' ListRecipesResponse (Maybe [RecipeSummary])
- listRecipesResponse_httpStatus :: Lens' ListRecipesResponse Int
Creating a Request
data ListRecipes Source #
See: newListRecipes smart constructor.
Constructors
| ListRecipes' | |
Fields
| |
Instances
newListRecipes :: ListRecipes Source #
Create a value of ListRecipes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecipes, listRecipes_domain - 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.
$sel:maxResults:ListRecipes', listRecipes_maxResults - The maximum number of recipes to return.
ListRecipes, listRecipes_nextToken - A token returned from the previous call to ListRecipes for getting the
next set of recipes (if they exist).
$sel:recipeProvider:ListRecipes', listRecipes_recipeProvider - The default is SERVICE.
Request Lenses
listRecipes_domain :: Lens' ListRecipes (Maybe Domain) Source #
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.
listRecipes_maxResults :: Lens' ListRecipes (Maybe Natural) Source #
The maximum number of recipes to return.
listRecipes_nextToken :: Lens' ListRecipes (Maybe Text) Source #
A token returned from the previous call to ListRecipes for getting the
next set of recipes (if they exist).
listRecipes_recipeProvider :: Lens' ListRecipes (Maybe RecipeProvider) Source #
The default is SERVICE.
Destructuring the Response
data ListRecipesResponse Source #
See: newListRecipesResponse smart constructor.
Constructors
| ListRecipesResponse' | |
Fields
| |
Instances
newListRecipesResponse Source #
Arguments
| :: Int | |
| -> ListRecipesResponse |
Create a value of ListRecipesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecipes, listRecipesResponse_nextToken - A token for getting the next set of recipes.
$sel:recipes:ListRecipesResponse', listRecipesResponse_recipes - The list of available recipes.
$sel:httpStatus:ListRecipesResponse', listRecipesResponse_httpStatus - The response's http status code.
Response Lenses
listRecipesResponse_nextToken :: Lens' ListRecipesResponse (Maybe Text) Source #
A token for getting the next set of recipes.
listRecipesResponse_recipes :: Lens' ListRecipesResponse (Maybe [RecipeSummary]) Source #
The list of available recipes.
listRecipesResponse_httpStatus :: Lens' ListRecipesResponse Int Source #
The response's http status code.