API for AWS IoT 1-Click Devices Service¶
ABAP Package | /AWS1/API_I1D_IMPL |
---|---|
ABAP SDK "TLA" | I1D |
ABAP Interface | /AWS1/IF_I1D |
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 1-Click Devices Service is I1D
.
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 1Click Devices Service 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¶
Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.
Using the SDK¶
In your code, create a client using the SDK module for AWS IoT 1-Click Devices Service, which is created with
factory method /AWS1/CL_I1D_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_i1d) = /aws1/cl_i1d_factory=>create( go_session ).
Your variable go_i1d
is an instance of /AWS1/IF_I1D
,
and all of the operations
in the AWS IoT 1-Click Devices Service service are accessed by calling methods in /AWS1/IF_I1D
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS IoT 1-Click Devices Service, see the Operation List.
Factory Method¶
/AWS1/CL_I1D_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_I1D
.
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_I1D
/AWS1/IF_I1D
¶
/AWS1/IF_I1D
represents the ABAP client for the IoT 1Click Devices Service service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_i1d)->get_config( ).
lo_config
is a variable of type /AWS1/CL_I1D_CONFIG
. See the documentation for /AWS1/CL_I1D_CONFIG
for
details on the settings that can be configured.