kendra / Client / disassociate_personas_from_entities

disassociate_personas_from_entities#

kendra.Client.disassociate_personas_from_entities(**kwargs)#

Removes 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.disassociate_personas_from_entities(
    Id='string',
    IndexId='string',
    EntityIds=[
        '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.

  • EntityIds (list) –

    [REQUIRED]

    The identifiers of users or groups in your IAM Identity Center identity source. For example, user IDs could be user emails.

    • (string) –

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 remove access to 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.ThrottlingException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.InternalServerException