AWS Clean Rooms Service
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 103
Collaboration
- POSTBatch get collaboration analysis template
/collaborations/:collaborationIdentifier/batch-analysistemplatesRetrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs). - POSTBatch get schema
/collaborations/:collaborationIdentifier/batch-schemaRetrieves multiple schemas by their identifiers. - POSTBatch get schema analysis rule
/collaborations/:collaborationIdentifier/batch-schema-analysis-ruleRetrieves multiple analysis rule schemas. - GETList collaborations
/collaborations?nextToken=string&maxResults=0&memberStatus=stringLists collaborations the caller owns, is active in, or has been invited to. - POSTCreate collaboration
/collaborationsCreates a new collaboration. - GETList collaboration change requests
/collaborations/:collaborationIdentifier/changeRequests?status=string&nextToken=string&maxResults=0Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time. - POSTCreate collaboration change request
/collaborations/:collaborationIdentifier/changeRequestsCreates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven… - GETGet collaboration
/collaborations/:collaborationIdentifierReturns metadata about a collaboration. - DELETEDelete collaboration
/collaborations/:collaborationIdentifierDeletes a collaboration. It can only be called by the collaboration owner. - PATCHUpdate collaboration
/collaborations/:collaborationIdentifierUpdates collaboration metadata and can only be called by the collaboration owner. - DELETEDelete member
/collaborations/:collaborationIdentifier/member/:accountIdRemoves the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed… - GETGet collaboration analysis template
/collaborations/:collaborationIdentifier/analysistemplates/:analysisTemplateArnRetrieves an analysis template within a collaboration. - GETGet collaboration change request
/collaborations/:collaborationIdentifier/changeRequests/:changeRequestIdentifierRetrieves detailed information about a specific collaboration change request. - PATCHUpdate collaboration change request
/collaborations/:collaborationIdentifier/changeRequests/:changeRequestIdentifierUpdates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL,… - GETGet collaboration configured audience model association
/collaborations/:collaborationIdentifier/configuredaudiencemodelassociations/:configuredAudienceModelAssociationIdentifierRetrieves a configured audience model association within a collaboration. - GETGet collaboration id namespace association
/collaborations/:collaborationIdentifier/idnamespaceassociations/:idNamespaceAssociationIdentifierRetrieves an ID namespace association from a specific collaboration. - GETGet collaboration privacy budget template
/collaborations/:collaborationIdentifier/privacybudgettemplates/:privacyBudgetTemplateIdentifierReturns details about a specified privacy budget template. - GETGet schema
/collaborations/:collaborationIdentifier/schemas/:nameRetrieves the schema for a relation within a collaboration. - GETGet schema analysis rule
/collaborations/:collaborationIdentifier/schemas/:name/analysisRule/:typeRetrieves a schema analysis rule. - GETList collaboration analysis templates
/collaborations/:collaborationIdentifier/analysistemplates?nextToken=string&maxResults=0Lists analysis templates within a collaboration. - GETList collaboration configured audience model associations
/collaborations/:collaborationIdentifier/configuredaudiencemodelassociations?nextToken=string&maxResults=0Lists configured audience model associations within a collaboration. - GETList collaboration id namespace associations
/collaborations/:collaborationIdentifier/idnamespaceassociations?nextToken=string&maxResults=0Returns a list of the ID namespace associations in a collaboration. - GETList collaboration privacy budget templates
/collaborations/:collaborationIdentifier/privacybudgettemplates?nextToken=string&maxResults=0Returns an array that summarizes each privacy budget template in a specified collaboration. - GETList collaboration privacy budgets
/collaborations/:collaborationIdentifier/privacybudgets?privacyBudgetType=string&maxResults=0&nextToken=string&accessBudgetResourceArn=stringReturns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating… - GETList members
/collaborations/:collaborationIdentifier/members?nextToken=string&maxResults=0Lists all members within a collaboration. - GETList schemas
/collaborations/:collaborationIdentifier/schemas?schemaType=string&nextToken=string&maxResults=0Lists the schemas for relations within a collaboration.
Analysis template
- GETList analysis templates
/memberships/:membershipIdentifier/analysistemplates?nextToken=string&maxResults=0Lists analysis templates that the caller owns. - POSTCreate analysis template
/memberships/:membershipIdentifier/analysistemplatesCreates a new analysis template. - GETGet analysis template
/memberships/:membershipIdentifier/analysistemplates/:analysisTemplateIdentifierRetrieves an analysis template. - DELETEDelete analysis template
/memberships/:membershipIdentifier/analysistemplates/:analysisTemplateIdentifierDeletes an analysis template. - PATCHUpdate analysis template
/memberships/:membershipIdentifier/analysistemplates/:analysisTemplateIdentifierUpdates the analysis template metadata.
Configured audience model association
- GETList configured audience model associations
/memberships/:membershipIdentifier/configuredaudiencemodelassociations?nextToken=string&maxResults=0Lists information about requested configured audience model associations. - POSTCreate configured audience model association
/memberships/:membershipIdentifier/configuredaudiencemodelassociationsProvides the details necessary to create a configured audience model association. - GETGet configured audience model association
/memberships/:membershipIdentifier/configuredaudiencemodelassociations/:configuredAudienceModelAssociationIdentifierReturns information about a configured audience model association. - DELETEDelete configured audience model association
/memberships/:membershipIdentifier/configuredaudiencemodelassociations/:configuredAudienceModelAssociationIdentifierProvides the information necessary to delete a configured audience model association. - PATCHUpdate configured audience model association
/memberships/:membershipIdentifier/configuredaudiencemodelassociations/:configuredAudienceModelAssociationIdentifierProvides the details necessary to update a configured audience model association.
Configured table
- GETList configured tables
/configuredTables?nextToken=string&maxResults=0Lists configured tables. - POSTCreate configured table
/configuredTablesCreates a new configured table resource. - POSTCreate configured table analysis rule
/configuredTables/:configuredTableIdentifier/analysisRuleCreates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table. - GETGet configured table
/configuredTables/:configuredTableIdentifierRetrieves a configured table. - DELETEDelete configured table
/configuredTables/:configuredTableIdentifierDeletes a configured table. - PATCHUpdate configured table
/configuredTables/:configuredTableIdentifierUpdates a configured table. - GETGet configured table analysis rule
/configuredTables/:configuredTableIdentifier/analysisRule/:analysisRuleTypeRetrieves a configured table analysis rule. - DELETEDelete configured table analysis rule
/configuredTables/:configuredTableIdentifier/analysisRule/:analysisRuleTypeDeletes a configured table analysis rule. - PATCHUpdate configured table analysis rule
/configuredTables/:configuredTableIdentifier/analysisRule/:analysisRuleTypeUpdates a configured table analysis rule.
Configured table association
- GETList configured table associations
/memberships/:membershipIdentifier/configuredTableAssociations?nextToken=string&maxResults=0Lists configured table associations for a membership. - POSTCreate configured table association
/memberships/:membershipIdentifier/configuredTableAssociationsCreates a configured table association. A configured table association links a configured table with a collaboration. - POSTCreate configured table association analysis rule
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifier/analysisRuleCreates a new analysis rule for an associated configured table. - GETGet configured table association
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifierRetrieves a configured table association. - DELETEDelete configured table association
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifierDeletes a configured table association. - PATCHUpdate configured table association
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifierUpdates a configured table association. - GETGet configured table association analysis rule
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifier/analysisRule/:analysisRuleTypeRetrieves the analysis rule for a configured table association. - DELETEDelete configured table association analysis rule
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifier/analysisRule/:analysisRuleTypeDeletes an analysis rule for a configured table association. - PATCHUpdate configured table association analysis rule
/memberships/:membershipIdentifier/configuredTableAssociations/:configuredTableAssociationIdentifier/analysisRule/:analysisRuleTypeUpdates the analysis rule for a configured table association.
Id mapping table
- GETList id mapping tables
/memberships/:membershipIdentifier/idmappingtables?nextToken=string&maxResults=0Returns a list of ID mapping tables. - POSTCreate id mapping table
/memberships/:membershipIdentifier/idmappingtablesCreates an ID mapping table. - GETGet id mapping table
/memberships/:membershipIdentifier/idmappingtables/:idMappingTableIdentifierRetrieves an ID mapping table. - DELETEDelete id mapping table
/memberships/:membershipIdentifier/idmappingtables/:idMappingTableIdentifierDeletes an ID mapping table. - PATCHUpdate id mapping table
/memberships/:membershipIdentifier/idmappingtables/:idMappingTableIdentifierProvides the details that are necessary to update an ID mapping table. - POSTPopulate id mapping table
/memberships/:membershipIdentifier/idmappingtables/:idMappingTableIdentifier/populateDefines the information that's necessary to populate an ID mapping table.
Id namespace association
- GETList id namespace associations
/memberships/:membershipIdentifier/idnamespaceassociations?nextToken=string&maxResults=0Returns a list of ID namespace associations. - POSTCreate id namespace association
/memberships/:membershipIdentifier/idnamespaceassociationsCreates an ID namespace association. - GETGet id namespace association
/memberships/:membershipIdentifier/idnamespaceassociations/:idNamespaceAssociationIdentifierRetrieves an ID namespace association. - DELETEDelete id namespace association
/memberships/:membershipIdentifier/idnamespaceassociations/:idNamespaceAssociationIdentifierDeletes an ID namespace association. - PATCHUpdate id namespace association
/memberships/:membershipIdentifier/idnamespaceassociations/:idNamespaceAssociationIdentifierProvides the details that are necessary to update an ID namespace association.
Intermediate table
- GETList intermediate tables
/memberships/:membershipIdentifier/intermediateTables?nextToken=string&maxResults=0Lists intermediate tables owned by the caller in a membership. We recommend using pagination to ensure that the operation returns quickly and successfully. - POSTCreate intermediate table
/memberships/:membershipIdentifier/intermediateTablesCreates an intermediate table in a membership. The intermediate table is owned by the member with the CAN_QUERY ability. To populate the table with results,… - POSTCreate intermediate table analysis rule
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/analysisRuleCreates an analysis rule for an intermediate table. Only the CUSTOM analysis rule type is supported. Only the intermediate table owner can call this operation. - GETGet intermediate table
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifierRetrieves an intermediate table. Returns the full details of the intermediate table, including schema, table dependencies, inherited constraints, child… - DELETEDelete intermediate table
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifierDeletes an intermediate table. The delete is idempotent. Only the intermediate table owner can call this operation. - PATCHUpdate intermediate table
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifierUpdates an intermediate table. You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call… - GETGet intermediate table analysis rule
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/analysisRule/:analysisRuleTypeRetrieves the analysis rule for an intermediate table. - DELETEDelete intermediate table analysis rule
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/analysisRule/:analysisRuleTypeDeletes an analysis rule from an intermediate table. After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule… - PATCHUpdate intermediate table analysis rule
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/analysisRule/:analysisRuleTypeUpdates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation. - GETList intermediate table versions
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/versions?nextToken=string&maxResults=0Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that… - POSTPopulate intermediate table
/memberships/:membershipIdentifier/intermediateTables/:intermediateTableIdentifier/populateRuns the stored query of an intermediate table and makes the results available for querying. Each call creates a new version. Use GetProtectedQuery with the…
Membership
- GETList memberships
/memberships?nextToken=string&maxResults=0&status=stringLists all memberships resources within the caller's account. - POSTCreate membership
/membershipsCreates a membership for a specific collaboration identifier and joins the collaboration. - GETGet membership
/memberships/:membershipIdentifierRetrieves a specified membership for an identifier. - DELETEDelete membership
/memberships/:membershipIdentifierDeletes a specified membership. All resources under a membership must be deleted. - PATCHUpdate membership
/memberships/:membershipIdentifierUpdates a membership. - POSTDisallow intermediate table
/memberships/:membershipIdentifier/disallowIntermediateTableMarks an intermediate table as invalid when it references the caller's base table. The data provider (base table owner) calls this operation, not the… - GETGet analysis log export
/memberships/:membershipIdentifier/analysislogexports/:analysisLogExportIdentifierReturns information about an analysis log export, including its current status and, if the export failed, the reason for the failure. Poll this operation… - GETGet protected job
/memberships/:membershipIdentifier/protectedJobs/:protectedJobIdentifierReturns job processing metadata. - PATCHUpdate protected job
/memberships/:membershipIdentifier/protectedJobs/:protectedJobIdentifierUpdates the processing of a currently running job. - GETGet protected query
/memberships/:membershipIdentifier/protectedQueries/:protectedQueryIdentifierReturns query processing metadata. - PATCHUpdate protected query
/memberships/:membershipIdentifier/protectedQueries/:protectedQueryIdentifierUpdates the processing of a currently running query. - GETList analysis log exports
/memberships/:membershipIdentifier/analysislogexports?analysisIdentifier=string&status=string&nextToken=string&maxResults=0Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results. - POSTStart analysis log export
/memberships/:membershipIdentifier/analysislogexportsStarts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own. Use the exported logs to diagnose a query that failed or… - GETList privacy budgets
/memberships/:membershipIdentifier/privacybudgets?privacyBudgetType=string&nextToken=string&maxResults=0&accessBudgetResourceArn=stringReturns detailed information about the privacy budgets in a specified membership. - GETList protected jobs
/memberships/:membershipIdentifier/protectedJobs?status=string&nextToken=string&maxResults=0Lists protected jobs, sorted by most recent job. - POSTStart protected job
/memberships/:membershipIdentifier/protectedJobsCreates a protected job that is started by Clean Rooms. - GETList protected queries
/memberships/:membershipIdentifier/protectedQueries?status=string&nextToken=string&maxResults=0Lists protected queries, sorted by the most recent query. - POSTStart protected query
/memberships/:membershipIdentifier/protectedQueriesCreates a protected query that is started by Clean Rooms. - POSTPreview privacy impact
/memberships/:membershipIdentifier/previewprivacyimpactAn estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
Privacy budget template
- GETList privacy budget templates
/memberships/:membershipIdentifier/privacybudgettemplates?nextToken=string&maxResults=0Returns detailed information about the privacy budget templates in a specified membership. - POSTCreate privacy budget template
/memberships/:membershipIdentifier/privacybudgettemplatesCreates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the… - GETGet privacy budget template
/memberships/:membershipIdentifier/privacybudgettemplates/:privacyBudgetTemplateIdentifierReturns details for a specified privacy budget template. - DELETEDelete privacy budget template
/memberships/:membershipIdentifier/privacybudgettemplates/:privacyBudgetTemplateIdentifierDeletes a privacy budget template for a specified collaboration. - PATCHUpdate privacy budget template
/memberships/:membershipIdentifier/privacybudgettemplates/:privacyBudgetTemplateIdentifierUpdates the privacy budget template for the specified collaboration.
- GETList tags for resource
/tags/:resourceArnLists all of the tags that have been added to a resource. - POSTTag resource
/tags/:resourceArnTags a resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag or list of tags from a resource.
API details
- Base URL
https://cleanrooms.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 103 operations on 58 pathsGET 47POST 25PATCH 16DELETE 15
- Main resources
- Collaboration 26Membership 19Intermediate table 11Configured table 9Configured table association 9Id mapping table 6Analysis template 5Configured audience model association 5Id namespace association 5Privacy budget template 5
- Description format
- AWS Smithy model, API version
2022-02-17 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Clean Rooms Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Clean Rooms Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch get collaboration analysis template” (POST /collaborations/:collaborationIdentifier/batch-analysistemplates), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Clean Rooms Service?
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… It is listed under Developer tools and has 103 endpoints.
Who publishes the AWS Clean Rooms Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Clean Rooms Service?
Requests go to https://cleanrooms.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Clean Rooms Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Clean Rooms Service have?
103 operations on 58 paths (47 GET, 25 POST, 16 PATCH, 15 DELETE). The largest groups are Collaboration, Membership, Intermediate table, Configured table.
Is forking the AWS Clean Rooms Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.