Skip to content

API for Amazon AppIntegrations Service

ABAP Package /AWS1/API_API
ABAP SDK "TLA" API
ABAP Interface /AWS1/IF_API

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 Amazon AppIntegrations Service is API. 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 AppIntegrations 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

The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.

For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide.

Using the SDK

In your code, create a client using the SDK module for Amazon AppIntegrations Service, which is created with factory method /AWS1/CL_API_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_api)       = /aws1/cl_api_factory=>create( go_session ).

Your variable go_api is an instance of /AWS1/IF_API, and all of the operations in the Amazon AppIntegrations Service service are accessed by calling methods in /AWS1/IF_API.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon AppIntegrations Service, see the Operation List.

Factory Method

/AWS1/CL_API_FACTORY=>CREATE( )

Creates an object of type /AWS1/IF_API.

IMPORTING

Required arguments:

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_API

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