API for Amazon Kinesis Analytics¶
ABAP Package | /AWS1/API_KNY_IMPL |
---|---|
ABAP SDK "TLA" | KNY |
ABAP Interface | /AWS1/IF_KNY |
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 Kinesis Analytics is KNY
.
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 Kinesis Analytics 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¶
Overview
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Kinesis Analytics, which is created with
factory method /AWS1/CL_KNY_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_kny) = /aws1/cl_kny_factory=>create( go_session ).
Your variable go_kny
is an instance of /AWS1/IF_KNY
,
and all of the operations
in the Amazon Kinesis Analytics service are accessed by calling methods in /AWS1/IF_KNY
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Kinesis Analytics, see the Operation List.
Factory Method¶
/AWS1/CL_KNY_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_KNY
.
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_KNY
/AWS1/IF_KNY
¶
/AWS1/IF_KNY
represents the ABAP client for the Kinesis Analytics service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_kny)->get_config( ).
lo_config
is a variable of type /AWS1/CL_KNY_CONFIG
. See the documentation for /AWS1/CL_KNY_CONFIG
for
details on the settings that can be configured.