/AWS1/IF_OSR=>UPDATEINDEX()

About UpdateIndex

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

Method Signature

METHODS /AWS1/IF_OSR~UPDATEINDEX
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/OSRDOMAINNAME OPTIONAL
    !IV_INDEXNAME TYPE /AWS1/OSRINDEXNAME OPTIONAL
    !IO_INDEXSCHEMA TYPE REF TO /AWS1/CL_RT_DOCUMENT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrupdateindexrsp
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRDEPENDENCYFAILUR00
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRTHROTTLINGEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/OSRDOMAINNAME /AWS1/OSRDOMAINNAME

DomainName

iv_indexname TYPE /AWS1/OSRINDEXNAME /AWS1/OSRINDEXNAME

The name of the index to update.

io_indexschema TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.

RETURNING

oo_output TYPE REF TO /aws1/cl_osrupdateindexrsp /AWS1/CL_OSRUPDATEINDEXRSP

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->updateindex(
  io_indexschema = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
  iv_domainname = |string|
  iv_indexname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_indexstatus = lo_result->get_status( ).
ENDIF.