API for AWS EntityResolution¶

ABAP Package	`/AWS1/API_ERN_IMPL`
ABAP SDK "TLA"	`ERN`
ABAP Interface	`/AWS1/IF_ERN`

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 EntityResolution is ERN. 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 EntityResolution 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¶

Welcome to the Entity Resolution API Reference.

Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.

With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, Entity Resolution can effectively match a source record from a customer relationship management (CRM) system with a source record from a marketing system containing campaign information.

To learn more about Entity Resolution concepts, procedures, and best practices, see the Entity Resolution User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS EntityResolution, which is created with factory method /AWS1/CL_ERN_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_ern)       = /aws1/cl_ern_factory=>create( go_session ).

Your variable go_ern is an instance of /AWS1/IF_ERN, and all of the operations in the AWS EntityResolution service are accessed by calling methods in /AWS1/IF_ERN.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_ERN.

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_ERN` `/AWS1/IF_ERN`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS EntityResolution can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ERN_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 AWS EntityResolution can be found in interface /AWS1/IF_ERN_PAGINATOR.