API for Amazon OpenSearch Ingestion¶
| ABAP Package | /AWS1/API_OSI_IMPL |
|---|---|
| ABAP SDK "TLA" | OSI |
| ABAP Interface | /AWS1/IF_OSI |
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 OpenSearch Ingestion is OSI.
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 OSIS 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¶
Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
Using the SDK¶
In your code, create a client using the SDK module for Amazon OpenSearch Ingestion, which is created with
factory method /AWS1/CL_OSI_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_osi) = /aws1/cl_osi_factory=>create( go_session ).
Your variable go_osi is an instance of /AWS1/IF_OSI,
and all of the operations
in the Amazon OpenSearch Ingestion service are accessed by calling methods in /AWS1/IF_OSI.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon OpenSearch Ingestion, see the Operation List.
Factory Method¶
/AWS1/CL_OSI_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_OSI.
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_OSI /AWS1/IF_OSI¶
/AWS1/IF_OSIrepresents the ABAP client for the OSIS service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_osi)->get_config( ).
lo_config is a variable of type /AWS1/CL_OSI_CONFIG. See the documentation for /AWS1/CL_OSI_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon OpenSearch Ingestion can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_OSI_PAGINATOR`](./_AWS1_IF_OSI_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 OpenSearch Ingestion can be found in interface [`/AWS1/IF_OSI_PAGINATOR`](./_AWS1_IF_OSI_PAGINATOR.md).