aws_sdk_kendra/client/
list_faqs.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 [`ListFaqs`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`index_id(impl Into<String>)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::set_index_id):<br>required: **true**<br><p>The index for the FAQs.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_faqs::builders::ListFaqsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.</p><br>
10    /// - On success, responds with [`ListFaqsOutput`](crate::operation::list_faqs::ListFaqsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_faqs::ListFaqsOutput::next_token): <p>If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.</p>
12    ///   - [`faq_summary_items(Option<Vec::<FaqSummary>>)`](crate::operation::list_faqs::ListFaqsOutput::faq_summary_items): <p>Summary information about the FAQs for a specified index.</p>
13    /// - On failure, responds with [`SdkError<ListFaqsError>`](crate::operation::list_faqs::ListFaqsError)
14    pub fn list_faqs(&self) -> crate::operation::list_faqs::builders::ListFaqsFluentBuilder {
15        crate::operation::list_faqs::builders::ListFaqsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_kendra/client/list_faqs.rs

aws_sdk_kendra/client/
list_faqs.rs
