View Source aws_cleanrooms (aws v0.7.15)

AWS Clean Rooms is in preview release and is subject to change.

Welcome to the AWS Clean Rooms API Reference.

AWS Clean Rooms is an AWS 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 combined data without either party getting access to the other party's raw data.

To learn more about AWS Clean Rooms concepts, procedures, and best practices, see the AWS Clean Rooms User Guide.

Link to this section Summary

Functions

Retrieves multiple schemas by their identifiers.
Creates a new collaboration.
Creates a new configured table resource.

Creates a new analysis rule for a configured table.

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

Removes the specified member from a collaboration.

Returns metadata about a collaboration.
Retrieves a specified membership for an identifier.
Retrieves the schema for a relation within a collaboration.
Lists collaborations the caller owns, is active in, or has been invited to.
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.
Lists protected queries, sorted by the most recent query.
Lists the schemas for relations within a collaboration.
Creates a protected query that is started by AWS Clean Rooms.
Updates collaboration metadata and can only be called by the collaboration owner.

Link to this section Functions

Link to this function

batch_get_schema(Client, CollaborationIdentifier, Input)

View Source
Retrieves multiple schemas by their identifiers.
Link to this function

batch_get_schema(Client, CollaborationIdentifier, Input0, Options0)

View Source
Link to this function

create_collaboration(Client, Input)

View Source
Creates a new collaboration.
Link to this function

create_collaboration(Client, Input0, Options0)

View Source
Link to this function

create_configured_table(Client, Input)

View Source
Creates a new configured table resource.
Link to this function

create_configured_table(Client, Input0, Options0)

View Source
Link to this function

create_configured_table_analysis_rule(Client, ConfiguredTableIdentifier, Input)

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_analysis_rule(Client, ConfiguredTableIdentifier, Input0, Options0)

View Source
Link to this function

create_configured_table_association(Client, MembershipIdentifier, Input)

View Source

Creates 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_membership(Client, Input)

View Source
Creates a membership for a specific collaboration identifier and joins the collaboration.
Link to this function

create_membership(Client, Input0, Options0)

View Source
Link to this function

delete_collaboration(Client, CollaborationIdentifier, Input)

View Source

Deletes 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_table(Client, ConfiguredTableIdentifier, Input)

View Source
Deletes a configured table.
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
Deletes a configured table analysis rule.
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
Deletes a configured table association.
Link to this function

delete_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input0, Options0)

View Source
Link to this function

delete_member(Client, AccountId, CollaborationIdentifier, Input)

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_member(Client, AccountId, CollaborationIdentifier, Input0, Options0)

View Source
Link to this function

delete_membership(Client, MembershipIdentifier, Input)

View Source

Deletes a specified membership.

All resources under a membership must be deleted.
Link to this function

delete_membership(Client, MembershipIdentifier, Input0, Options0)

View Source
Link to this function

get_collaboration(Client, CollaborationIdentifier)

View Source
Returns metadata about a collaboration.
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_configured_table(Client, ConfiguredTableIdentifier)

View Source
Retrieves a configured table.
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
Retrieves a configured table analysis rule.
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
Retrieves a configured table association.
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)

View Source
Retrieves a specified membership for an identifier.
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_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier)

View Source
Returns query processing metadata.
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)

View Source
Retrieves the schema for a relation within a collaboration.
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
Retrieves a schema analysis rule.
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_collaborations(Client)

View Source
Lists collaborations the caller owns, is active in, or has been invited to.
Link to this function

list_collaborations(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_collaborations(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_configured_table_associations(Client, MembershipIdentifier)

View Source
Lists configured table associations for a membership.
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_configured_tables(Client)

View Source
Lists configured tables.
Link to this function

list_configured_tables(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_configured_tables(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_members(Client, CollaborationIdentifier)

View Source
Lists all members within a collaboration.
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_memberships(Client)

View Source
Lists all memberships resources within the caller's account.
Link to this function

list_memberships(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_memberships(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_protected_queries(Client, MembershipIdentifier)

View Source
Lists protected queries, sorted by the most recent query.
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)

View Source
Lists the schemas for relations within a collaboration.
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

start_protected_query(Client, MembershipIdentifier, Input)

View Source
Creates a protected query that is started by AWS Clean Rooms.
Link to this function

start_protected_query(Client, MembershipIdentifier, Input0, Options0)

View Source
Link to this function

update_collaboration(Client, CollaborationIdentifier, Input)

View Source
Updates collaboration metadata and can only be called by the collaboration owner.
Link to this function

update_collaboration(Client, CollaborationIdentifier, Input0, Options0)

View Source
Link to this function

update_configured_table(Client, ConfiguredTableIdentifier, Input)

View Source
Updates a configured table.
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
Updates a configured table analysis rule.
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
Updates a configured table association.
Link to this function

update_configured_table_association(Client, ConfiguredTableAssociationIdentifier, MembershipIdentifier, Input0, Options0)

View Source
Link to this function

update_membership(Client, MembershipIdentifier, Input)

View Source
Updates a membership.
Link to this function

update_membership(Client, MembershipIdentifier, Input0, Options0)

View Source
Link to this function

update_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier, Input)

View Source
Updates the processing of a currently running query.
Link to this function

update_protected_query(Client, MembershipIdentifier, ProtectedQueryIdentifier, Input0, Options0)

View Source