Skip to content

ListRetrieversRequest

Source code in docs_src/capo_qbusiness/types/list_retrievers_request.py 
13
14
15
16
17
18
19
20
21
class ListRetrieversRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application using the retriever.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.</p>"""
    max_results: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_retrievers_request.MaxResultsIntegerForListRetrieversRequest"
    ]
    """<p>The maximum number of retrievers returned.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the Amazon Q Business application using the retriever.

max_results instance-attribute 

max_results: NotRequired[MaxResultsIntegerForListRetrieversRequest]

The maximum number of retrievers returned.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.