API for AWS IoT Core Device Advisor¶
| ABAP Package | /AWS1/API_IOD_IMPL |
|---|---|
| ABAP SDK "TLA" | IOD |
| ABAP Interface | /AWS1/IF_IOD |
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 Core Device Advisor is IOD.
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 IotDeviceAdvisor 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¶
Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.
Using the SDK¶
In your code, create a client using the SDK module for AWS IoT Core Device Advisor, which is created with
factory method /AWS1/CL_IOD_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_iod) = /aws1/cl_iod_factory=>create( go_session ).
Your variable go_iod is an instance of /AWS1/IF_IOD,
and all of the operations
in the AWS IoT Core Device Advisor service are accessed by calling methods in /AWS1/IF_IOD.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS IoT Core Device Advisor, see the Operation List.
Factory Method¶
/AWS1/CL_IOD_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_IOD.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
OO_CLIENT TYPE REF TO /AWS1/IF_IOD /AWS1/IF_IOD¶
/AWS1/IF_IODrepresents the ABAP client for the IotDeviceAdvisor service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_iod)->get_config( ).
lo_config is a variable of type /AWS1/CL_IOD_CONFIG. See the documentation for /AWS1/CL_IOD_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for AWS IoT Core Device Advisor can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_IOD_PAGINATOR`](./_AWS1_IF_IOD_PAGINATOR.md). 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 Core Device Advisor can be found in interface [`/AWS1/IF_IOD_PAGINATOR`](./_AWS1_IF_IOD_PAGINATOR.md).