/AWS1/IF_S3V=>GETINDEX()

About GetIndex

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Returns vector index attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN).

Permissions

You must have the s3vectors:GetIndex permission to use this operation.

Method Signature

IMPORTING

Optional arguments:

iv_vectorbucketname TYPE /AWS1/S3VVECTORBUCKETNAME /AWS1/S3VVECTORBUCKETNAME

The name of the vector bucket that contains the vector index.

iv_indexname TYPE /AWS1/S3VINDEXNAME /AWS1/S3VINDEXNAME

The name of the vector index.

iv_indexarn TYPE /AWS1/S3VINDEXARN /AWS1/S3VINDEXARN

The ARN of the vector index.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3vgetindexoutput /AWS1/CL_S3VGETINDEXOUTPUT

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_s3v~getindex(
  iv_indexarn = |string|
  iv_indexname = |string|
  iv_vectorbucketname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_index = lo_result->get_index( ).
  IF lo_index IS NOT INITIAL.
    lv_vectorbucketname = lo_index->get_vectorbucketname( ).
    lv_indexname = lo_index->get_indexname( ).
    lv_indexarn = lo_index->get_indexarn( ).
    lv_timestamp = lo_index->get_creationtime( ).
    lv_datatype = lo_index->get_datatype( ).
    lv_dimension = lo_index->get_dimension( ).
    lv_distancemetric = lo_index->get_distancemetric( ).
    lo_metadataconfiguration = lo_index->get_metadataconfiguration( ).
    IF lo_metadataconfiguration IS NOT INITIAL.
      LOOP AT lo_metadataconfiguration->get_nonfilterablemetkeys( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_metadatakey = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
ENDIF.