API for AWS IoT Wireless¶

ABAP Package	`/AWS1/API_IOW_IMPL`
ABAP SDK "TLA"	`IOW`
ABAP Interface	`/AWS1/IF_IOW`

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 Wireless is IOW. 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 Wireless 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 Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints in the AWS General Reference.

Using the SDK¶

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

Your variable go_iow is an instance of /AWS1/IF_IOW, and all of the operations in the AWS IoT Wireless service are accessed by calling methods in /AWS1/IF_IOW.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_IOW.

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_IOW` `/AWS1/IF_IOW`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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