API for AWS IoT Events¶

ABAP Package	`/AWS1/API_IOE_IMPL`
ABAP SDK "TLA"	`IOE`
ABAP Interface	`/AWS1/IF_IOE`

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 AWS IoT Events is IOE. 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 IoT Events 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¶

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.

Using the SDK¶

In your code, create a client using the SDK module for AWS IoT Events, which is created with factory method /AWS1/CL_IOE_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_ioe)       = /aws1/cl_ioe_factory=>create( go_session ).

Your variable go_ioe is an instance of /AWS1/IF_IOE, and all of the operations in the AWS IoT Events service are accessed by calling methods in /AWS1/IF_IOE.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS IoT Events, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_IOE.

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_IOE` `/AWS1/IF_IOE`¶

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

Configuring Programmatically¶

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

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