iter_list_faqs ¶

iter_list_faqs(
    index_id: IndexId,
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsIntegerForListFaqsRequest] = None,
) -> Iterator[ListFaqsResponse]

Source code in docs_src/capo_kendra/_services/kendra.py

def iter_list_faqs(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    next_token: Optional["capo_kendra.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_kendra.types.max_results_integer_for_list_faqs_request.MaxResultsIntegerForListFaqsRequest"
    ] = None,
) -> "Iterator[capo_kendra.types.list_faqs_response.ListFaqsResponse]":
    _token = next_token
    while True:
        _response = self.list_faqs(
            index_id,
            config_overrides=config_overrides,
            next_token=_token,
            max_results=max_results,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break