kendra_create_access_control_configuration: Creates an access configuration for your documents

View source: R/kendra_operations.R

kendra_create_access_control_configurationR Documentation

Creates an access configuration for your documents

Description

Creates an access configuration for your documents. 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.

See https://www.paws-r-sdk.com/docs/kendra_create_access_control_configuration/ for full documentation.

Usage

kendra_create_access_control_configuration(
  IndexId,
  Name,
  Description = NULL,
  AccessControlList = NULL,
  HierarchicalAccessControlList = NULL,
  ClientToken = NULL
)

Arguments

IndexId

[required] The identifier of the index to create an access control configuration for your documents.

Name

[required] A name for the access control configuration.

Description

A description for the access control configuration.

AccessControlList

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

HierarchicalAccessControlList

The list of principal lists that define the hierarchy for which documents users should have access to.

ClientToken

A token that you provide to identify the request to create an access control configuration. Multiple calls to the create_access_control_configuration API with the same client token will create only one access control configuration.


paws.analytics documentation built on Sept. 11, 2023, 5:06 p.m.