Amazon Clean Rooms · Schema

Collaboration

Represents an AWS Clean Rooms collaboration workspace.

Clean RoomsData CollaborationPrivacyAnalyticsMarketing

Properties

Name Type Description
id string The unique ID of the collaboration.
arn string The ARN of the collaboration.
name string A human-readable identifier for the collaboration.
description string A description of the collaboration.
creatorAccountId string The account ID of the creator.
creatorDisplayName string The display name of the collaboration creator.
createTime string The time when the collaboration was created.
updateTime string The time when the collaboration was last updated.
queryLogStatus string Whether query logs are enabled.
View JSON Schema on GitHub

JSON Schema

clean-rooms-collaboration-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-clean-rooms/refs/heads/main/json-schema/clean-rooms-collaboration-schema.json",
  "title": "Collaboration",
  "description": "Represents an AWS Clean Rooms collaboration workspace.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique ID of the collaboration.",
      "example": "collab-abc12345"
    },
    "arn": {
      "type": "string",
      "description": "The ARN of the collaboration.",
      "example": "arn:aws:cleanrooms:us-east-1:123456789012:collaboration/collab-abc12345"
    },
    "name": {
      "type": "string",
      "description": "A human-readable identifier for the collaboration.",
      "example": "Marketing Analytics Collaboration"
    },
    "description": {
      "type": "string",
      "description": "A description of the collaboration.",
      "example": "Collaborative analytics for marketing measurement"
    },
    "creatorAccountId": {
      "type": "string",
      "description": "The account ID of the creator.",
      "example": "123456789012"
    },
    "creatorDisplayName": {
      "type": "string",
      "description": "The display name of the collaboration creator.",
      "example": "Acme Corp"
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the collaboration was created."
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the collaboration was last updated."
    },
    "queryLogStatus": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "description": "Whether query logs are enabled."
    }
  }
}