kendra_update_access_control_configuration: Updates an access control configuration for your documents in...

View source: R/kendra_operations.R

kendra_update_access_control_configurationR Documentation

Updates an access control configuration for your documents in an index

Description

Updates an access control configuration 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.

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

Usage

kendra_update_access_control_configuration(
  IndexId,
  Id,
  Name = NULL,
  Description = NULL,
  AccessControlList = NULL,
  HierarchicalAccessControlList = NULL
)

Arguments

IndexId

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

Id

[required] The identifier of the access control configuration you want to update.

Name

A new name for the access control configuration.

Description

A new description for the access control configuration.

AccessControlList

Information you want to update 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 updated list of principal lists that define the hierarchy for which documents users should have access to.


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