LISTINDEXES()`¶

About ListIndexes¶

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

Returns a list of all the vector indexes within the specified vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

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

Method Signature¶

METHODS /AWS1/IF_S3V~LISTINDEXES
  IMPORTING
    !IV_VECTORBUCKETNAME TYPE /AWS1/S3VVECTORBUCKETNAME OPTIONAL
    !IV_VECTORBUCKETARN TYPE /AWS1/S3VVECTORBUCKETARN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/S3VLISTINDEXESMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/S3VLISTINDEXESNEXTTOKEN OPTIONAL
    !IV_PREFIX TYPE /AWS1/S3VLISTINDEXESPREFIX OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3vlistindexesoutput
  RAISING
    /AWS1/CX_S3VACCESSDENIEDEX
    /AWS1/CX_S3VINTERNALSERVEREX
    /AWS1/CX_S3VSERVICEQUOTAEXCDEX
    /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¶

Optional arguments:¶

`iv_vectorbucketname` `TYPE /AWS1/S3VVECTORBUCKETNAME` `/AWS1/S3VVECTORBUCKETNAME`¶

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

`iv_vectorbucketarn` `TYPE /AWS1/S3VVECTORBUCKETARN` `/AWS1/S3VVECTORBUCKETARN`¶

The ARN of the vector bucket that contains the vector indexes.

`iv_maxresults` `TYPE /AWS1/S3VLISTINDEXESMAXRESULTS` `/AWS1/S3VLISTINDEXESMAXRESULTS`¶

The maximum number of items to be returned in the response.

`iv_nexttoken` `TYPE /AWS1/S3VLISTINDEXESNEXTTOKEN` `/AWS1/S3VLISTINDEXESNEXTTOKEN`¶

The previous pagination token.

`iv_prefix` `TYPE /AWS1/S3VLISTINDEXESPREFIX` `/AWS1/S3VLISTINDEXESPREFIX`¶

Limits the response to vector indexes that begin with the specified prefix.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3vlistindexesoutput` `/AWS1/CL_S3VLISTINDEXESOUTPUT`¶

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->listindexes(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_prefix = |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.
  lv_listindexesnexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_indexes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vectorbucketname = lo_row_1->get_vectorbucketname( ).
      lv_indexname = lo_row_1->get_indexname( ).
      lv_indexarn = lo_row_1->get_indexarn( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_S3V=>LISTINDEXES()¶