The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.CleanRooms

Inherits:
AWS.Service show all
Identifier:
cleanrooms
API Version:
2022-02-17
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using CleanRooms

var cleanrooms = new AWS.CleanRooms();
cleanrooms.createPrivacyBudgetTemplate(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CleanRooms object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cleanrooms = new AWS.CleanRooms({apiVersion: '2022-02-17'});

You can also set the API version globally in AWS.config.apiVersions using the cleanrooms service identifier:

AWS.config.apiVersions = {
  cleanrooms: '2022-02-17',
  // other service API versions
};

var cleanrooms = new AWS.CleanRooms();

Version:

  • 2022-02-17

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse