API for Amazon Connect Contact Lens¶

ABAP Package	`/AWS1/API_CNL_IMPL`
ABAP SDK "TLA"	`CNL`
ABAP Interface	`/AWS1/IF_CNL`

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 Contact Lens is CNL. 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 Contact Lens 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¶

Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts.

Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using Contact Lens in the Amazon Connect Administrator Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Connect Contact Lens, which is created with factory method /AWS1/CL_CNL_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_cnl)       = /aws1/cl_cnl_factory=>create( go_session ).

Your variable go_cnl is an instance of /AWS1/IF_CNL, and all of the operations in the Amazon Connect Contact Lens service are accessed by calling methods in /AWS1/IF_CNL.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Connect Contact Lens, see the Operation List.

Factory Method¶

`/AWS1/CL_CNL_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_CNL.

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_CNL` `/AWS1/IF_CNL`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Connect Contact Lens can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CNL_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 Contact Lens can be found in interface /AWS1/IF_CNL_PAGINATOR.