# AWS Clean Rooms Service API

> AWS Clean Rooms Service API on Apizie: 45 endpoints (Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs)., Retrieves multiple schemas by their identifiers., Lists analysis templates that the caller owns., Creates a new analysis template., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-cleanrooms`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://www.apizie.tech/api/cloud/amazonaws-cleanrooms
- OpenAPI: https://www.apizie.tech/api/cloud/amazonaws-cleanrooms/openapi.json

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…

## Endpoints

### Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/batch-get-collaboration-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. |
| body | object | yes | JSON request body |

### Retrieves multiple schemas by their identifiers.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/batch-get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID. |
| body | object | yes | JSON request body |

### Lists analysis templates that the caller owns.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-analysis-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Creates a new analysis template.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |
| body | object | yes | JSON request body |

### Lists collaborations the caller owns, is active in, or has been invited to.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-collaborations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a… |
| memberStatus | string | no | The caller's status in a collaboration. |

### Creates a new collaboration.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-collaboration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Lists configured tables.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-configured-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Creates a new configured table resource.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-configured-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a…
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-configured-table-analysis-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID. |
| body | object | yes | JSON request body |

### Lists configured table associations for a membership.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-configured-table-associations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Creates a configured table association. A configured table association links a configured table with a…
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-configured-table-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this… |
| body | object | yes | JSON request body |

### Lists all memberships resources within the caller's account.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-memberships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |
| status | string | no | A filter which will return only memberships in the specified status. |

### Creates a membership for a specific collaboration identifier and joins the collaboration.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/create-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves an analysis template.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |
| analysisTemplateIdentifier | string | yes | The identifier for the analysis template resource. |

### Updates the analysis template metadata.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |
| analysisTemplateIdentifier | string | yes | The identifier for the analysis template resource. |
| body | object | yes | JSON request body |

### Deletes an analysis template.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |
| analysisTemplateIdentifier | string | yes | The identifier for the analysis template resource. |

### Returns metadata about a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-collaboration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | The identifier for the collaboration. |

### Updates collaboration metadata and can only be called by the collaboration owner.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-collaboration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | The identifier for the collaboration. |
| body | object | yes | JSON request body |

### Deletes a collaboration. It can only be called by the collaboration owner.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-collaboration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | The identifier for the collaboration. |

### Retrieves a configured table.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-configured-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The unique ID for the configured table to retrieve. |

### Updates a configured table.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-configured-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The identifier for the configured table to update. Currently accepts the configured table ID. |
| body | object | yes | JSON request body |

### Deletes a configured table.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-configured-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The unique ID for the configured table to delete. |

### Retrieves a configured table analysis rule.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-configured-table-analysis-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The unique identifier for the configured table to retrieve. Currently accepts the configured table ID. |
| analysisRuleType | string | yes | The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and… |

### Updates a configured table analysis rule.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-configured-table-analysis-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID. |
| analysisRuleType | string | yes | The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and… |
| body | object | yes | JSON request body |

### Deletes a configured table analysis rule.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-configured-table-analysis-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableIdentifier | string | yes | The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID. |
| analysisRuleType | string | yes | The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and… |

### Retrieves a configured table association.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-configured-table-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableAssociationIdentifier | string | yes | The unique ID for the configured table association to retrieve. Currently accepts the configured table ID. |
| membershipIdentifier | string | yes | A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. |

### Updates a configured table association.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-configured-table-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableAssociationIdentifier | string | yes | The unique identifier for the configured table association to update. Currently accepts the configured table association ID. |
| membershipIdentifier | string | yes | The unique ID for the membership that the configured table association belongs to. |
| body | object | yes | JSON request body |

### Deletes a configured table association.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-configured-table-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| configuredTableAssociationIdentifier | string | yes | The unique ID for the configured table association to be deleted. Currently accepts the configured table ID. |
| membershipIdentifier | string | yes | A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. |

### Removes the specified member from a collaboration. The removed member is placed in the Removed status and…
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | The unique identifier for the associated collaboration. |
| accountId | string | yes | The account ID of the member to remove. |

### Retrieves a specified membership for an identifier.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |

### Updates a membership.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The unique identifier of the membership. |
| body | object | yes | JSON request body |

### Deletes a specified membership. All resources under a membership must be deleted.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/delete-membership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership resource. |

### Retrieves an analysis template within a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-collaboration-analysis-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. |
| analysisTemplateArn | string | yes | The Amazon Resource Name (ARN) associated with the analysis template within a collaboration. |

### Returns query processing metadata.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-protected-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a membership in a protected query instance. |
| protectedQueryIdentifier | string | yes | The identifier for a protected query instance. |

### Updates the processing of a currently running query.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/update-protected-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for a member of a protected query instance. |
| protectedQueryIdentifier | string | yes | The identifier for a protected query instance. |
| body | object | yes | JSON request body |

### Retrieves the schema for a relation within a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. |
| name | string | yes | The name of the relation to retrieve the schema for. |

### Retrieves a schema analysis rule.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/get-schema-analysis-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. |
| name | string | yes | The name of the schema to retrieve the analysis rule for. |
| type | string | yes | The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the… |

### Lists analysis templates within a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-collaboration-analysis-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Lists all members within a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | The identifier of the collaboration in which the members are listed. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Lists protected queries, sorted by the most recent query.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-protected-queries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | The identifier for the membership in the collaboration. |
| status | string | no | A filter on the status of the protected query. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a… |

### Creates a protected query that is started by Clean Rooms .
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/start-protected-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| membershipIdentifier | string | yes | A unique identifier for the membership to run this query against. Currently accepts a membership ID. |
| body | object | yes | JSON request body |

### Lists the schemas for relations within a collaboration.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| collaborationIdentifier | string | yes | A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. |
| schemaType | string | no | If present, filter schemas by schema type. The only valid schema type is currently `TABLE`. |
| nextToken | string | no | The token value retrieved from a previous call to access the next page of results. |
| maxResults | integer | no | The maximum size of the results that is returned per call. |

### Lists all of the tags that have been added to a resource.
`GET https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) associated with the resource you want to list tags on. |

### Tags a resource.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) associated with the resource you want to tag. |
| body | object | yes | JSON request body |

### Removes a tag or list of tags from a resource.
`POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from. |
| tagKeys | array | yes | A list of key names of tags to be removed. |

## Example
```
curl "https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/batch-get-collaboration-analysis-template" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS Clean Rooms Service API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:amazonaws-cleanrooms/batch-get-collaboration-analysis-template with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS Clean Rooms Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS Clean Rooms Service itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS Clean Rooms Service API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-cleanrooms.

### What is the status of the AWS Clean Rooms Service API?
Needs your own provider key (bring your own key)