kendra / Client / list_faqs

list_faqs#

kendra.Client.list_faqs(**kwargs)#

Gets a list of FAQ lists associated with an index.

See also: AWS API Documentation

Request Syntax

response = client.list_faqs(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • IndexId (string) –

    [REQUIRED]

    The index that contains the FAQ lists.

  • NextToken (string) – 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.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'FaqSummaryItems': [
        {
            'Id': 'string',
            'Name': 'string',
            'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'FileFormat': 'CSV'|'CSV_WITH_HEADER'|'JSON',
            'LanguageCode': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

    • FaqSummaryItems (list) –

      information about the FAQs associated with the specified index.

      • (dict) –

        Summary information for frequently asked questions and answers included in an index.

        • Id (string) –

          The identifier of the FAQ.

        • Name (string) –

          The name that you assigned the FAQ when you created or updated the FAQ.

        • Status (string) –

          The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

        • CreatedAt (datetime) –

          The Unix timestamp when the FAQ was created.

        • UpdatedAt (datetime) –

          The Unix timestamp when the FAQ was last updated.

        • FileFormat (string) –

          The file type used to create the FAQ.

        • LanguageCode (string) –

          The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Exceptions