kendra / Client / list_experience_entities

list_experience_entities#

kendra.Client.list_experience_entities(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_experience_entities(
    Id='string',
    IndexId='string',
    NextToken='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The identifier of your Amazon Kendra experience.

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index for your Amazon Kendra experience.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryItems': [
        {
            'EntityId': 'string',
            'EntityType': 'USER'|'GROUP',
            'DisplayData': {
                'UserName': 'string',
                'GroupName': 'string',
                'IdentifiedUserName': 'string',
                'FirstName': 'string',
                'LastName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SummaryItems (list) –

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

      • (dict) –

        Summary information for users or groups in your IAM Identity Center identity source with 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.

        • EntityId (string) –

          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) –

          Shows the type as User or Group.

        • DisplayData (dict) –

          Information about the user entity.

          • UserName (string) –

            The name of the user.

          • GroupName (string) –

            The name of the group.

          • IdentifiedUserName (string) –

            The user name of the user.

          • FirstName (string) –

            The first name of the user.

          • LastName (string) –

            The last name of the user.

    • NextToken (string) –

      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.

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.InternalServerException