Skip to content

/AWS1/IF_S3V=>GETVECTORS()

About GetVectors

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

Returns vector 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:GetVectors permission to use this operation.

Method Signature

IMPORTING

Required arguments:

it_keys TYPE /AWS1/CL_S3VGETVECTORSINPLST_W=>TT_GETVECTORSINPUTLIST TT_GETVECTORSINPUTLIST

The names of the vectors you want to return attributes for.

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.

iv_returndata TYPE /AWS1/S3VBOOLEAN /AWS1/S3VBOOLEAN

Indicates whether to include the vector data in the response. The default value is false.

iv_returnmetadata TYPE /AWS1/S3VBOOLEAN /AWS1/S3VBOOLEAN

Indicates whether to include metadata in the response. The default value is false.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3vgetvectorsoutput /AWS1/CL_S3VGETVECTORSOUTPUT

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~getvectors(
  it_keys = VALUE /aws1/cl_s3vgetvectorsinplst_w=>tt_getvectorsinputlist(
    ( new /aws1/cl_s3vgetvectorsinplst_w( |string| ) )
  )
  iv_indexarn = |string|
  iv_indexname = |string|
  iv_returndata = ABAP_TRUE
  iv_returnmetadata = ABAP_TRUE
  iv_vectorbucketname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_vectors( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vectorkey = lo_row_1->get_key( ).
      lo_vectordata = lo_row_1->get_data( ).
      IF lo_vectordata IS NOT INITIAL.
        LOOP AT lo_vectordata->get_float32( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_float = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_value = lo_row_1->get_metadata( ).
      IF lo_value IS NOT INITIAL.
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.