API for Amazon CloudSearch Domain¶

ABAP Package	`/AWS1/API_SRD_IMPL`
ABAP SDK "TLA"	`SRD`
ABAP Interface	`/AWS1/IF_SRD`

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 Domain is SRD. 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 Domain 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¶

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

Using the SDK¶

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

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

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_SRD.

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_SRD` `/AWS1/IF_SRD`¶

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

Configuring Programmatically¶

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

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