Package-level declarations

Types

Link copied to clipboard

Welcome to the Clean Rooms API Reference.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

Link copied to clipboard

Retrieves multiple schemas by their identifiers.

Link copied to clipboard

Creates a new analysis template.

Link copied to clipboard

Creates a new collaboration.

Link copied to clipboard

Provides the details necessary to create a configured audience model association.

Link copied to clipboard

Creates a new configured table resource.

Link copied to clipboard

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

Link copied to clipboard

Creates a configured table association. A configured table association links a configured table with a collaboration.

Link copied to clipboard

Creates a membership for a specific collaboration identifier and joins the collaboration.

Link copied to clipboard

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

Link copied to clipboard

Deletes an analysis template.

Link copied to clipboard

Deletes a collaboration. It can only be called by the collaboration owner.

Link copied to clipboard

Provides the information necessary to delete a configured audience model association.

Link copied to clipboard

Deletes a configured table.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.

Link copied to clipboard

Deletes a specified membership. All resources under a membership must be deleted.

Link copied to clipboard

Deletes a privacy budget template for a specified membership.

Link copied to clipboard

Retrieves an analysis template.

Link copied to clipboard

Returns metadata about a collaboration.

Link copied to clipboard

Retrieves an analysis template within a collaboration.

Link copied to clipboard

Returns details about a specified privacy budget template.

Link copied to clipboard

Returns information about a configured audience model association.

Link copied to clipboard

Retrieves a configured table.

Link copied to clipboard

Retrieves a configured table analysis rule.

Link copied to clipboard

Retrieves a configured table association.

Link copied to clipboard

Retrieves a specified membership for an identifier.

Link copied to clipboard

Returns details for a specified privacy budget template.

Link copied to clipboard

Returns query processing metadata.

Link copied to clipboard
inline suspend fun CleanRoomsClient.getSchema(crossinline block: GetSchemaRequest.Builder.() -> Unit): GetSchemaResponse

Retrieves the schema for a relation within a collaboration.

Link copied to clipboard

Retrieves a schema analysis rule.

Link copied to clipboard

Lists analysis templates that the caller owns.

Link copied to clipboard

Lists analysis templates within a collaboration.

Link copied to clipboard

Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

Link copied to clipboard

Returns an array that summarizes each privacy budget template in a specified collaboration.

Link copied to clipboard

Lists collaborations the caller owns, is active in, or has been invited to.

Link copied to clipboard

Lists information about requested configured audience model associations.

Link copied to clipboard

Lists configured table associations for a membership.

Link copied to clipboard

Lists configured tables.

Link copied to clipboard

Lists all members within a collaboration.

Link copied to clipboard

Lists all memberships resources within the caller's account.

Link copied to clipboard

Returns detailed information about the privacy budgets in a specified membership.

Link copied to clipboard

Returns detailed information about the privacy budget templates in a specified membership.

Link copied to clipboard

Lists protected queries, sorted by the most recent query.

Link copied to clipboard

Lists the schemas for relations within a collaboration.

Link copied to clipboard

Lists all of the tags that have been added to a resource.

Link copied to clipboard

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

Link copied to clipboard

Creates a protected query that is started by Clean Rooms.

Link copied to clipboard

Tags a resource.

Link copied to clipboard

Removes a tag or list of tags from a resource.

Link copied to clipboard

Updates the analysis template metadata.

Link copied to clipboard

Updates collaboration metadata and can only be called by the collaboration owner.

Link copied to clipboard

Provides the details necessary to update a configured audience model association.

Link copied to clipboard

Updates a configured table.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Updates a membership.

Link copied to clipboard

Updates the privacy budget template for the specified membership.

Link copied to clipboard

Updates the processing of a currently running query.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.