- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AssociatePersonasToEntitiesCommand
Defines the specific permissions of users or groups in your IAM Identity Center identity source with 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, AssociatePersonasToEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, AssociatePersonasToEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // AssociatePersonasToEntitiesRequest
Id: "STRING_VALUE", // required
IndexId: "STRING_VALUE", // required
Personas: [ // EntityPersonaConfigurationList // required
{ // EntityPersonaConfiguration
EntityId: "STRING_VALUE", // required
Persona: "OWNER" || "VIEWER", // required
},
],
};
const command = new AssociatePersonasToEntitiesCommand(input);
const response = await client.send(command);
// { // AssociatePersonasToEntitiesResponse
// FailedEntityList: [ // FailedEntityList
// { // FailedEntity
// EntityId: "STRING_VALUE",
// ErrorMessage: "STRING_VALUE",
// },
// ],
// };
AssociatePersonasToEntitiesCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdRequired | string | undefined | The identifier of your Amazon Kendra experience. |
IndexIdRequired | string | undefined | The identifier of the index for your Amazon Kendra experience. |
PersonasRequired | EntityPersonaConfiguration[] | undefined | The personas that define the specific permissions of users or groups in your IAM Identity Center identity source. The available personas or access roles are |
AssociatePersonasToEntitiesCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
FailedEntityList | FailedEntity[] | undefined | Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience. |
Throws
Name | Fault | Details |
|---|
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. |
| ResourceAlreadyExistException | client | The resource you want to use already exists. Please check you have provided the correct resource and try again. |
| 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. |