API for Amazon Keyspaces Streams

ABAP Package	/AWS1/API_KYZ_IMPL
ABAP SDK "TLA"	KYZ
ABAP Interface	/AWS1/IF_KYZ

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 Streams is KYZ. 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 KeyspacesStreams 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) change data capture (CDC) records change events for Amazon Keyspaces tables. The change events captured in a stream are time-ordered and de-duplicated write operations. Using stream data you can build event driven applications that incorporate near-real time change events from Amazon Keyspaces tables.

Amazon Keyspaces CDC is serverless and scales the infrastructure for change events automatically based on the volume of changes on your table.

This API reference describes the Amazon Keyspaces CDC stream API in detail.

For more information about Amazon Keyspaces CDC, see Working with change data capture (CDC) streams in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

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

To see the metrics Amazon Keyspaces CDC sends to Amazon CloudWatch, see Amazon Keyspaces change data capture (CDC) CloudWatch metrics in the Amazon Keyspaces Developer Guide.

Using the SDK

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

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

API Operations

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

Factory Method

/AWS1/CL_KYZ_FACTORY=>create( )

Creates an object of type /AWS1/IF_KYZ.

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_kyz /AWS1/IF_KYZ

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

Configuring Programmatically

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

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

Paginators

Paginators for Amazon Keyspaces Streams can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_KYZ_PAGINATOR`](./_AWS1_IF_KYZ_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 Keyspaces Streams can be found in interface [`/AWS1/IF_KYZ_PAGINATOR`](./_AWS1_IF_KYZ_PAGINATOR.md).