API for AWS IoT¶

ABAP Package	`/AWS1/API_IOT_IMPL`
ABAP SDK "TLA"	`IOT`
ABAP Interface	`/AWS1/IF_IOT`

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 is IOT. 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 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

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide.

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

Using the SDK¶

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

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

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_IOT.

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_IOT` `/AWS1/IF_IOT`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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