Skip to content

/AWS1/IF_S3V=>PUTVECTORBUCKETDEFINDEXMODE()

About PutVectorBucketDefaultIndexMode

Updates the default index mode for a vector bucket. The updated default applies to vector indexes that you create after the request succeeds. The operation doesn't change existing vector indexes. 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:PutVectorBucketDefaultIndexMode permission to use this operation.

Method Signature

METHODS /AWS1/IF_S3V~PUTVECTORBUCKETDEFINDEXMODE
  IMPORTING
    !IV_VECTORBUCKETNAME TYPE /AWS1/S3VVECTORBUCKETNAME OPTIONAL
    !IV_VECTORBUCKETARN TYPE /AWS1/S3VVECTORBUCKETARN OPTIONAL
    !IV_DEFAULTINDEXMODE TYPE /AWS1/S3VINDEXMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3vputvecbktdefidxm01
  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_defaultindexmode TYPE /AWS1/S3VINDEXMODE /AWS1/S3VINDEXMODE

The default mode to assign to new vector indexes in the vector bucket. This change doesn't affect existing vector indexes.

Optional arguments:

iv_vectorbucketname TYPE /AWS1/S3VVECTORBUCKETNAME /AWS1/S3VVECTORBUCKETNAME

The name of the vector bucket to update.

iv_vectorbucketarn TYPE /AWS1/S3VVECTORBUCKETARN /AWS1/S3VVECTORBUCKETARN

The Amazon Resource Name (ARN) of the vector bucket to update.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3vputvecbktdefidxm01 /AWS1/CL_S3VPUTVECBKTDEFIDXM01

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->putvectorbucketdefindexmode(
  iv_defaultindexmode = |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.