Managing collaborations in AWS Clean Rooms
The following topics describe how the collaboration creator can manage a collaboration in AWS Clean Rooms using the AWS Clean Rooms console.
For information about how to manage a collaboration using the AWS SDKs, see the AWS Clean Rooms API Reference.
Topics
- Editing collaborations
- Deleting collaborations
- Viewing collaborations
- Viewing tables and analysis rules
- Viewing differential privacy usage logs
- Monitoring member status
- Removing a member from a collaboration
- Leaving a collaboration
- Editing configured table associations
- Disassociating configured tables
- Editing a differential privacy policy
- Deleting a differential privacy policy
- Viewing the calculated differential privacy parameters
Editing collaborations
Learn how to edit the different parts of a collaboration.
Topics
Edit collaboration name and description
After you create the collaboration, you can only edit the collaboration name and description.
Note
If you have enabled Query logging, you can edit whether the query logs are stored in your Amazon CloudWatch Logs account.
To edit the collaboration name and description
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
On the collaboration detail page, choose Actions, and then choose Edit collaboration.
-
For Details, edit the Name and Description of the collaboration.
-
Choose Save changes.
Edit collaboration tags
As a collaboration creator, after you have created a collaboration, you can manage the tags on the collaboration resource.
To edit the collaboration tags
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose one of the following:
If you are... Then ... A member of the collaboration Choose the Details tab. The collaboration creator but not a member of the collaboration Scroll down the page to the Tags section. -
For Collaboration details, choose Manage tags.
-
On the Manage tags page, you can do the following:
-
To remove a tag, choose Remove.
-
To add a tag, choose Add new tag.
-
To save your changes, choose Save changes
-
Edit membership tags
As a collaboration creator, after you have created a collaboration, you can manage the tags on the membership resource.
To edit the membership tags
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose the Details tab.
-
For Membership details, choose Manage tags.
-
On the Manage membership tags page, you can do the following:
-
To remove a tag, choose Remove.
-
To add a tag, choose Add new tag.
-
To save your changes, choose Save changes.
-
Edit associated table tags
As a collaboration creator, after you associate tables to a collaboration, you can manage the tags on the associated table resource.
To edit the associated table tags
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose the Tables tab.
-
For Tables associated by you, choose a table.
-
On the configured table detail page, for Tags, choose Manage tags.
On the Manage tags page, you can do the following:
-
To remove a tag, choose Remove.
-
To add a tag, choose Add new tag.
-
To save your changes, choose Save changes.
-
Edit analysis template tags
As a collaboration creator, after you have created a collaboration, you can manage the tags on the analysis template resource.
To edit the membership tags
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose the Templates tab.
-
On the Analysis templates created by you section, choose the analysis template.
-
On the analysis template table detail page, scroll down to the Tags section.
-
Choose Manage tags.
-
On the Manage tags page, you can do the following:
-
To remove a tag, choose Remove.
-
To add a tag, choose Add new tag.
-
To save your changes, choose Save changes.
-
Edit differential privacy policy tags
As a collaboration creator, after you have created a collaboration, you can manage the tags on the analysis template resource.
To edit the membership tags
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that contains the differential privacy policy you want to edit.
-
Choose the Tables tab.
-
On the Tables tab, choose the Manage tags.
-
On the Manage tags page, you can do the following:
-
To remove a tag, choose Remove.
-
To add a tag, choose Add new tag.
-
To save your changes, choose Save changes.
-
Deleting collaborations
As a collaboration creator, you can delete a collaboration that you created.
Note
When you delete a collaboration, you and all members can't run queries, receive results, or contribute data. Each collaboration member continues to have access to their own data as part of their membership.
To delete a collaboration
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you want to delete.
-
Under Actions, choose Delete collaboration.
-
Confirm the deletion and then choose Delete.
Viewing collaborations
As a collaboration creator, you can view all of the collaborations that you created.
To view collaborations
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
On the Collaborations page, under Last used, view the last 5 collaborations used.
-
On the With active membership tab, view the list of Collaborations with active membership.
You can sort by Name, the Membership created date, and Your member details.
You can use the Search bar to search for a collaboration.
-
On the Available to join tab, view the list of Collaborations available to join.
-
On the No longer available tab, view the list of deleted collaborations and Memberships for collaborations that are no longer available (removed memberships).
Viewing tables and analysis rules
To view tables associated with the collaboration and the analysis rules
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
Choose the Tables tab.
-
Choose one of the following:
-
To view your tables associated in the collaboration, for Tables associated by you, choose a table (blue text).
-
To view other tables associated in the collaboration, for Tables associated by collaborators, choose a table (blue text).
-
-
View the table details and analysis rules on the table details page.
Viewing differential privacy usage logs
As a collaboration member who is protecting data with differential privacy, after you have created a collaboration with differential privacy, you can monitor the usage of the privacy budget.
To view how many aggregations were run and how much of the privacy budget was used
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
Choose the Tables tab.
-
Choose View usage logs (blue text).
-
View the usage details, including the privacy budget and how much utility was provided.
Monitoring member status
As a collaboration creator, after you have created a collaboration, you can monitor the status of all members on the Members tab.
To check the status of a member
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose the Members tab.
-
View the Member status of each member.
Removing a member from a collaboration
Note
Removing a member also removes all of their associated datasets from the collaboration.
To remove a member from a collaboration
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration that you created.
-
Choose the Members tab.
-
Select the option button next to the member to be removed.
Note
A collaboration creator can't choose their own account ID.
-
Choose Remove.
-
In the dialog box, confirm the decision to remove the member by typing
confirm
in the text input field.Note
If you remove the member paying for query compute costs, no more queries are allowed to run in the collaboration.
Leaving a collaboration
As a collaboration member, you can leave a collaboration by deleting your membership. If you are the collaboration creator, you can only leave a collaboration by deleting the collaboration.
Note
When you delete your membership, you leave the collaboration and can't re-join it. If you are the member paying for query compute costs and you delete your membership, no more queries are allowed to run.
To leave a collaboration
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
For With active membership, choose the collaboration of which you are a member.
-
Choose Actions.
-
Choose Delete membership.
-
In the dialog box, confirm the decision to leave the collaboration by typing
confirm
in the text input field, and then choose Empty and delete membership.You see a message on the console indicating that the membership was deleted.
The collaboration creator sees the Member status as Left.
Editing configured table associations
As a collaboration member, you can edit the configured table associations that you have created.
To edit configured table associations
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
Choose Tables tab.
-
For Tables associated by you, choose a table.
-
On the table details page, scroll down to view the Table association details.
-
Choose Edit.
-
On the Edit configured table associations page, update the Description or the Service access information.
-
Choose Save changes.
Disassociating configured tables
As a collaboration member, you can disassociate a configured table from the collaboration. This action prevents the member who can query from querying the table.
To disassociate a configured table
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
Choose Tables tab.
-
For Tables associated by you, select the option button next to the table that you want to disassociate.
-
Choose Disassociate.
-
In the dialog box, confirm the decision to disassociate the configured table and prevent the member who can query from querying the table by choosing Disassociate.
Editing a differential privacy policy
At any time after configuring the differential privacy policy, you can update it to better reflect your privacy needs.
To edit the differential privacy policy
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
On the Tables tab of the collaboration page, under Tables associated by you, choose Edit.
-
On the Edit differential privacy page, choose new values for the following properties:
-
Privacy budget – Move the slider bar to either increase or decrease the budget at any point during a collaboration. You can't decrease the budget after the member who can query has started querying your data. If the Privacy budget is increased, AWS Clean Rooms will continue using the existing budget until it is fully consumed before utilizing the newly added privacy budget.
-
Noise added per query – Move the slider bar to either increase or decrease the Noise added per query at any point during a collaboration.
Note
You can chose Interactive examples to explore how different values of Privacy budget and Noise added per query affect the number of aggregate functions that you can run.
You can't change the value of the Privacy budget refresh. To change your selection, you must delete the differential privacy policy and create a new one.
-
-
Choose Save changes.
You see a confirmation message that you’ve successfully edited the differential privacy policy.
Deleting a differential privacy policy
You can delete the differential privacy policy from the Tables tab of a collaboration.
To delete the differential privacy policy
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
On the Tables tab of the collaboration page, next to Differential privacy policy, select Delete.
-
If you’re certain that you want to delete the differential privacy policy, choose Delete.
After deleting a differential privacy policy, you can't access the privacy budget usage logs from that policy. Tables with differential privacy turned on can't be queried if the differential privacy policy is deleted.
Viewing the calculated differential privacy parameters
For users with expertise in differential privacy, you can view the calculated differential privacy parameters from the Queries tab of a collaboration.
To view the calculated differential privacy parameters
-
Sign in to the AWS Management Console and open the AWS Clean Rooms console
with your AWS account (if you have not yet done so). -
In the left navigation pane, choose Collaborations.
-
Choose the collaboration.
-
On the Queries tab, in the Results section, select View calculated differential privacy parameters.
In the Calculated differential privacy parameters table, you can see sensitivity values of aggregate functions, which is defined as the maximum amount by which the result of a function can change if a single user's records are added, removed, or modified. The list includes the following differential privacy parameters:
-
User contribution limit (UCL) is the maximum number of rows contributed by a user in a SQL query. For example, if you want to count the total number of matched impressions in a specified campaign where each user can have multiple impressions, AWS Clean Rooms Differential Privacy needs to bound the number of impressions of a single user in order to ensure that the differential privacy calculation is accurate. In other words, if any user has more impressions than the bound, then AWS Clean Rooms automatically takes a uniform random sample of that user's impressions as per the computed UCL value and exclude the remaining impressions of that user while executing the query. The UCL value equals to 1 if you are counting the number of unique users. This is because adding, removing, or modifying a single user can change the count of distinct users by at most 1.
-
Minimum value is the lower bound of an expression used within an aggregate function such as
sum()
. For example, if the expression is a column known aspurchase_value
, minimum value is the lower bound of the column. -
Maximum value is the upper bound of an expression used within an aggregate function such as
sum()
. For example, if the expression is a column known aspurchase_value
, maximum value is the upper bound of the column.
In the Calculated differential privacy parameters table, you can use these parameters to
better understand the total amount of noise in query results. For example, when the configured Noise
added per query is 30 users and a COUNT DISTINCT (user_id)
query is run, then AWS Clean Rooms
Differential Privacy adds random noise that falls between -30 and 30 with high probability because the sensitivity
of COUNT DISTINCT
is 1. In the case of a COUNT
query with the same configuration, AWS Clean Rooms
Differential Privacy adds statistical noise that is scaled by the user contribution limit because a single user
could contribute multiple rows to the query result. In the case of SUM
query like SUM
(purchase_value)
where all the column values are positive, the total noise is scaled by the user
contribution limit times the maximum value. AWS Clean Rooms Differential Privacy automatically computes the sensitivity
parameters to perform noise addition at query run-time and depletes the privacy budget. The depletion of privacy
budget is required because the sensitivity parameters are data-dependent.