Skip to content

Gets a list of FAQs associated with an index

Description

Gets a list of FAQs associated with an index.

Usage

kendra_list_faqs(IndexId, NextToken, MaxResults)

Arguments

  • IndexId

    [required] The index for the FAQs.

  • 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.

  • MaxResults

    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.

Value

A list with the following syntax:

list(
  NextToken = "string",
  FaqSummaryItems = list(
    list(
      Id = "string",
      Name = "string",
      Status = "CREATING"|"UPDATING"|"ACTIVE"|"DELETING"|"FAILED",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      FileFormat = "CSV"|"CSV_WITH_HEADER"|"JSON",
      LanguageCode = "string"
    )
  )
)

Request syntax

svc$list_faqs(
  IndexId = "string",
  NextToken = "string",
  MaxResults = 123
)