API for AWS IoT TwinMaker¶

ABAP Package	`/AWS1/API_IOM_IMPL`
ABAP SDK "TLA"	`IOM`
ABAP Interface	`/AWS1/IF_IOM`

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 TwinMaker is IOM. 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 IoTTwinMaker 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¶

IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.

Using the SDK¶

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

Your variable go_iom is an instance of /AWS1/IF_IOM, and all of the operations in the AWS IoT TwinMaker service are accessed by calling methods in /AWS1/IF_IOM.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_IOM.

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_IOM` `/AWS1/IF_IOM`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS IoT TwinMaker can be created via get_paginator() which returns a paginator object of type /AWS1/IF_IOM_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 AWS IoT TwinMaker can be found in interface /AWS1/IF_IOM_PAGINATOR.