list_faqs `async` ¶

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

Gets a list of FAQs associated with an index.

Parameters:

index_id (IndexId) –

The index for the FAQs.
next_token (Optional[NextToken], default: None ) –

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.
max_results (Optional[MaxResultsIntegerForListFaqsRequest], default: None ) –

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.

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
InternalServerException –

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
ResourceNotFoundException –

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
ThrottlingException –

The request was denied due to request throttling. Please reduce the number of requests and try again.
ValidationException –

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
UnknownServiceError –

The service returned an error code this client does not model.

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

async def list_faqs(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    *,
    config_overrides: Optional[AsynckendraClientConfig] = 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,
) -> "capo_kendra.types.list_faqs_response.ListFaqsResponse":
    """<p>Gets a list of FAQs associated with an index.</p>

    Args:
        index_id: <p>The index for the FAQs.</p>
        next_token: <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: <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>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kendra.types.list_faqs_request.ListFaqsRequest]",
    ) -> AsyncOperationResponse[
        "capo_kendra.types.list_faqs_response.ListFaqsResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.list_faqs

        (
            output,
            http_response,
        ) = await capo_kendra._operations.aws_kendra_frontend_service.list_faqs.async_list_faqs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFaqs")
    )
    input_: capo_kendra.types.list_faqs_request.ListFaqsRequest = {
        "index_id": index_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_faqs async ¶

list_faqs `async` ¶