API for Amazon Connect Customer Profiles¶
ABAP Package | /AWS1/API_CUS_IMPL |
---|---|
ABAP SDK "TLA" | CUS |
ABAP Interface | /AWS1/IF_CUS |
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 Customer Profiles is CUS
.
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 Customer Profiles 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 Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles in the Amazon Connect Administrator's Guide.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Connect Customer Profiles, which is created with
factory method /AWS1/CL_CUS_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_cus) = /aws1/cl_cus_factory=>create( go_session ).
Your variable go_cus
is an instance of /AWS1/IF_CUS
,
and all of the operations
in the Amazon Connect Customer Profiles service are accessed by calling methods in /AWS1/IF_CUS
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Connect Customer Profiles, see the Operation List.
Factory Method¶
/AWS1/CL_CUS_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_CUS
.
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_CUS
/AWS1/IF_CUS
¶
/AWS1/IF_CUS
represents the ABAP client for the Customer Profiles service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cus)->get_config( ).
lo_config
is a variable of type /AWS1/CL_CUS_CONFIG
. See the documentation for /AWS1/CL_CUS_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon Connect Customer Profiles can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_CUS_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 Customer Profiles can be found in interface /AWS1/IF_CUS_PAGINATOR
.