Skip to content

/AWS1/IF_OSS=>CREATEINDEX()

About CreateIndex

Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the OpenSearch User Guide.

Method Signature

IMPORTING

Required arguments:

iv_id TYPE /AWS1/OSSCOLLECTIONID /AWS1/OSSCOLLECTIONID

The unique identifier of the collection in which to create the index.

iv_indexname TYPE /AWS1/OSSINDEXNAME /AWS1/OSSINDEXNAME

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

Optional arguments:

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

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

RETURNING

oo_output TYPE REF TO /aws1/cl_osscreateindexrsp /AWS1/CL_OSSCREATEINDEXRSP

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_oss~createindex(
  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.