UPDATEINDEX()`¶

About UpdateIndex¶

Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

Method Signature¶

METHODS /AWS1/IF_OSS~UPDATEINDEX
  IMPORTING
    !IV_ID TYPE /AWS1/OSSCOLLECTIONID OPTIONAL
    !IV_INDEXNAME TYPE /AWS1/OSSINDEXNAME OPTIONAL
    !IO_INDEXSCHEMA TYPE REF TO /AWS1/CL_RT_DOCUMENT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ossupdateindexrsp
  RAISING
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSRESOURCENOTFOUNDEX
    /AWS1/CX_OSSVALIDATIONEX
    /AWS1/CX_OSSCLIENTEXC
    /AWS1/CX_OSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_id` `TYPE /AWS1/OSSCOLLECTIONID` `/AWS1/OSSCOLLECTIONID`¶

The unique identifier of the collection containing the index to update.

`iv_indexname` `TYPE /AWS1/OSSINDEXNAME` `/AWS1/OSSINDEXNAME`¶

The name of the index to update.

Optional arguments:¶

`io_indexschema` `TYPE REF TO /AWS1/CL_RT_DOCUMENT` `/AWS1/CL_RT_DOCUMENT`¶

The updated JSON schema definition for the index, including field mappings and settings.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ossupdateindexrsp` `/AWS1/CL_OSSUPDATEINDEXRSP`¶

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_id = |string|
  iv_indexname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_OSS=>UPDATEINDEX()¶