View Source AWS.CleanRooms (aws-elixir v1.0.14)
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.
Link to this section Summary
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.
Creates a new change request to modify an existing 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.
Creates a configured table association.
Creates a new analysis rule for an associated configured table.
Creates an ID mapping table.
Creates an ID namespace association.
Creates an intermediate table in a membership.
Creates an analysis rule for an intermediate table.
Creates a membership for a specific collaboration identifier and joins the collaboration.
Creates a privacy budget template for a specified collaboration.
Deletes an analysis template.
Deletes a collaboration.
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.
Deletes an intermediate table.
Deletes an analysis rule from an intermediate table.
Removes the specified member from a collaboration.
Deletes a specified membership.
Deletes a privacy budget template for a specified collaboration.
Invalidates a specific intermediate table that references the caller's base table.
Retrieves an analysis template.
Returns metadata about a collaboration.
Retrieves an analysis template within a collaboration.
Retrieves detailed information about a specific collaboration change request.
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 an intermediate table.
Retrieves the analysis rule for an intermediate table.
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 all change requests for a collaboration with pagination support.
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 template in a specified collaboration.
Returns an array that summarizes each privacy budget 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 the version history of an intermediate table.
Lists intermediate tables owned by the caller in a membership.
Lists all members within a collaboration.
Lists all memberships resources within the caller's account.
Returns detailed information about the privacy budget templates in a specified membership.
Returns detailed information about the privacy budgets 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.
Executes the stored query of an intermediate table to materialize data into managed storage.
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.
Updates an existing collaboration change request.
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 an intermediate table.
Updates the analysis rule policy for an intermediate table.
Updates a membership.
Updates the privacy budget template for the specified collaboration.
Updates the processing of a currently running job.
Updates the processing of a currently running query.
Link to this section Functions
batch_get_collaboration_analysis_template(client, collaboration_identifier, input, options \\ [])
View SourceRetrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
batch_get_schema(client, collaboration_identifier, input, options \\ [])
View SourceRetrieves multiple schemas by their identifiers.
batch_get_schema_analysis_rule(client, collaboration_identifier, input, options \\ [])
View SourceRetrieves multiple analysis rule schemas.
create_analysis_template(client, membership_identifier, input, options \\ [])
View SourceCreates a new analysis template.
Creates a new collaboration.
create_collaboration_change_request(client, collaboration_identifier, input, options \\ [])
View SourceCreates a new change request to modify an existing collaboration.
This enables post-creation modifications to collaborations through a structured API-driven approach.
create_configured_audience_model_association(client, membership_identifier, input, options \\ [])
View SourceProvides the details necessary to create a configured audience model association.
Creates a new configured table resource.
create_configured_table_analysis_rule(client, configured_table_identifier, input, options \\ [])
View SourceCreates a new analysis rule for a configured table.
Currently, only one analysis rule can be created for a given configured table.
create_configured_table_association(client, membership_identifier, input, options \\ [])
View SourceCreates a configured table association.
A configured table association links a configured table with a collaboration.
create_configured_table_association_analysis_rule(client, configured_table_association_identifier, membership_identifier, input, options \\ [])
View SourceCreates a new analysis rule for an associated configured table.
create_id_mapping_table(client, membership_identifier, input, options \\ [])
View SourceCreates an ID mapping table.
create_id_namespace_association(client, membership_identifier, input, options \\ [])
View SourceCreates an ID namespace association.
create_intermediate_table(client, membership_identifier, input, options \\ [])
View SourceCreates an intermediate table in a membership.
An intermediate table stores a query definition that you can execute later using
PopulateIntermediateTable to materialize cached results. The intermediate
table is owned by the member with the CAN_QUERY ability. This operation does not
execute the stored query.
create_intermediate_table_analysis_rule(client, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceCreates an analysis rule for an intermediate table.
Only the CUSTOM analysis rule type is supported. The service automatically determines whether the rule is first-party or multi-party restricted based on the intermediate table's inherited constraints. Only the intermediate table owner can call this operation.
Creates a membership for a specific collaboration identifier and joins the collaboration.
create_privacy_budget_template(client, membership_identifier, input, options \\ [])
View SourceCreates a privacy budget template for a specified collaboration.
Each collaboration can have only one privacy budget template. If you need to
change the privacy budget template, use the UpdatePrivacyBudgetTemplate
operation.
delete_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an analysis template.
delete_collaboration(client, collaboration_identifier, input, options \\ [])
View SourceDeletes a collaboration.
It can only be called by the collaboration owner.
delete_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])
View SourceProvides the information necessary to delete a configured audience model association.
delete_configured_table(client, configured_table_identifier, input, options \\ [])
View SourceDeletes a configured table.
delete_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])
View SourceDeletes a configured table analysis rule.
delete_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])
View SourceDeletes a configured table association.
delete_configured_table_association_analysis_rule(client, analysis_rule_type, configured_table_association_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an analysis rule for a configured table association.
delete_id_mapping_table(client, id_mapping_table_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an ID mapping table.
delete_id_namespace_association(client, id_namespace_association_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an ID namespace association.
delete_intermediate_table(client, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an intermediate table.
When you delete the table, the service marks it as DELETED, removes its analysis rule and schema, and triggers storage cleanup. This operation is idempotent. Only the intermediate table owner can call this operation.
delete_intermediate_table_analysis_rule(client, analysis_rule_type, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceDeletes an analysis rule from an intermediate table.
After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule is attached. Only the intermediate table owner can call this operation.
delete_member(client, account_id, collaboration_identifier, input, options \\ [])
View SourceRemoves 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.
delete_membership(client, membership_identifier, input, options \\ [])
View SourceDeletes a specified membership.
All resources under a membership must be deleted.
delete_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])
View SourceDeletes a privacy budget template for a specified collaboration.
disallow_intermediate_table(client, membership_identifier, input, options \\ [])
View SourceInvalidates a specific intermediate table that references the caller's base table.
The data provider (base table owner) calls this operation, not the intermediate table owner. By default, invalidation cascades to descendant intermediate tables.
get_analysis_template(client, analysis_template_identifier, membership_identifier, options \\ [])
View SourceRetrieves an analysis template.
get_collaboration(client, collaboration_identifier, options \\ [])
View SourceReturns metadata about a collaboration.
get_collaboration_analysis_template(client, analysis_template_arn, collaboration_identifier, options \\ [])
View SourceRetrieves an analysis template within a collaboration.
get_collaboration_change_request(client, change_request_identifier, collaboration_identifier, options \\ [])
View SourceRetrieves detailed information about a specific collaboration change request.
get_collaboration_configured_audience_model_association(client, collaboration_identifier, configured_audience_model_association_identifier, options \\ [])
View SourceRetrieves a configured audience model association within a collaboration.
get_collaboration_id_namespace_association(client, collaboration_identifier, id_namespace_association_identifier, options \\ [])
View SourceRetrieves an ID namespace association from a specific collaboration.
get_collaboration_privacy_budget_template(client, collaboration_identifier, privacy_budget_template_identifier, options \\ [])
View SourceReturns details about a specified privacy budget template.
get_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, options \\ [])
View SourceReturns information about a configured audience model association.
get_configured_table(client, configured_table_identifier, options \\ [])
View SourceRetrieves a configured table.
get_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, options \\ [])
View SourceRetrieves a configured table analysis rule.
get_configured_table_association(client, configured_table_association_identifier, membership_identifier, options \\ [])
View SourceRetrieves a configured table association.
get_configured_table_association_analysis_rule(client, analysis_rule_type, configured_table_association_identifier, membership_identifier, options \\ [])
View SourceRetrieves the analysis rule for a configured table association.
get_id_mapping_table(client, id_mapping_table_identifier, membership_identifier, options \\ [])
View SourceRetrieves an ID mapping table.
get_id_namespace_association(client, id_namespace_association_identifier, membership_identifier, options \\ [])
View SourceRetrieves an ID namespace association.
get_intermediate_table(client, intermediate_table_identifier, membership_identifier, options \\ [])
View SourceRetrieves an intermediate table.
Returns the full details of the intermediate table, including schema, table dependencies, inherited constraints, child resources, and status. Only the intermediate table owner can call this operation.
get_intermediate_table_analysis_rule(client, analysis_rule_type, intermediate_table_identifier, membership_identifier, options \\ [])
View SourceRetrieves the analysis rule for an intermediate table.
Retrieves a specified membership for an identifier.
get_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, options \\ [])
View SourceReturns details for a specified privacy budget template.
get_protected_job(client, membership_identifier, protected_job_identifier, options \\ [])
View SourceReturns job processing metadata.
get_protected_query(client, membership_identifier, protected_query_identifier, options \\ [])
View SourceReturns query processing metadata.
Retrieves the schema for a relation within a collaboration.
get_schema_analysis_rule(client, collaboration_identifier, name, type, options \\ [])
View SourceRetrieves a schema analysis rule.
list_analysis_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists analysis templates that the caller owns.
list_collaboration_analysis_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists analysis templates within a collaboration.
list_collaboration_change_requests(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists all change requests for a collaboration with pagination support.
Returns change requests sorted by creation time.
list_collaboration_configured_audience_model_associations(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists configured audience model associations within a collaboration.
list_collaboration_id_namespace_associations(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the ID namespace associations in a collaboration.
list_collaboration_privacy_budget_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns an array that summarizes each privacy budget template in a specified collaboration.
list_collaboration_privacy_budgets(client, collaboration_identifier, access_budget_resource_arn \\ nil, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])
View SourceReturns 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.
list_collaborations(client, max_results \\ nil, member_status \\ nil, next_token \\ nil, options \\ [])
View SourceLists collaborations the caller owns, is active in, or has been invited to.
list_configured_audience_model_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists information about requested configured audience model associations.
list_configured_table_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists configured table associations for a membership.
list_configured_tables(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists configured tables.
list_id_mapping_tables(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of ID mapping tables.
list_id_namespace_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of ID namespace associations.
list_intermediate_table_versions(client, intermediate_table_identifier, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the version history of an intermediate table.
Each call to PopulateIntermediateTable creates a new version. We recommend
using pagination to ensure that the operation returns quickly and successfully.
list_intermediate_tables(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists intermediate tables owned by the caller in a membership.
We recommend using pagination to ensure that the operation returns quickly and successfully.
list_members(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all members within a collaboration.
list_memberships(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists all memberships resources within the caller's account.
list_privacy_budget_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns detailed information about the privacy budget templates in a specified membership.
list_privacy_budgets(client, membership_identifier, access_budget_resource_arn \\ nil, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])
View SourceReturns detailed information about the privacy budgets in a specified membership.
list_protected_jobs(client, membership_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists protected jobs, sorted by most recent job.
list_protected_queries(client, membership_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists protected queries, sorted by the most recent query.
list_schemas(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, schema_type \\ nil, options \\ [])
View SourceLists the schemas for relations within a collaboration.
Lists all of the tags that have been added to a resource.
populate_id_mapping_table(client, id_mapping_table_identifier, membership_identifier, input, options \\ [])
View SourceDefines the information that's necessary to populate an ID mapping table.
populate_intermediate_table(client, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceExecutes the stored query of an intermediate table to materialize data into managed storage.
With this operation, you can perform initial population and subsequent
refreshes. Each call creates a new version. The returned analysis ID can be
tracked using GetProtectedQuery. Only the intermediate table owner can call
this operation.
preview_privacy_impact(client, membership_identifier, input, options \\ [])
View SourceAn estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
start_protected_job(client, membership_identifier, input, options \\ [])
View SourceCreates a protected job that is started by Clean Rooms.
start_protected_query(client, membership_identifier, input, options \\ [])
View SourceCreates a protected query that is started by Clean Rooms.
Tags a resource.
Removes a tag or list of tags from a resource.
update_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])
View SourceUpdates the analysis template metadata.
update_collaboration(client, collaboration_identifier, input, options \\ [])
View SourceUpdates collaboration metadata and can only be called by the collaboration owner.
update_collaboration_change_request(client, change_request_identifier, collaboration_identifier, input, options \\ [])
View SourceUpdates an existing collaboration change request.
This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT).
For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.
update_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])
View SourceProvides the details necessary to update a configured audience model association.
update_configured_table(client, configured_table_identifier, input, options \\ [])
View SourceUpdates a configured table.
update_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])
View SourceUpdates a configured table analysis rule.
update_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])
View SourceUpdates a configured table association.
update_configured_table_association_analysis_rule(client, analysis_rule_type, configured_table_association_identifier, membership_identifier, input, options \\ [])
View SourceUpdates the analysis rule for a configured table association.
update_id_mapping_table(client, id_mapping_table_identifier, membership_identifier, input, options \\ [])
View SourceProvides the details that are necessary to update an ID mapping table.
update_id_namespace_association(client, id_namespace_association_identifier, membership_identifier, input, options \\ [])
View SourceProvides the details that are necessary to update an ID namespace association.
update_intermediate_table(client, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceUpdates an intermediate table.
You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call this operation.
update_intermediate_table_analysis_rule(client, analysis_rule_type, intermediate_table_identifier, membership_identifier, input, options \\ [])
View SourceUpdates the analysis rule policy for an intermediate table.
Only the intermediate table owner can call this operation.
update_membership(client, membership_identifier, input, options \\ [])
View SourceUpdates a membership.
update_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])
View SourceUpdates the privacy budget template for the specified collaboration.
update_protected_job(client, membership_identifier, protected_job_identifier, input, options \\ [])
View SourceUpdates the processing of a currently running job.
update_protected_query(client, membership_identifier, protected_query_identifier, input, options \\ [])
View SourceUpdates the processing of a currently running query.