/AWS1/IF_KND=>UPDATEACCESSCONTROLCONF()

About UpdateAccessControlConfiguration

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.

You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.

You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. 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

METHODS /AWS1/IF_KND~UPDATEACCESSCONTROLCONF
  IMPORTING
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IV_ID TYPE /AWS1/KNDACCESSCONTROLCONFID OPTIONAL
    !IV_NAME TYPE /AWS1/KNDACCESSCONTROLCONFNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/KNDDESCRIPTION OPTIONAL
    !IT_ACCESSCONTROLLIST TYPE /AWS1/CL_KNDPRINCIPAL=>TT_PRINCIPALLIST OPTIONAL
    !IT_HIERARCHICALACCESSCTLLIST TYPE /AWS1/CL_KNDHIERARCHICALPRINC=>TT_HIERARCHICALPRINCIPALLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndupdaccctlconfrsp
  RAISING
    /AWS1/CX_KNDACCESSDENIEDEX
    /AWS1/CX_KNDCONFLICTEXCEPTION
    /AWS1/CX_KNDINTERNALSERVEREX
    /AWS1/CX_KNDRESOURCENOTFOUNDEX
    /AWS1/CX_KNDSERVICEQUOTAEXCDEX
    /AWS1/CX_KNDTHROTTLINGEX
    /AWS1/CX_KNDVALIDATIONEX
    /AWS1/CX_KNDCLIENTEXC
    /AWS1/CX_KNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index for an access control configuration.

iv_id TYPE /AWS1/KNDACCESSCONTROLCONFID /AWS1/KNDACCESSCONTROLCONFID

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

Optional arguments:

iv_name TYPE /AWS1/KNDACCESSCONTROLCONFNAME /AWS1/KNDACCESSCONTROLCONFNAME

A new name for the access control configuration.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

A new description for the access control configuration.

it_accesscontrollist TYPE /AWS1/CL_KNDPRINCIPAL=>TT_PRINCIPALLIST TT_PRINCIPALLIST

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.

it_hierarchicalaccessctllist TYPE /AWS1/CL_KNDHIERARCHICALPRINC=>TT_HIERARCHICALPRINCIPALLIST TT_HIERARCHICALPRINCIPALLIST

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

RETURNING

oo_output TYPE REF TO /aws1/cl_kndupdaccctlconfrsp /AWS1/CL_KNDUPDACCCTLCONFRSP

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->updateaccesscontrolconf(
  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_description = |string|
  iv_id = |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.
ENDIF.