API for Amazon OpenSearch Service¶

ABAP Package	`/AWS1/API_OSR_IMPL`
ABAP SDK "TLA"	`OSR`
ABAP Interface	`/AWS1/IF_OSR`

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 Service is OSR. 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 OpenSearch 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 Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Using the SDK¶

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

Your variable go_osr is an instance of /AWS1/IF_OSR, and all of the operations in the Amazon OpenSearch Service service are accessed by calling methods in /AWS1/IF_OSR.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_OSR.

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_OSR` `/AWS1/IF_OSR`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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