/AWS1/IF_S3V=>UPDATEINDEXMODE()¶
About UpdateIndexMode¶
Updates the mode for an existing vector index. You can set the mode to ENHANCED for any vector index. You can set the mode to CLASSIC only for a vector index in a vector bucket created before September 30, 2026. This operation doesn't change the default index mode of the vector bucket or the mode of other vector indexes. Specify the vector index by using its Amazon Resource Name (ARN) or both the vector bucket name and vector index name.
- Permissions
-
You must have the
s3vectors:UpdateIndexModepermission to use this operation.
Method Signature¶
METHODS /AWS1/IF_S3V~UPDATEINDEXMODE
IMPORTING
!IV_VECTORBUCKETNAME TYPE /AWS1/S3VVECTORBUCKETNAME OPTIONAL
!IV_INDEXNAME TYPE /AWS1/S3VINDEXNAME OPTIONAL
!IV_INDEXARN TYPE /AWS1/S3VINDEXARN OPTIONAL
!IV_INDEXMODE TYPE /AWS1/S3VINDEXMODE OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3vupdindexmodeoutput
RAISING
/AWS1/CX_S3VACCESSDENIEDEX
/AWS1/CX_S3VINTERNALSERVEREX
/AWS1/CX_S3VREQUESTTIMEOUTEX
/AWS1/CX_S3VTOOMANYREQUESTSEX
/AWS1/CX_S3VVALIDATIONEX
/AWS1/CX_S3VNOTFOUNDEXCEPTION
/AWS1/CX_S3VSERVICEUNAVAILEX
/AWS1/CX_S3VCLIENTEXC
/AWS1/CX_S3VSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_indexmode TYPE /AWS1/S3VINDEXMODE /AWS1/S3VINDEXMODE¶
The new mode for the vector index.
Valid values:
CLASSIC- Applies metadata filters during the vector search. You can specifyCLASSIConly for a vector index in a vector bucket created before September 30, 2026.
ENHANCED- Applies metadata filters before the vector search.
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 to update.
iv_indexarn TYPE /AWS1/S3VINDEXARN /AWS1/S3VINDEXARN¶
The Amazon Resource Name (ARN) of the vector index to update.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_s3vupdindexmodeoutput /AWS1/CL_S3VUPDINDEXMODEOUTPUT¶
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->updateindexmode(
iv_indexarn = |string|
iv_indexmode = |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.
ENDIF.