API for Amazon S3 Tables¶
| ABAP Package | /AWS1/API_S3T_IMPL |
|---|---|
| ABAP SDK "TLA" | S3T |
| ABAP Interface | /AWS1/IF_S3T |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon S3 Tables is S3T.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the S3Tables module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the AWS Glue Data Catalog you can interact with your tables using AWS analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.
Using the SDK¶
In your code, create a client using the SDK module for Amazon S3 Tables, which is created with
factory method /AWS1/CL_S3T_FACTORY=>create().
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG called ZFINANCE.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_s3t) = /aws1/cl_s3t_factory=>create( go_session ).
Your variable go_s3t is an instance of /AWS1/IF_S3T,
and all of the operations
in the Amazon S3 Tables service are accessed by calling methods in /AWS1/IF_S3T.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon S3 Tables, see the Operation List.
Factory Method¶
/AWS1/CL_S3T_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_S3T.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
OO_CLIENT TYPE REF TO /AWS1/IF_S3T /AWS1/IF_S3T¶
/AWS1/IF_S3Trepresents the ABAP client for the S3Tables service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_s3t)->get_config( ).
lo_config is a variable of type /AWS1/CL_S3T_CONFIG. See the documentation for /AWS1/CL_S3T_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon S3 Tables can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_S3T_PAGINATOR`](./_AWS1_IF_S3T_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.
Details about the paginator methods available for service Amazon S3 Tables can be found in interface [`/AWS1/IF_S3T_PAGINATOR`](./_AWS1_IF_S3T_PAGINATOR.md).