Skip to content

List Access Control Configurations

kendra_list_access_control_configurations R Documentation

Lists one or more access control configurations for an index

Description

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.

Usage

kendra_list_access_control_configurations(IndexId, NextToken,
  MaxResults)

Arguments

IndexId

[required] The identifier of the index for the access control configuration.

NextToken

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

The maximum number of access control configurations to return.

Value

A list with the following syntax:

list(
  NextToken = "string",
  AccessControlConfigurations = list(
    list(
      Id = "string"
    )
  )
)

Request syntax

svc$list_access_control_configurations(
  IndexId = "string",
  NextToken = "string",
  MaxResults = 123
)