kendra / Client / associate_personas_to_entities

associate_personas_to_entities

kendra.Client.associate_personas_to_entities(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.associate_personas_to_entities(
    Id='string',
    IndexId='string',
    Personas=[
        {
            'EntityId': 'string',
            'Persona': 'OWNER'|'VIEWER'
        },
    ]
)

Parameters:

• Id (string) –

  [REQUIRED]

  The identifier of your Amazon Kendra experience.

• IndexId (string) –

  [REQUIRED]

  The identifier of the index for your Amazon Kendra experience.

• Personas (list) –

  [REQUIRED]

  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 Owner and Viewer. For more information on these personas, see Providing access to your search page.

  • (dict) –

    Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

    • EntityId (string) – [REQUIRED]

      The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

    • Persona (string) – [REQUIRED]

      The persona that defines the specific permissions of the user or group in your IAM Identity Center 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • FailedEntityList (list) –

    Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

    • (dict) –

      Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

      • EntityId (string) –

        The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

      • ErrorMessage (string) –

        The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.

Exceptions

• kendra.Client.exceptions.ValidationException

• kendra.Client.exceptions.ResourceNotFoundException

• kendra.Client.exceptions.ResourceAlreadyExistException

• kendra.Client.exceptions.ThrottlingException

• kendra.Client.exceptions.AccessDeniedException

• kendra.Client.exceptions.InternalServerException