Skip to content

ListFaqsRequest

Source code in docs_src/capo_kendra/types/list_faqs_request.py 
15
16
17
18
19
20
21
22
23
class ListFaqsRequest(TypedDict, closed=True):
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The index for the FAQs.</p>"""
    next_token: NotRequired["capo_kendra.types.next_token.NextToken"]
    """<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.</p>"""
    max_results: NotRequired[
        "capo_kendra.types.max_results_integer_for_list_faqs_request.MaxResultsIntegerForListFaqsRequest"
    ]
    """<p>The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.</p>"""

index_id instance-attribute 

index_id: IndexId

The index for the FAQs.

max_results instance-attribute 

max_results: NotRequired[MaxResultsIntegerForListFaqsRequest]

The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.