- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListAccessControlConfigurationsCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KendraClient, ListAccessControlConfigurationsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ListAccessControlConfigurationsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ListAccessControlConfigurationsRequest
IndexId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListAccessControlConfigurationsCommand(input);
const response = await client.send(command);
// { // ListAccessControlConfigurationsResponse
// NextToken: "STRING_VALUE",
// AccessControlConfigurations: [ // AccessControlConfigurationSummaryList // required
// { // AccessControlConfigurationSummary
// Id: "STRING_VALUE", // required
// },
// ],
// };
ListAccessControlConfigurationsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IndexIdRequired | string | undefined | The identifier of the index for the access control configuration. |
MaxResults | number | undefined | The maximum number of access control configurations to return. |
NextToken | string | undefined | 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. |
ListAccessControlConfigurationsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
AccessControlConfigurationsRequired | AccessControlConfigurationSummary[] | undefined | The details of your access control configurations. |
NextToken | string | undefined | 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. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | 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 | server | 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 | client | The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again. |
| ThrottlingException | client | The request was denied due to request throttling. Please reduce the number of requests and try again. |
| ValidationException | client | The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again. |
| KendraServiceException | Base exception class for all service exceptions from Kendra service. |