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.
Parameters:
-
index_id
(IndexId)
–
The identifier of the index for the access control configuration.
-
next_token
(Optional[String], default:
None
)
–
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.
-
max_results
(Optional[MaxResultsIntegerForListAccessControlConfigurationsRequest], default:
None
)
–
The maximum number of access control configurations to return.
Raises:
-
AccessDeniedException
–
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
-
InternalServerException
–
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
-
ResourceNotFoundException
–
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
-
ThrottlingException
–
The request was denied due to request throttling. Please reduce the number of requests and try again.
-
ValidationException
–
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_kendra/_services/kendra.py
| def list_access_control_configurations(
self,
index_id: "capo_kendra.types.index_id.IndexId",
*,
config_overrides: Optional[kendraClientConfig] = None,
next_token: Optional["capo_kendra.types.string.String"] = None,
max_results: Optional[
"capo_kendra.types.max_results_integer_for_list_access_control_configurations_request.MaxResultsIntegerForListAccessControlConfigurationsRequest"
] = None,
) -> "capo_kendra.types.list_access_control_configurations_response.ListAccessControlConfigurationsResponse":
"""<p>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.</p>
Args:
index_id: <p>The identifier of the index for the access control configuration.</p>
next_token: <p>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.</p>
max_results: <p>The maximum number of access control configurations to return.</p>
Raises:
capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kendra.types.list_access_control_configurations_request.ListAccessControlConfigurationsRequest]",
) -> OperationResponse[
"capo_kendra.types.list_access_control_configurations_response.ListAccessControlConfigurationsResponse"
]:
import capo_kendra._operations.aws_kendra_frontend_service.list_access_control_configurations
output, http_response = (
capo_kendra._operations.aws_kendra_frontend_service.list_access_control_configurations.list_access_control_configurations(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAccessControlConfigurations")
)
input_: capo_kendra.types.list_access_control_configurations_request.ListAccessControlConfigurationsRequest = {
"index_id": index_id
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|