View Source AWS.CleanRooms (aws-elixir v1.0.0)

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.

Summary

Functions

batch_get_collaboration_analysis_template(client, collaboration_identifier, input, options \\ [])

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

batch_get_schema(client, collaboration_identifier, input, options \\ [])

Retrieves multiple schemas by their identifiers.

batch_get_schema_analysis_rule(client, collaboration_identifier, input, options \\ [])

Retrieves multiple analysis rule schemas.

create_analysis_template(client, membership_identifier, input, options \\ [])

Creates a new analysis template.

create_collaboration(client, input, options \\ [])

Creates a new collaboration.

create_configured_audience_model_association(client, membership_identifier, input, options \\ [])

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

create_configured_table(client, input, options \\ [])

Creates a new configured table resource.

create_configured_table_analysis_rule(client, configured_table_identifier, input, options \\ [])

Creates a new analysis rule for a configured table.

create_configured_table_association(client, membership_identifier, input, options \\ [])

Creates a configured table association.

create_membership(client, input, options \\ [])

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

create_privacy_budget_template(client, membership_identifier, input, options \\ [])

Creates a privacy budget template for a specified membership.

delete_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])

Deletes an analysis template.

delete_collaboration(client, collaboration_identifier, input, options \\ [])

Deletes a collaboration.

delete_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])

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

delete_configured_table(client, configured_table_identifier, input, options \\ [])

Deletes a configured table.

delete_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])

Deletes a configured table analysis rule.

delete_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])

Deletes a configured table association.

delete_member(client, account_id, collaboration_identifier, input, options \\ [])

Removes the specified member from a collaboration.

delete_membership(client, membership_identifier, input, options \\ [])

Deletes a specified membership.

delete_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])

Deletes a privacy budget template for a specified membership.

get_analysis_template(client, analysis_template_identifier, membership_identifier, options \\ [])

Retrieves an analysis template.

get_collaboration(client, collaboration_identifier, options \\ [])

Returns metadata about a collaboration.

get_collaboration_analysis_template(client, analysis_template_arn, collaboration_identifier, options \\ [])

Retrieves an analysis template within a collaboration.

get_collaboration_configured_audience_model_association(client, collaboration_identifier, configured_audience_model_association_identifier, options \\ [])

Retrieves a configured audience model association within a collaboration.

get_collaboration_privacy_budget_template(client, collaboration_identifier, privacy_budget_template_identifier, options \\ [])

Returns details about a specified privacy budget template.

get_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, options \\ [])

Returns information about a configured audience model association.

get_configured_table(client, configured_table_identifier, options \\ [])

Retrieves a configured table.

get_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, options \\ [])

Retrieves a configured table analysis rule.

get_configured_table_association(client, configured_table_association_identifier, membership_identifier, options \\ [])

Retrieves a configured table association.

get_membership(client, membership_identifier, options \\ [])

Retrieves a specified membership for an identifier.

get_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, options \\ [])

Returns details for a specified privacy budget template.

get_protected_query(client, membership_identifier, protected_query_identifier, options \\ [])

Returns query processing metadata.

get_schema(client, collaboration_identifier, name, options \\ [])

Retrieves the schema for a relation within a collaboration.

get_schema_analysis_rule(client, collaboration_identifier, name, type, options \\ [])

Retrieves a schema analysis rule.

list_analysis_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists analysis templates that the caller owns.

list_collaboration_analysis_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists analysis templates within a collaboration.

list_collaboration_configured_audience_model_associations(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists configured audience model associations within a collaboration.

list_collaboration_privacy_budget_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_collaboration_privacy_budgets(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])

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

list_collaborations(client, max_results \\ nil, member_status \\ nil, next_token \\ nil, options \\ [])

Lists 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 \\ [])

Lists information about requested configured audience model associations.

list_configured_table_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists configured table associations for a membership.

list_configured_tables(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists configured tables.

list_members(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all members within a collaboration.

list_memberships(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists all memberships resources within the caller's account.

list_privacy_budget_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_privacy_budgets(client, membership_identifier, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])

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

list_protected_queries(client, membership_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists protected queries, sorted by the most recent query.

list_schemas(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, schema_type \\ nil, options \\ [])

Lists the schemas for relations within a collaboration.

list_tags_for_resource(client, resource_arn, options \\ [])

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

metadata()
preview_privacy_impact(client, membership_identifier, input, options \\ [])

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

start_protected_query(client, membership_identifier, input, options \\ [])

Creates a protected query that is started by Clean Rooms.

tag_resource(client, resource_arn, input, options \\ [])

Tags a resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag or list of tags from a resource.

update_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])

Updates the analysis template metadata.

update_collaboration(client, collaboration_identifier, input, options \\ [])

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

update_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])

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

update_configured_table(client, configured_table_identifier, input, options \\ [])

Updates a configured table.

update_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])

Updates a configured table analysis rule.

update_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])

Updates a configured table association.

update_membership(client, membership_identifier, input, options \\ [])

Updates a membership.

update_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])

Updates the privacy budget template for the specified membership.

update_protected_query(client, membership_identifier, protected_query_identifier, input, options \\ [])

Updates the processing of a currently running query.

Functions

Link to this function

batch_get_collaboration_analysis_template(client, collaboration_identifier, input, options \\ [])

View Source

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

Link to this function

batch_get_schema(client, collaboration_identifier, input, options \\ [])

View Source

Retrieves multiple schemas by their identifiers.

Link to this function

batch_get_schema_analysis_rule(client, collaboration_identifier, input, options \\ [])

View Source

Retrieves multiple analysis rule schemas.

Link to this function

create_analysis_template(client, membership_identifier, input, options \\ [])

View Source

Creates a new analysis template.

Link to this function

create_collaboration(client, input, options \\ [])

View Source

Creates a new collaboration.

Link to this function

create_configured_audience_model_association(client, membership_identifier, input, options \\ [])

View Source

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

Link to this function

create_configured_table(client, input, options \\ [])

View Source

Creates a new configured table resource.

Link to this function

create_configured_table_analysis_rule(client, configured_table_identifier, input, options \\ [])

View Source

Creates a new analysis rule for a configured table.

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

Link to this function

create_configured_table_association(client, membership_identifier, input, options \\ [])

View Source

Creates a configured table association.

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

Link to this function

create_membership(client, input, options \\ [])

View Source

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

Link to this function

create_privacy_budget_template(client, membership_identifier, input, options \\ [])

View Source

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 to this function

delete_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])

View Source

Deletes an analysis template.

Link to this function

delete_collaboration(client, collaboration_identifier, input, options \\ [])

View Source

Deletes a collaboration.

It can only be called by the collaboration owner.

Link to this function

delete_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])

View Source

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

Link to this function

delete_configured_table(client, configured_table_identifier, input, options \\ [])

View Source

Deletes a configured table.

Link to this function

delete_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])

View Source

Deletes a configured table analysis rule.

Link to this function

delete_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])

View Source

Deletes a configured table association.

Link to this function

delete_member(client, account_id, collaboration_identifier, input, options \\ [])

View Source

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 to this function

delete_membership(client, membership_identifier, input, options \\ [])

View Source

Deletes a specified membership.

All resources under a membership must be deleted.

Link to this function

delete_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])

View Source

Deletes a privacy budget template for a specified membership.

Link to this function

get_analysis_template(client, analysis_template_identifier, membership_identifier, options \\ [])

View Source

Retrieves an analysis template.

Link to this function

get_collaboration(client, collaboration_identifier, options \\ [])

View Source

Returns metadata about a collaboration.

Link to this function

get_collaboration_analysis_template(client, analysis_template_arn, collaboration_identifier, options \\ [])

View Source

Retrieves an analysis template within a collaboration.

Link to this function

get_collaboration_configured_audience_model_association(client, collaboration_identifier, configured_audience_model_association_identifier, options \\ [])

View Source

Retrieves a configured audience model association within a collaboration.

Link to this function

get_collaboration_privacy_budget_template(client, collaboration_identifier, privacy_budget_template_identifier, options \\ [])

View Source

Returns details about a specified privacy budget template.

Link to this function

get_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, options \\ [])

View Source

Returns information about a configured audience model association.

Link to this function

get_configured_table(client, configured_table_identifier, options \\ [])

View Source

Retrieves a configured table.

Link to this function

get_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, options \\ [])

View Source

Retrieves a configured table analysis rule.

Link to this function

get_configured_table_association(client, configured_table_association_identifier, membership_identifier, options \\ [])

View Source

Retrieves a configured table association.

Link to this function

get_membership(client, membership_identifier, options \\ [])

View Source

Retrieves a specified membership for an identifier.

Link to this function

get_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, options \\ [])

View Source

Returns details for a specified privacy budget template.

Link to this function

get_protected_query(client, membership_identifier, protected_query_identifier, options \\ [])

View Source

Returns query processing metadata.

Link to this function

get_schema(client, collaboration_identifier, name, options \\ [])

View Source

Retrieves the schema for a relation within a collaboration.

Link to this function

get_schema_analysis_rule(client, collaboration_identifier, name, type, options \\ [])

View Source

Retrieves a schema analysis rule.

Link to this function

list_analysis_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists analysis templates that the caller owns.

Link to this function

list_collaboration_analysis_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists analysis templates within a collaboration.

Link to this function

list_collaboration_configured_audience_model_associations(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists configured audience model associations within a collaboration.

Link to this function

list_collaboration_privacy_budget_templates(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_collaboration_privacy_budgets(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])

View Source

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 to this function

list_collaborations(client, max_results \\ nil, member_status \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_configured_audience_model_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists information about requested configured audience model associations.

Link to this function

list_configured_table_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists configured table associations for a membership.

Link to this function

list_configured_tables(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists configured tables.

Link to this function

list_members(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all members within a collaboration.

Link to this function

list_memberships(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Lists all memberships resources within the caller's account.

Link to this function

list_privacy_budget_templates(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_privacy_budgets(client, membership_identifier, max_results \\ nil, next_token \\ nil, privacy_budget_type, options \\ [])

View Source

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

Link to this function

list_protected_queries(client, membership_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Lists protected queries, sorted by the most recent query.

Link to this function

list_schemas(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, schema_type \\ nil, options \\ [])

View Source

Lists the schemas for relations within a collaboration.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

preview_privacy_impact(client, membership_identifier, input, options \\ [])

View Source

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

Link to this function

start_protected_query(client, membership_identifier, input, options \\ [])

View Source

Creates a protected query that is started by Clean Rooms.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag or list of tags from a resource.

Link to this function

update_analysis_template(client, analysis_template_identifier, membership_identifier, input, options \\ [])

View Source

Updates the analysis template metadata.

Link to this function

update_collaboration(client, collaboration_identifier, input, options \\ [])

View Source

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

Link to this function

update_configured_audience_model_association(client, configured_audience_model_association_identifier, membership_identifier, input, options \\ [])

View Source

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

Link to this function

update_configured_table(client, configured_table_identifier, input, options \\ [])

View Source

Updates a configured table.

Link to this function

update_configured_table_analysis_rule(client, analysis_rule_type, configured_table_identifier, input, options \\ [])

View Source

Updates a configured table analysis rule.

Link to this function

update_configured_table_association(client, configured_table_association_identifier, membership_identifier, input, options \\ [])

View Source

Updates a configured table association.

Link to this function

update_membership(client, membership_identifier, input, options \\ [])

View Source

Updates a membership.

Link to this function

update_privacy_budget_template(client, membership_identifier, privacy_budget_template_identifier, input, options \\ [])

View Source

Updates the privacy budget template for the specified membership.

Link to this function

update_protected_query(client, membership_identifier, protected_query_identifier, input, options \\ [])

View Source

Updates the processing of a currently running query.