kendra / Client / list_access_control_configurations

list_access_control_configurations#

kendra.Client.list_access_control_configurations(**kwargs)#

Lists one or more access control configurations for 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.

Request Syntax

response = client.list_access_control_configurations(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

IndexId (string) –
[REQUIRED]

The identifier of the index for the access control configuration.
NextToken (string) – If the previous response was incomplete (because there’s 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 access control configurations.
MaxResults (integer) – The maximum number of access control configurations to return.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'AccessControlConfigurations': [
        {
            'Id': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.
- AccessControlConfigurations (list) –
  
  The details of your access control configurations.
  - (dict) –
    
    Summary information on an access control configuration that you created for your documents in an index.
    - Id (string) –
      
      The identifier of the access control configuration.

Exceptions

kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.ResourceNotFoundException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException