API for AWS IoT Data Plane¶

ABAP Package	`/AWS1/API_IOP_IMPL`
ABAP SDK "TLA"	`IOP`
ABAP Interface	`/AWS1/IF_IOP`

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 Data Plane is IOP. 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 Data Plane 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 data

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the Amazon Web Services cloud.

Find the endpoint address for actions in IoT data by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.

Using the SDK¶

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

Your variable go_iop is an instance of /AWS1/IF_IOP, and all of the operations in the AWS IoT Data Plane service are accessed by calling methods in /AWS1/IF_IOP.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_IOP.

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_IOP` `/AWS1/IF_IOP`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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