kendra / Client / associate_entities_to_experience

associate_entities_to_experience

kendra.Client.associate_entities_to_experience(**kwargs)

Grants users or groups in your IAM Identity Center identity source 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_entities_to_experience(
    Id='string',
    IndexId='string',
    EntityList=[
        {
            'EntityId': 'string',
            'EntityType': 'USER'|'GROUP'
        },
    ]
)

Parameters:

• Id (string) –

  [REQUIRED]

  The identifier of your Amazon Kendra experience.

• IndexId (string) –

  [REQUIRED]

  The identifier of the index for your Amazon Kendra experience.

• EntityList (list) –

  [REQUIRED]

  Lists users or groups in your IAM Identity Center identity source.

  • (dict) –

    Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access 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.

    • EntityType (string) – [REQUIRED]

      Specifies whether you are configuring a User or a Group.

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