aws_sdk_personalize/client/
list_recipes.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListRecipes`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`recipe_provider(RecipeProvider)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::recipe_provider) / [`set_recipe_provider(Option<RecipeProvider>)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::set_recipe_provider):<br>required: **false**<br><p>The default is <code>SERVICE</code>.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from the previous call to <code>ListRecipes</code> for getting the next set of recipes (if they exist).</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of recipes to return.</p><br>
10    ///   - [`domain(Domain)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::domain) / [`set_domain(Option<Domain>)`](crate::operation::list_recipes::builders::ListRecipesFluentBuilder::set_domain):<br>required: **false**<br><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><br>
11    /// - On success, responds with [`ListRecipesOutput`](crate::operation::list_recipes::ListRecipesOutput) with field(s):
12    ///   - [`recipes(Option<Vec::<RecipeSummary>>)`](crate::operation::list_recipes::ListRecipesOutput::recipes): <p>The list of available recipes.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_recipes::ListRecipesOutput::next_token): <p>A token for getting the next set of recipes.</p>
14    /// - On failure, responds with [`SdkError<ListRecipesError>`](crate::operation::list_recipes::ListRecipesError)
15    pub fn list_recipes(&self) -> crate::operation::list_recipes::builders::ListRecipesFluentBuilder {
16        crate::operation::list_recipes::builders::ListRecipesFluentBuilder::new(self.handle.clone())
17    }
18}