API for Amazon CloudSearch¶

ABAP Package	`/AWS1/API_SRH_IMPL`
ABAP SDK "TLA"	`SRH`
ABAP Interface	`/AWS1/IF_SRH`

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 CloudSearch is SRH. 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 CloudSearch 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 CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Using the SDK¶

In your code, create a client using the SDK module for Amazon CloudSearch, which is created with factory method /AWS1/CL_SRH_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_srh)       = /aws1/cl_srh_factory=>create( go_session ).

Your variable go_srh is an instance of /AWS1/IF_SRH, and all of the operations in the Amazon CloudSearch service are accessed by calling methods in /AWS1/IF_SRH.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_SRH.

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_SRH` `/AWS1/IF_SRH`¶

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

Configuring Programmatically¶

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

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