describe_access_control_configuration `async` ¶

describe_access_control_configuration(
    index_id: IndexId,
    id: AccessControlConfigurationId,
    *,
    config_overrides: Optional[AsynckendraClientConfig] = None,
) -> DescribeAccessControlConfigurationResponse

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.

Parameters:

index_id (IndexId) –

The identifier of the index for an access control configuration.
id (AccessControlConfigurationId) –

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

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/async_kendra.py

async def describe_access_control_configuration(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    id: "capo_kendra.types.access_control_configuration_id.AccessControlConfigurationId",
    *,
    config_overrides: Optional[AsynckendraClientConfig] = None,
) -> "capo_kendra.types.describe_access_control_configuration_response.DescribeAccessControlConfigurationResponse":
    """<p>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.</p>

    Args:
        index_id: <p>The identifier of the index for an access control configuration.</p>
        id: <p>The identifier of the access control configuration you want to get information on.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kendra.types.describe_access_control_configuration_request.DescribeAccessControlConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_kendra.types.describe_access_control_configuration_response.DescribeAccessControlConfigurationResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.describe_access_control_configuration

        (
            output,
            http_response,
        ) = await capo_kendra._operations.aws_kendra_frontend_service.describe_access_control_configuration.async_describe_access_control_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAccessControlConfiguration")
    )
    input_: capo_kendra.types.describe_access_control_configuration_request.DescribeAccessControlConfigurationRequest = {
        "index_id": index_id,
        "id": id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_access_control_configuration async ¶

describe_access_control_configuration `async` ¶