Clean Rooms Create Collaboration Request Structure

Request body for creating a collaboration.

Type: object Properties: 6 Required: 5

Clean RoomsData CollaborationPrivacyAnalyticsMarketing

CreateCollaborationRequest is a JSON Structure definition published by Amazon Clean Rooms, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description members creatorDisplayName creatorMemberAbilities queryLogStatus

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-clean-rooms/refs/heads/main/json-structure/clean-rooms-create-collaboration-request-structure.json",
  "name": "CreateCollaborationRequest",
  "description": "Request body for creating a collaboration.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The display name for a collaboration.",
      "example": "Marketing Analytics Collaboration"
    },
    "description": {
      "type": "string",
      "description": "A description of the collaboration."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "A list of initial members for the collaboration."
    },
    "creatorDisplayName": {
      "type": "string",
      "description": "The display name of the collaboration creator."
    },
    "creatorMemberAbilities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The abilities granted to the collaboration creator."
    },
    "queryLogStatus": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "description": "An indicator as to whether query logging has been enabled or disabled."
    }
  },
  "required": [
    "name",
    "members",
    "creatorDisplayName",
    "creatorMemberAbilities",
    "queryLogStatus"
  ]
}