/AWS1/IF_KND=>CREATEACCESSCONTROLCONF()

About CreateAccessControlConfiguration

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.

You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.

Method Signature

IMPORTING

Required arguments:

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

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

iv_name TYPE /AWS1/KNDACCESSCONTROLCONFNAME /AWS1/KNDACCESSCONTROLCONFNAME

A name for the access control configuration.

Optional arguments:

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

A description for the access control configuration.

it_accesscontrollist TYPE /AWS1/CL_KNDPRINCIPAL=>TT_PRINCIPALLIST TT_PRINCIPALLIST

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.

it_hierarchicalaccessctllist TYPE /AWS1/CL_KNDHIERARCHICALPRINC=>TT_HIERARCHICALPRINCIPALLIST TT_HIERARCHICALPRINCIPALLIST

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

iv_clienttoken TYPE /AWS1/KNDCLIENTTOKENNAME /AWS1/KNDCLIENTTOKENNAME

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

RETURNING

oo_output TYPE REF TO /aws1/cl_kndcreaccctlconfrsp /AWS1/CL_KNDCREACCCTLCONFRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_knd~createaccesscontrolconf(
  it_accesscontrollist = VALUE /aws1/cl_kndprincipal=>tt_principallist(
    (
      new /aws1/cl_kndprincipal(
        iv_access = |string|
        iv_datasourceid = |string|
        iv_name = |string|
        iv_type = |string|
      )
    )
  )
  it_hierarchicalaccessctllist = VALUE /aws1/cl_kndhierarchicalprinc=>tt_hierarchicalprincipallist(
    (
      new /aws1/cl_kndhierarchicalprinc(
        it_principallist = VALUE /aws1/cl_kndprincipal=>tt_principallist(
          (
            new /aws1/cl_kndprincipal(
              iv_access = |string|
              iv_datasourceid = |string|
              iv_name = |string|
              iv_type = |string|
            )
          )
        )
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_indexid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_accesscontrolconfigurat = lo_result->get_id( ).
ENDIF.