aws_sdk_kendra/client/list_featured_results_sets.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 [`ListFeaturedResultsSets`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`index_id(impl Into<String>)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index used for featuring results.</p><br>
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of featured results sets to return.</p><br>
9 /// - On success, responds with [`ListFeaturedResultsSetsOutput`](crate::operation::list_featured_results_sets::ListFeaturedResultsSetsOutput) with field(s):
10 /// - [`featured_results_set_summary_items(Option<Vec::<FeaturedResultsSetSummary>>)`](crate::operation::list_featured_results_sets::ListFeaturedResultsSetsOutput::featured_results_set_summary_items): <p>An array of summary information for one or more featured results sets.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_featured_results_sets::ListFeaturedResultsSetsOutput::next_token): <p>If the response is truncated, Amazon Kendra returns a pagination token in the response.</p>
12 /// - On failure, responds with [`SdkError<ListFeaturedResultsSetsError>`](crate::operation::list_featured_results_sets::ListFeaturedResultsSetsError)
13 pub fn list_featured_results_sets(&self) -> crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder {
14 crate::operation::list_featured_results_sets::builders::ListFeaturedResultsSetsFluentBuilder::new(self.handle.clone())
15 }
16}