API for OpenSearch Service Serverless¶

ABAP Package	`/AWS1/API_OSS_IMPL`
ABAP SDK "TLA"	`OSS`
ABAP Interface	`/AWS1/IF_OSS`

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 OpenSearch Service Serverless is OSS. 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 OpenSearchServerless 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 Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

Using the SDK¶

In your code, create a client using the SDK module for OpenSearch Service Serverless, which is created with factory method /AWS1/CL_OSS_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_oss)       = /aws1/cl_oss_factory=>create( go_session ).

Your variable go_oss is an instance of /AWS1/IF_OSS, and all of the operations in the OpenSearch Service Serverless service are accessed by calling methods in /AWS1/IF_OSS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in OpenSearch Service Serverless, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_OSS.

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_OSS` `/AWS1/IF_OSS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for OpenSearch Service Serverless can be created via get_paginator() which returns a paginator object of type /AWS1/IF_OSS_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 OpenSearch Service Serverless can be found in interface /AWS1/IF_OSS_PAGINATOR.