API for AWS Clean Rooms ML¶

ABAP Package	`/AWS1/API_CRL_IMPL`
ABAP SDK "TLA"	`CRL`
ABAP Interface	`/AWS1/IF_CRL`

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 Clean Rooms ML is CRL. 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 CleanRoomsML 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 Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

Using the SDK¶

In your code, create a client using the SDK module for AWS Clean Rooms ML, which is created with factory method /AWS1/CL_CRL_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_crl)       = /aws1/cl_crl_factory=>create( go_session ).

Your variable go_crl is an instance of /AWS1/IF_CRL, and all of the operations in the AWS Clean Rooms ML service are accessed by calling methods in /AWS1/IF_CRL.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CRL.

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_CRL` `/AWS1/IF_CRL`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Clean Rooms ML can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CRL_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 Clean Rooms ML can be found in interface /AWS1/IF_CRL_PAGINATOR.