GETINDEX()`¶

About GetIndex¶

Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

Method Signature¶

IMPORTING¶

Required arguments:¶

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

The unique identifier of the collection containing the index.

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

The name of the index to retrieve information about.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ossgetindexresponse` `/AWS1/CL_OSSGETINDEXRESPONSE`¶

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~getindex(
  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.
  lo_value = lo_result->get_indexschema( ).
  IF lo_value IS NOT INITIAL.
  ENDIF.
ENDIF.

/AWS1/IF_OSS=>GETINDEX()¶