Describe Faq

kendra_describe_faq

R Documentation

Gets information about a FAQ¶

Description¶

Gets information about a FAQ.

Usage¶

kendra_describe_faq(Id, IndexId)

Arguments¶

Id

[required] The identifier of the FAQ you want to get information on.

IndexId

[required] The identifier of the index for the FAQ.

Value¶

A list with the following syntax:

list(
  Id = "string",
  IndexId = "string",
  Name = "string",
  Description = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  S3Path = list(
    Bucket = "string",
    Key = "string"
  ),
  Status = "CREATING"|"UPDATING"|"ACTIVE"|"DELETING"|"FAILED",
  RoleArn = "string",
  ErrorMessage = "string",
  FileFormat = "CSV"|"CSV_WITH_HEADER"|"JSON",
  LanguageCode = "string"
)

Request syntax¶

svc$describe_faq(
  Id = "string",
  IndexId = "string"
)