list_documents¶
Operation¶
async
¶
list_documents(input: ListDocumentsInput, plugins: list[Plugin] | None = None) -> ListDocumentsOutput
A list of documents attached to an index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDocumentsInput
|
An instance of |
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 |
|---|---|
ListDocumentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListDocumentsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the application id the documents are attached to.
class-attribute
instance-attribute
¶
data_source_ids: list[str] | None = None
The identifier of the data sources the documents are attached to.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index the documents are attached to.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of documents to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults response was incomplete because there is more data
to retrieve, Amazon Q Business returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
documents.
Output¶
dataclass
¶
Dataclass for ListDocumentsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
document_detail_list: list[DocumentDetails] | None = None
A list of document details.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults response was incomplete because there is more data
to retrieve, Amazon Q Business returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
documents.