kendra / Client / describe_access_control_configuration

describe_access_control_configuration#

kendra.Client.describe_access_control_configuration(**kwargs)#

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

See also: AWS API Documentation

Request Syntax

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

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index for an access control configuration.

  • Id (string) –

    [REQUIRED]

    The identifier of the access control configuration you want to get information on.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'ErrorMessage': 'string',
    'AccessControlList': [
        {
            'Name': 'string',
            'Type': 'USER'|'GROUP',
            'Access': 'ALLOW'|'DENY',
            'DataSourceId': 'string'
        },
    ],
    'HierarchicalAccessControlList': [
        {
            'PrincipalList': [
                {
                    'Name': 'string',
                    'Type': 'USER'|'GROUP',
                    'Access': 'ALLOW'|'DENY',
                    'DataSourceId': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Name (string) –

      The name for the access control configuration.

    • Description (string) –

      The description for the access control configuration.

    • ErrorMessage (string) –

      The error message containing details if there are issues processing the access control configuration.

    • AccessControlList (list) –

      Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      • (dict) –

        Provides user and group information for user context filtering.

        • Name (string) –

          The name of the user or group.

        • Type (string) –

          The type of principal.

        • Access (string) –

          Whether to allow or deny document access to the principal.

        • DataSourceId (string) –

          The identifier of the data source the principal should access documents from.

    • HierarchicalAccessControlList (list) –

      The list of principal lists that define the hierarchy for which documents users should have access to.

      • (dict) –

        Information to define the hierarchy for which documents users should have access to.

        • PrincipalList (list) –

          A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

          • (dict) –

            Provides user and group information for user context filtering.

            • Name (string) –

              The name of the user or group.

            • Type (string) –

              The type of principal.

            • Access (string) –

              Whether to allow or deny document access to the principal.

            • DataSourceId (string) –

              The identifier of the data source the principal should access documents from.

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.InternalServerException