API for Amazon Connect Service¶
ABAP Package | /AWS1/API_CNT_IMPL |
---|---|
ABAP SDK "TLA" | CNT |
ABAP Interface | /AWS1/IF_CNT |
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 Connect Service is CNT
.
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 Connect 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 Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Connect Service, which is created with
factory method /AWS1/CL_CNT_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_cnt) = /aws1/cl_cnt_factory=>create( go_session ).
Your variable go_cnt
is an instance of /AWS1/IF_CNT
,
and all of the operations
in the Amazon Connect Service service are accessed by calling methods in /AWS1/IF_CNT
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Connect Service, see the Operation List.
Factory Method¶
/AWS1/CL_CNT_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_CNT
.
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_CNT
/AWS1/IF_CNT
¶
/AWS1/IF_CNT
represents the ABAP client for the Connect service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cnt)->get_config( ).
lo_config
is a variable of type /AWS1/CL_CNT_CONFIG
. See the documentation for /AWS1/CL_CNT_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon Connect Service can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_CNT_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 Amazon Connect Service can be found in interface /AWS1/IF_CNT_PAGINATOR
.