Describe Experience

kendra_describe_experience

R Documentation

Gets information about your Amazon Kendra experience such as a search application¶

Description¶

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Usage¶

kendra_describe_experience(Id, IndexId)

Arguments¶

Id: [required] The identifier of your Amazon Kendra experience you want to get information on.
IndexId: [required] The identifier of the index for your Amazon Kendra experience.

Value¶

A list with the following syntax:

list(
  Id = "string",
  IndexId = "string",
  Name = "string",
  Endpoints = list(
    list(
      EndpointType = "HOME",
      Endpoint = "string"
    )
  ),
  Configuration = list(
    ContentSourceConfiguration = list(
      DataSourceIds = list(
        "string"
      ),
      FaqIds = list(
        "string"
      ),
      DirectPutContent = TRUE|FALSE
    ),
    UserIdentityConfiguration = list(
      IdentityAttributeName = "string"
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Description = "string",
  Status = "CREATING"|"ACTIVE"|"DELETING"|"FAILED",
  RoleArn = "string",
  ErrorMessage = "string"
)

Request syntax¶

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