Skip to content

/AWS1/IF_KND=>UPDATEINDEX()

About UpdateIndex

Updates an Amazon Kendra index.

Method Signature

METHODS /AWS1/IF_KND~UPDATEINDEX
  IMPORTING
    !IV_ID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IV_NAME TYPE /AWS1/KNDINDEXNAME OPTIONAL
    !IV_ROLEARN TYPE /AWS1/KNDROLEARN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/KNDDESCRIPTION OPTIONAL
    !IT_DOCUMENTMETCONFUPDATES TYPE /AWS1/CL_KNDDOCUMENTMETCONF=>TT_DOCUMENTMETADATACONFLIST OPTIONAL
    !IO_CAPACITYUNITS TYPE REF TO /AWS1/CL_KNDCAPACITYUNITSCONF OPTIONAL
    !IT_USERTOKENCONFIGURATIONS TYPE /AWS1/CL_KNDUSERTOKENCONF=>TT_USERTOKENCONFIGURATIONLIST OPTIONAL
    !IV_USERCONTEXTPOLICY TYPE /AWS1/KNDUSERCONTEXTPOLICY OPTIONAL
    !IO_USERGROUPRESOLUTIONCONF TYPE REF TO /AWS1/CL_KNDUSERGRRESOLUTION00 OPTIONAL
  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_id TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index you want to update.

Optional arguments:

iv_name TYPE /AWS1/KNDINDEXNAME /AWS1/KNDINDEXNAME

A new name for the index.

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

A new description for the index.

it_documentmetconfupdates TYPE /AWS1/CL_KNDDOCUMENTMETCONF=>TT_DOCUMENTMETADATACONFLIST TT_DOCUMENTMETADATACONFLIST

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

io_capacityunits TYPE REF TO /AWS1/CL_KNDCAPACITYUNITSCONF /AWS1/CL_KNDCAPACITYUNITSCONF

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

it_usertokenconfigurations TYPE /AWS1/CL_KNDUSERTOKENCONF=>TT_USERTOKENCONFIGURATIONLIST TT_USERTOKENCONFIGURATIONLIST

The user token configuration.

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

iv_usercontextpolicy TYPE /AWS1/KNDUSERCONTEXTPOLICY /AWS1/KNDUSERCONTEXTPOLICY

The user context policy.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

io_usergroupresolutionconf TYPE REF TO /AWS1/CL_KNDUSERGRRESOLUTION00 /AWS1/CL_KNDUSERGRRESOLUTION00

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

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.

lo_client->updateindex(
  io_capacityunits = new /aws1/cl_kndcapacityunitsconf(
    iv_querycapacityunits = 123
    iv_storagecapacityunits = 123
  )
  io_usergroupresolutionconf = new /aws1/cl_kndusergrresolution00( |string| )
  it_documentmetconfupdates = VALUE /aws1/cl_knddocumentmetconf=>tt_documentmetadataconflist(
    (
      new /aws1/cl_knddocumentmetconf(
        io_relevance = new /aws1/cl_kndrelevance(
          it_valueimportancemap = VALUE /aws1/cl_kndvalueimpancemap_w=>tt_valueimportancemap(
            (
              VALUE /aws1/cl_kndvalueimpancemap_w=>ts_valueimportancemap_maprow(
                key = |string|
                value = new /aws1/cl_kndvalueimpancemap_w( 123 )
              )
            )
          )
          iv_duration = |string|
          iv_freshness = ABAP_TRUE
          iv_importance = 123
          iv_rankorder = |string|
        )
        io_search = new /aws1/cl_kndsearch(
          iv_displayable = ABAP_TRUE
          iv_facetable = ABAP_TRUE
          iv_searchable = ABAP_TRUE
          iv_sortable = ABAP_TRUE
        )
        iv_name = |string|
        iv_type = |string|
      )
    )
  )
  it_usertokenconfigurations = VALUE /aws1/cl_kndusertokenconf=>tt_usertokenconfigurationlist(
    (
      new /aws1/cl_kndusertokenconf(
        io_jsontokentypeconf = new /aws1/cl_kndjsontokentypeconf(
          iv_groupattributefield = |string|
          iv_usernameattributefield = |string|
        )
        io_jwttokentypeconfiguration = new /aws1/cl_kndjwttokentypeconf(
          iv_claimregex = |string|
          iv_groupattributefield = |string|
          iv_issuer = |string|
          iv_keylocation = |string|
          iv_secretmanagerarn = |string|
          iv_url = |string|
          iv_usernameattributefield = |string|
        )
      )
    )
  )
  iv_description = |string|
  iv_id = |string|
  iv_name = |string|
  iv_rolearn = |string|
  iv_usercontextpolicy = |string|
).