ListExperienceEntitiesCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KendraClient, ListExperienceEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ListExperienceEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ListExperienceEntitiesRequest
  Id: "STRING_VALUE", // required
  IndexId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
};
const command = new ListExperienceEntitiesCommand(input);
const response = await client.send(command);
// { // ListExperienceEntitiesResponse
//   SummaryItems: [ // ExperienceEntitiesSummaryList
//     { // ExperienceEntitiesSummary
//       EntityId: "STRING_VALUE",
//       EntityType: "USER" || "GROUP",
//       DisplayData: { // EntityDisplayData
//         UserName: "STRING_VALUE",
//         GroupName: "STRING_VALUE",
//         IdentifiedUserName: "STRING_VALUE",
//         FirstName: "STRING_VALUE",
//         LastName: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListExperienceEntitiesCommand Input

See ListExperienceEntitiesCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The identifier of your Amazon Kendra experience.

IndexId
Required
string | undefined

The identifier of the index for your Amazon Kendra experience.

NextToken
string | undefined

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.

ListExperienceEntitiesCommand Output

See ListExperienceEntitiesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

SummaryItems
ExperienceEntitiesSummary[] | undefined

An array of summary information for one or more users or groups.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to request throttling. Please reduce the number of requests and try again.

ValidationException
client

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

KendraServiceException
Base exception class for all service exceptions from Kendra service.