Skip to content

API for AWS IoT Greengrass V2

ABAP Package /AWS1/API_GG2_IMPL
ABAP SDK "TLA" GG2
ABAP Interface /AWS1/IF_GG2

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 Greengrass V2 is GG2. 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 GreengrassV2 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 Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.

Using the SDK

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

Your variable go_gg2 is an instance of /AWS1/IF_GG2, and all of the operations in the AWS IoT Greengrass V2 service are accessed by calling methods in /AWS1/IF_GG2.

API Operations

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

Factory Method

/AWS1/CL_GG2_FACTORY=>create( )

Creates an object of type /AWS1/IF_GG2.

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_GG2 /AWS1/IF_GG2

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

Configuring Programmatically

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

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

Paginators

Paginators for AWS IoT Greengrass V2 can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_GG2_PAGINATOR`](./_AWS1_IF_GG2_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 Greengrass V2 can be found in interface [`/AWS1/IF_GG2_PAGINATOR`](./_AWS1_IF_GG2_PAGINATOR.md).