v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

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.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeAccessControlConfiguration

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeAccessControlConfiguration' required

Request body

IndexIdstring required

The identifier of the index for an access control configuration.

Idstring required

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

Response

Success

Namestring required

The name for the access control configuration.

Descriptionstring

The description for the access control configuration.

ErrorMessagestring

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