Skip to content

ListDocumentsRequest

Source code in docs_src/capo_qbusiness/types/list_documents_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListDocumentsRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the application id the documents are attached to.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the index the documents are attached to.</p>"""
    data_source_ids: NotRequired["capo_qbusiness.types.data_source_ids.DataSourceIds"]
    """<p>The identifier of the data sources the documents are attached to.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<p>If the <code>maxResults</code> 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.</p>"""
    max_results: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_documents.MaxResultsIntegerForListDocuments"
    ]
    """<p>The maximum number of documents to return.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the application id the documents are attached to.

data_source_ids instance-attribute 

data_source_ids: NotRequired[DataSourceIds]

The identifier of the data sources the documents are attached to.

index_id instance-attribute 

index_id: IndexId

The identifier of the index the documents are attached to.

max_results instance-attribute 

max_results: NotRequired[MaxResultsIntegerForListDocuments]

The maximum number of documents to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.