Skip to content

List Experiences

kendra_list_experiences R Documentation

Lists one or more Amazon Kendra experiences

Description

Lists one or more Amazon Kendra experiences. You can create an 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_list_experiences(IndexId, NextToken, MaxResults)

Arguments

IndexId

[required] The identifier of the index for your Amazon Kendra experience.

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 Amazon Kendra experiences.

MaxResults

The maximum number of returned Amazon Kendra experiences.

Value

A list with the following syntax: 

list(
  SummaryItems = list(
    list(
      Name = "string",
      Id = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Status = "CREATING"|"ACTIVE"|"DELETING"|"FAILED",
      Endpoints = list(
        list(
          EndpointType = "HOME",
          Endpoint = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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