/AWS1/IF_S3V=>CREATEINDEX()

About CreateIndex

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

Creates a vector index within a vector bucket. To specify the vector bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

Permissions

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

Method Signature

IMPORTING

Required arguments:

iv_indexname TYPE /AWS1/S3VINDEXNAME /AWS1/S3VINDEXNAME

The name of the vector index to create.

iv_datatype TYPE /AWS1/S3VDATATYPE /AWS1/S3VDATATYPE

The data type of the vectors to be inserted into the vector index.

iv_dimension TYPE /AWS1/S3VDIMENSION /AWS1/S3VDIMENSION

The dimensions of the vectors to be inserted into the vector index.

iv_distancemetric TYPE /AWS1/S3VDISTANCEMETRIC /AWS1/S3VDISTANCEMETRIC

The distance metric to be used for similarity search.

Optional arguments:

iv_vectorbucketname TYPE /AWS1/S3VVECTORBUCKETNAME /AWS1/S3VVECTORBUCKETNAME

The name of the vector bucket to create the vector index in.

iv_vectorbucketarn TYPE /AWS1/S3VVECTORBUCKETARN /AWS1/S3VVECTORBUCKETARN

The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

io_metadataconfiguration TYPE REF TO /AWS1/CL_S3VMETADATACONF /AWS1/CL_S3VMETADATACONF

The metadata configuration for the vector index.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3vcreateindexoutput /AWS1/CL_S3VCREATEINDEXOUTPUT

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~createindex(
  io_metadataconfiguration = new /aws1/cl_s3vmetadataconf(
    it_nonfilterablemetadatakeys = VALUE /aws1/cl_s3vnonfiltblmetkeys_w=>tt_nonfilterablemetadatakeys(
      ( new /aws1/cl_s3vnonfiltblmetkeys_w( |string| ) )
    )
  )
  iv_datatype = |string|
  iv_dimension = 123
  iv_distancemetric = |string|
  iv_indexname = |string|
  iv_vectorbucketarn = |string|
  iv_vectorbucketname = |string|
).

This is an example of reading all possible response values

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