AssociatePersonasToEntities - Amazon Kendra

AssociatePersonasToEntities

Defines the specific permissions of users or groups in your AWS SSO 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.

Request Syntax

{ "Id": "string", "IndexId": "string", "Personas": [ { "EntityId": "string", "Persona": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

The identifier of your Amazon Kendra experience.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

IndexId

The identifier of the index for your Amazon Kendra experience.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Personas

The personas that define the specific permissions of users or groups in your AWS SSO identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

Type: Array of EntityPersonaConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax

{ "FailedEntityList": [ { "EntityId": "string", "ErrorMessage": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedEntityList

Lists the users or groups in your AWS SSO identity source that failed to properly configure with your Amazon Kendra experience.

Type: Array of FailedEntity objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceAlreadyExistException

HTTP Status Code: 400

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: