Skip to content

Bedrock Agent  >  Operations  >  list_knowledge_base_documents

list_knowledge_base_documents

Operation

list_knowledge_base_documents async 

list_knowledge_base_documents(input: ListKnowledgeBaseDocumentsInput, plugins: list[Plugin] | None = None) -> ListKnowledgeBaseDocumentsOutput

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
input ListKnowledgeBaseDocumentsInput

An instance of ListKnowledgeBaseDocumentsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListKnowledgeBaseDocumentsOutput

An instance of ListKnowledgeBaseDocumentsOutput.

Input

ListKnowledgeBaseDocumentsInput dataclass

Dataclass for ListKnowledgeBaseDocumentsInput structure.

Attributes

data_source_id class-attribute instance-attribute 
data_source_id: str | None = None

The unique identifier of the data source that contains the documents.

knowledge_base_id class-attribute instance-attribute 
knowledge_base_id: str | None = None

The unique identifier of the knowledge base that is connected to the data source.

max_results class-attribute instance-attribute 
max_results: int | None = None

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 nextToken field when making another request to return the next batch of results.

next_token class-attribute instance-attribute 
next_token: str | None = None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListKnowledgeBaseDocumentsOutput dataclass

Dataclass for ListKnowledgeBaseDocumentsOutput structure.

Attributes

document_details instance-attribute 
document_details: list[KnowledgeBaseDocumentDetail]

A list of objects, each of which contains information about the documents that were retrieved.

next_token class-attribute instance-attribute 
next_token: str | None = None

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.