GETVECTORBUCKET()`¶

About GetVectorBucket¶

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

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

Method Signature¶

METHODS /AWS1/IF_S3V~GETVECTORBUCKET
  IMPORTING
    !IV_VECTORBUCKETNAME TYPE /AWS1/S3VVECTORBUCKETNAME OPTIONAL
    !IV_VECTORBUCKETARN TYPE /AWS1/S3VVECTORBUCKETARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3vgetvectorbktoutput
  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¶

Optional arguments:¶

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

The name of the vector bucket to retrieve information about.

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

The ARN of the vector bucket to retrieve information about.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3vgetvectorbktoutput` `/AWS1/CL_S3VGETVECTORBKTOUTPUT`¶

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->getvectorbucket(
  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.
  lo_vectorbucket = lo_result->get_vectorbucket( ).
  IF lo_vectorbucket IS NOT INITIAL.
    lv_vectorbucketname = lo_vectorbucket->get_vectorbucketname( ).
    lv_vectorbucketarn = lo_vectorbucket->get_vectorbucketarn( ).
    lv_timestamp = lo_vectorbucket->get_creationtime( ).
    lo_encryptionconfiguration = lo_vectorbucket->get_encryptionconfiguration( ).
    IF lo_encryptionconfiguration IS NOT INITIAL.
      lv_ssetype = lo_encryptionconfiguration->get_ssetype( ).
      lv_kmskeyarn = lo_encryptionconfiguration->get_kmskeyarn( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_S3V=>GETVECTORBUCKET()¶