Skip to content

List Experience Entities

kendra_list_experience_entities R Documentation

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience

Description

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. 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_experience_entities(Id, IndexId, NextToken)

Arguments

Id

[required] The identifier of your Amazon Kendra experience.

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 users or groups.

Value

A list with the following syntax: 

list(
  SummaryItems = list(
    list(
      EntityId = "string",
      EntityType = "USER"|"GROUP",
      DisplayData = list(
        UserName = "string",
        GroupName = "string",
        IdentifiedUserName = "string",
        FirstName = "string",
        LastName = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_experience_entities(
  Id = "string",
  IndexId = "string",
  NextToken = "string"
)