API for Amazon QLDB Session¶

ABAP Package	`/AWS1/API_QLS_IMPL`
ABAP SDK "TLA"	`QLS`
ABAP Interface	`/AWS1/IF_QLS`

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 QLDB Session is QLS. 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 QLDB Session 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¶

The transactional data APIs for Amazon QLDB

Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this QLDB Session data plane and manages SendCommand API calls for you. For information and a list of supported programming languages, see Getting started with the driver in the Amazon QLDB Developer Guide.
If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see Accessing Amazon QLDB using the QLDB shell.

Using the SDK¶

In your code, create a client using the SDK module for Amazon QLDB Session, which is created with factory method /AWS1/CL_QLS_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_qls)       = /aws1/cl_qls_factory=>create( go_session ).

Your variable go_qls is an instance of /AWS1/IF_QLS, and all of the operations in the Amazon QLDB Session service are accessed by calling methods in /AWS1/IF_QLS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon QLDB Session, see the Operation List.

Factory Method¶

`/AWS1/CL_QLS_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_QLS.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_QLS` `/AWS1/IF_QLS`¶

/AWS1/IF_QLS represents the ABAP client for the QLDB Session service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_qls)->get_config( ).

lo_config is a variable of type /AWS1/CL_QLS_CONFIG. See the documentation for /AWS1/CL_QLS_CONFIG for details on the settings that can be configured.