kendra / Client / list_entity_personas

list_entity_personas#

kendra.Client.list_entity_personas(**kwargs)#

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

See also: AWS API Documentation

Request Syntax

response = client.list_entity_personas(
    Id='string',
    IndexId='string',
    NextToken='string',
    MaxResults=123
)
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.

  • MaxResults (integer) – The maximum number of returned users or groups.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryItems': [
        {
            'EntityId': 'string',
            'Persona': 'OWNER'|'VIEWER',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    '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. This applies to users and groups with specific permissions that define their level of 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.

        • Persona (string) –

          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.

        • CreatedAt (datetime) –

          The Unix timestamp when the summary information was created.

        • UpdatedAt (datetime) –

          The Unix timestamp when the summary information was last updated.

    • 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