View Source aws_cleanrooms (aws v1.0.4)
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: https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference: https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html.Summary
Functions
Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
Retrieves multiple schemas by their identifiers.
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.
Creates a configured table association.
Creates a membership for a specific collaboration identifier and joins the collaboration.
Creates a privacy budget template for a specified membership.
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.
Removes the specified member from a collaboration.
Deletes a specified membership.
delete_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input)
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.
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.
get_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier)
Retrieves a configured table association.
Retrieves a specified membership for an identifier.
Returns details for a specified privacy budget template.
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 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.
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 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.
An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
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 a membership.
update_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input)
Updates the privacy budget template for the specified membership.
Updates the processing of a currently running query.
Functions
Link to this function
batch_get_collaboration_analysis_template(Client, CollaborationIdentifier, Input)
View Source
Link to this function
batch_get_collaboration_analysis_template(Client, CollaborationIdentifier, Input0, Options0)
View Source
Link to this function
batch_get_schema(Client, CollaborationIdentifier, Input0, Options0)
View Source
Link to this function
create_analysis_template(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
create_configured_audience_model_association(Client, MembershipIdentifier, Input)
View Source
Link to this function
create_configured_audience_model_association(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
create_configured_table_analysis_rule(Client, ConfiguredTableIdentifier, Input)
View SourceCreates 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_analysis_rule(Client, ConfiguredTableIdentifier, Input0, Options0)
View Source
Link to this function
create_configured_table_association(Client, MembershipIdentifier, Input)
View SourceCreates a configured table association.
A configured table association links a configured table with a collaboration.
Link to this function
create_configured_table_association(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
create_privacy_budget_template(Client, MembershipIdentifier, Input)
View SourceCreates 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 theUpdatePrivacyBudgetTemplate operation.
Link to this function
create_privacy_budget_template(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
delete_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
delete_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, Input0, Options0)
View SourceDeletes a collaboration.
It can only be called by the collaboration owner.
Link to this function
delete_collaboration(Client, CollaborationIdentifier, Input0, Options0)
View Source
Link to this function
delete_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
delete_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
delete_configured_table(Client, ConfiguredTableIdentifier, Input0, Options0)
View Source
Link to this function
delete_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, Input)
View Source
Link to this function
delete_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, Input0, Options0)
View Source
Link to this function
delete_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
delete_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input0, Options0)
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.
Link to this function
delete_member(Client, AccountId, CollaborationIdentifier, Input0, Options0)
View SourceDeletes a specified membership.
All resources under a membership must be deleted.
Link to this function
delete_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input)
View Source
Link to this function
delete_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input0, Options0)
View Source
Link to this function
get_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier)
View Source
Link to this function
get_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_collaboration(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_collaboration(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_collaboration_analysis_template(Client, AnalysisTemplateArn, CollaborationIdentifier)
View Source
Link to this function
get_collaboration_analysis_template(Client, AnalysisTemplateArn, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_collaboration_analysis_template(Client, AnalysisTemplateArn, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_collaboration_configured_audience_model_association(Client, CollaborationIdentifier, ConfiguredAudienceModelAssociationIdentifier)
View Source
Link to this function
get_collaboration_configured_audience_model_association(Client, CollaborationIdentifier, ConfiguredAudienceModelAssociationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_collaboration_configured_audience_model_association(Client, CollaborationIdentifier, ConfiguredAudienceModelAssociationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_collaboration_privacy_budget_template(Client, CollaborationIdentifier, PrivacyBudgetTemplateIdentifier)
View Source
Link to this function
get_collaboration_privacy_budget_template(Client, CollaborationIdentifier, PrivacyBudgetTemplateIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_collaboration_privacy_budget_template(Client, CollaborationIdentifier, PrivacyBudgetTemplateIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier)
View Source
Link to this function
get_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_table(Client, ConfiguredTableIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_table(Client, ConfiguredTableIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier)
View Source
Link to this function
get_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier)
View Source
Link to this function
get_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_membership(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_membership(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier)
View Source
Link to this function
get_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier)
View Source
Link to this function
get_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
get_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_schema(Client, CollaborationIdentifier, Name, QueryMap, HeadersMap)
View Source
Link to this function
get_schema(Client, CollaborationIdentifier, Name, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_schema_analysis_rule(Client, CollaborationIdentifier, Name, Type)
View Source
Link to this function
get_schema_analysis_rule(Client, CollaborationIdentifier, Name, Type, QueryMap, HeadersMap)
View Source
Link to this function
get_schema_analysis_rule(Client, CollaborationIdentifier, Name, Type, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_analysis_templates(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_analysis_templates(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_collaboration_analysis_templates(Client, CollaborationIdentifier)
View Source
Link to this function
list_collaboration_analysis_templates(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_collaboration_analysis_templates(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_collaboration_configured_audience_model_associations(Client, CollaborationIdentifier)
View Source
Link to this function
list_collaboration_configured_audience_model_associations(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_collaboration_configured_audience_model_associations(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_collaboration_privacy_budget_templates(Client, CollaborationIdentifier)
View Source
Link to this function
list_collaboration_privacy_budget_templates(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_collaboration_privacy_budget_templates(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_collaboration_privacy_budgets(Client, CollaborationIdentifier, PrivacyBudgetType)
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.
Link to this function
list_collaboration_privacy_budgets(Client, CollaborationIdentifier, PrivacyBudgetType, QueryMap, HeadersMap)
View Source
Link to this function
list_collaboration_privacy_budgets(Client, CollaborationIdentifier, PrivacyBudgetType, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_configured_audience_model_associations(Client, MembershipIdentifier)
View Source
Link to this function
list_configured_audience_model_associations(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_configured_audience_model_associations(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_configured_table_associations(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_configured_table_associations(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_members(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_members(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_privacy_budget_templates(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_privacy_budget_templates(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_privacy_budgets(Client, MembershipIdentifier, PrivacyBudgetType)
View Source
Link to this function
list_privacy_budgets(Client, MembershipIdentifier, PrivacyBudgetType, QueryMap, HeadersMap)
View Source
Link to this function
list_privacy_budgets(Client, MembershipIdentifier, PrivacyBudgetType, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_protected_queries(Client, MembershipIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_protected_queries(Client, MembershipIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_schemas(Client, CollaborationIdentifier, QueryMap, HeadersMap)
View Source
Link to this function
list_schemas(Client, CollaborationIdentifier, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
preview_privacy_impact(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
start_protected_query(Client, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
update_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
update_analysis_template(Client, AnalysisTemplateIdentifier, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
update_collaboration(Client, CollaborationIdentifier, Input0, Options0)
View Source
Link to this function
update_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
update_configured_audience_model_association(Client, ConfiguredAudienceModelAssociationIdentifier, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
update_configured_table(Client, ConfiguredTableIdentifier, Input0, Options0)
View Source
Link to this function
update_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, Input)
View Source
Link to this function
update_configured_table_analysis_rule(Client, AnalysisRuleType, ConfiguredTableIdentifier, Input0, Options0)
View Source
Link to this function
update_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input)
View Source
Link to this function
update_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input0, Options0)
View Source
Link to this function
update_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input)
View Source
Link to this function
update_privacy_budget_template(Client, MembershipIdentifier, PrivacyBudgetTemplateIdentifier, Input0, Options0)
View Source
Link to this function
update_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier, Input)
View Source
Link to this function