aws_sdk_personalize/client/list_recommenders.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 [`ListRecommenders`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`dataset_group_arn(impl Into<String>)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::dataset_group_arn) / [`set_dataset_group_arn(Option<String>)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::set_dataset_group_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from the previous call to <code>ListRecommenders</code> for getting the next set of recommenders (if they exist).</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of recommenders to return.</p><br>
10 /// - On success, responds with [`ListRecommendersOutput`](crate::operation::list_recommenders::ListRecommendersOutput) with field(s):
11 /// - [`recommenders(Option<Vec::<RecommenderSummary>>)`](crate::operation::list_recommenders::ListRecommendersOutput::recommenders): <p>A list of the recommenders.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_recommenders::ListRecommendersOutput::next_token): <p>A token for getting the next set of recommenders (if they exist).</p>
13 /// - On failure, responds with [`SdkError<ListRecommendersError>`](crate::operation::list_recommenders::ListRecommendersError)
14 pub fn list_recommenders(&self) -> crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder {
15 crate::operation::list_recommenders::builders::ListRecommendersFluentBuilder::new(self.handle.clone())
16 }
17}