aws_sdk_bedrockagent/client/
list_knowledge_base_documents.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListKnowledgeBaseDocuments`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`knowledge_base_id(impl Into<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::knowledge_base_id) / [`set_knowledge_base_id(Option<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::set_knowledge_base_id):<br>required: **true**<br><p>The unique identifier of the knowledge base that is connected to the data source.</p><br>
    ///   - [`data_source_id(impl Into<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::set_data_source_id):<br>required: **true**<br><p>The unique identifier of the data source that contains the documents.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p><br>
    /// - On success, responds with [`ListKnowledgeBaseDocumentsOutput`](crate::operation::list_knowledge_base_documents::ListKnowledgeBaseDocumentsOutput) with field(s):
    ///   - [`document_details(Vec::<KnowledgeBaseDocumentDetail>)`](crate::operation::list_knowledge_base_documents::ListKnowledgeBaseDocumentsOutput::document_details): <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_knowledge_base_documents::ListKnowledgeBaseDocumentsOutput::next_token): <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
    /// - On failure, responds with [`SdkError<ListKnowledgeBaseDocumentsError>`](crate::operation::list_knowledge_base_documents::ListKnowledgeBaseDocumentsError)
    pub fn list_knowledge_base_documents(
        &self,
    ) -> crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder {
        crate::operation::list_knowledge_base_documents::builders::ListKnowledgeBaseDocumentsFluentBuilder::new(self.handle.clone())
    }
}