Skip to content

ListIndicesRequest

Source code in docs_src/capo_qbusiness/types/list_indices_request.py 
13
14
15
16
17
18
19
20
21
class ListIndicesRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application connected to the index.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<p>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 Amazon Q Business indices.</p>"""
    max_results: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_indices.MaxResultsIntegerForListIndices"
    ]
    """<p>The maximum number of indices to return.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the Amazon Q Business application connected to the index.

max_results instance-attribute 

max_results: NotRequired[MaxResultsIntegerForListIndices]

The maximum number of indices 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 Amazon Q Business indices.