API for AWS Clean Rooms Service¶

ABAP Package	`/AWS1/API_CRM_IMPL`
ABAP SDK "TLA"	`CRM`
ABAP Interface	`/AWS1/IF_CRM`

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 Service is CRM. 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 CleanRooms 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 Clean Rooms API Reference.

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can query and receive results can get insights into the collective datasets without either party getting access to the other party's raw data.

To learn more about Clean Rooms 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 Service, which is created with factory method /AWS1/CL_CRM_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_crm)       = /aws1/cl_crm_factory=>create( go_session ).

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

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CRM.

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_CRM` `/AWS1/IF_CRM`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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