API for Amazon Keyspaces¶

ABAP Package	`/AWS1/API_KYS_IMPL`
ABAP SDK "TLA"	`KYS`
ABAP Interface	`/AWS1/IF_KYS`

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 Keyspaces is KYS. 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 Keyspaces 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¶

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Keyspaces, which is created with factory method /AWS1/CL_KYS_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_kys)       = /aws1/cl_kys_factory=>create( go_session ).

Your variable go_kys is an instance of /AWS1/IF_KYS, and all of the operations in the Amazon Keyspaces service are accessed by calling methods in /AWS1/IF_KYS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_KYS.

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_KYS` `/AWS1/IF_KYS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Keyspaces can be created via get_paginator() which returns a paginator object of type /AWS1/IF_KYS_PAGINATOR. 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 Keyspaces can be found in interface /AWS1/IF_KYS_PAGINATOR.