CleanRoomsClient
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 run queries and jobs 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.
Functions
Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
Retrieves multiple schemas by their identifiers.
Retrieves multiple analysis rule schemas.
Creates a new analysis template.
Creates a new collaboration.
Provides the details necessary to create a configured audience model association.
Creates a new configured table resource.
Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
Creates a configured table association. A configured table association links a configured table with a collaboration.
Creates a new analysis rule for an associated configured table.
Creates an ID mapping table.
Creates an ID namespace association.
Creates a membership for a specific collaboration identifier and joins the collaboration.
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.
Deletes an analysis template.
Deletes a collaboration. It can only be called by the collaboration owner.
Provides the information necessary to delete a configured audience model association.
Deletes a configured table.
Deletes a configured table analysis rule.
Deletes a configured table association.
Deletes an analysis rule for a configured table association.
Deletes an ID mapping table.
Deletes an ID namespace association.
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.
Deletes a specified membership. All resources under a membership must be deleted.
Deletes a privacy budget template for a specified membership.
Retrieves an analysis template.
Returns metadata about a collaboration.
Retrieves an analysis template within a collaboration.
Retrieves a configured audience model association within a collaboration.
Retrieves an ID namespace association from a specific collaboration.
Returns details about a specified privacy budget template.
Returns information about a configured audience model association.
Retrieves a configured table.
Retrieves a configured table analysis rule.
Retrieves a configured table association.
Retrieves the analysis rule for a configured table association.
Retrieves an ID mapping table.
Retrieves an ID namespace association.
Retrieves a specified membership for an identifier.
Returns details for a specified privacy budget template.
Returns job processing metadata.
Returns query processing metadata.
Retrieves the schema for a relation within a collaboration.
Retrieves a schema analysis rule.
Lists analysis templates that the caller owns.
Lists analysis templates within a collaboration.
Lists configured audience model associations within a collaboration.
Returns a list of the ID namespace associations in a collaboration.
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.
Returns an array that summarizes each privacy budget template in a specified collaboration.
Lists collaborations the caller owns, is active in, or has been invited to.
Lists information about requested configured audience model associations.
Lists configured table associations for a membership.
Lists configured tables.
Returns a list of ID mapping tables.
Returns a list of ID namespace associations.
Lists all members within a collaboration.
Lists all memberships resources within the caller's account.
Returns detailed information about the privacy budgets in a specified membership.
Returns detailed information about the privacy budget templates in a specified membership.
Lists protected jobs, sorted by most recent job.
Lists protected queries, sorted by the most recent query.
Lists the schemas for relations within a collaboration.
Lists all of the tags that have been added to a resource.
Defines the information that's necessary to populate an ID mapping table.
An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
Creates a protected job that is started by Clean Rooms.
Creates a protected query that is started by Clean Rooms.
Tags a resource.
Removes a tag or list of tags from a resource.
Updates the analysis template metadata.
Updates collaboration metadata and can only be called by the collaboration owner.
Provides the details necessary to update a configured audience model association.
Updates a configured table.
Updates a configured table analysis rule.
Updates a configured table association.
Updates the analysis rule for a configured table association.
Provides the details that are necessary to update an ID mapping table.
Provides the details that are necessary to update an ID namespace association.
Updates a membership.
Updates the privacy budget template for the specified membership.
Updates the processing of a currently running job.
Updates the processing of a currently running query.
Inherited functions
Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
Retrieves multiple schemas by their identifiers.
Retrieves multiple analysis rule schemas.
Creates a new analysis template.
Creates a new collaboration.
Provides the details necessary to create a configured audience model association.
Creates a new configured table resource.
Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
Creates a configured table association. A configured table association links a configured table with a collaboration.
Creates a new analysis rule for an associated configured table.
Creates an ID mapping table.
Creates an ID namespace association.
Creates a membership for a specific collaboration identifier and joins the collaboration.
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.
Deletes an analysis template.
Deletes a collaboration. It can only be called by the collaboration owner.
Provides the information necessary to delete a configured audience model association.
Deletes a configured table.
Deletes a configured table analysis rule.
Deletes a configured table association.
Deletes an analysis rule for a configured table association.
Deletes an ID mapping table.
Deletes an ID namespace association.
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.
Deletes a specified membership. All resources under a membership must be deleted.
Deletes a privacy budget template for a specified membership.
Retrieves an analysis template.
Returns metadata about a collaboration.
Retrieves an analysis template within a collaboration.
Retrieves a configured audience model association within a collaboration.
Retrieves an ID namespace association from a specific collaboration.
Returns details about a specified privacy budget template.
Returns information about a configured audience model association.
Retrieves a configured table.
Retrieves a configured table analysis rule.
Retrieves a configured table association.
Retrieves the analysis rule for a configured table association.
Retrieves an ID mapping table.
Retrieves an ID namespace association.
Retrieves a specified membership for an identifier.
Returns details for a specified privacy budget template.
Returns job processing metadata.
Returns query processing metadata.
Retrieves the schema for a relation within a collaboration.
Retrieves a schema analysis rule.
Lists analysis templates that the caller owns.
Paginate over ListAnalysisTemplatesResponse results.
Lists analysis templates within a collaboration.
Paginate over ListCollaborationAnalysisTemplatesResponse results.
Lists configured audience model associations within a collaboration.
Paginate over ListCollaborationConfiguredAudienceModelAssociationsResponse results.
Returns a list of the ID namespace associations in a collaboration.
Paginate over ListCollaborationIdNamespaceAssociationsResponse results.
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.
Paginate over ListCollaborationPrivacyBudgetsResponse results.
Returns an array that summarizes each privacy budget template in a specified collaboration.
Paginate over ListCollaborationPrivacyBudgetTemplatesResponse results.
Lists collaborations the caller owns, is active in, or has been invited to.
Paginate over ListCollaborationsResponse results.
Lists information about requested configured audience model associations.
Paginate over ListConfiguredAudienceModelAssociationsResponse results.
Lists configured table associations for a membership.
Paginate over ListConfiguredTableAssociationsResponse results.
Lists configured tables.
Paginate over ListConfiguredTablesResponse results.
Returns a list of ID mapping tables.
Paginate over ListIdMappingTablesResponse results.
Returns a list of ID namespace associations.
Paginate over ListIdNamespaceAssociationsResponse results.
Lists all members within a collaboration.
Lists all memberships resources within the caller's account.
Paginate over ListMembershipsResponse results.
Paginate over ListMembersResponse results.
Returns detailed information about the privacy budgets in a specified membership.
Paginate over ListPrivacyBudgetsResponse results.
Returns detailed information about the privacy budget templates in a specified membership.
Paginate over ListPrivacyBudgetTemplatesResponse results.
Lists protected jobs, sorted by most recent job.
Paginate over ListProtectedJobsResponse results.
Lists protected queries, sorted by the most recent query.
Paginate over ListProtectedQueriesResponse results.
Lists the schemas for relations within a collaboration.
Paginate over ListSchemasResponse results.
Lists all of the tags that have been added to a resource.
Defines the information that's necessary to populate an ID mapping table.
An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
Creates a protected job that is started by Clean Rooms.
Creates a protected query that is started by Clean Rooms.
Tags a resource.
Removes a tag or list of tags from a resource.
Updates the analysis template metadata.
Updates collaboration metadata and can only be called by the collaboration owner.
Provides the details necessary to update a configured audience model association.
Updates a configured table.
Updates a configured table analysis rule.
Updates a configured table association.
Updates the analysis rule for a configured table association.
Provides the details that are necessary to update an ID mapping table.
Provides the details that are necessary to update an ID namespace association.
Updates a membership.
Updates the privacy budget template for the specified membership.
Updates the processing of a currently running job.
Updates the processing of a currently running query.
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.