Amazon Clean Rooms · Schema

Membership

Represents a member's participation in a Clean Rooms collaboration.

Clean RoomsData CollaborationPrivacyAnalyticsMarketing

Properties

Name Type Description
id string The unique ID of the membership.
arn string The ARN of the membership.
collaborationArn string The ARN of the collaboration.
collaborationId string The ID of the collaboration.
collaborationCreatorAccountId string The account ID of the collaboration creator.
collaborationName string The name of the collaboration.
status string The status of the membership.
View JSON Schema on GitHub

JSON Schema

clean-rooms-membership-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-membership-schema.json",
  "title": "Membership",
  "description": "Represents a member's participation in a Clean Rooms collaboration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique ID of the membership.",
      "example": "member-abc12345"
    },
    "arn": {
      "type": "string",
      "description": "The ARN of the membership."
    },
    "collaborationArn": {
      "type": "string",
      "description": "The ARN of the collaboration."
    },
    "collaborationId": {
      "type": "string",
      "description": "The ID of the collaboration."
    },
    "collaborationCreatorAccountId": {
      "type": "string",
      "description": "The account ID of the collaboration creator."
    },
    "collaborationName": {
      "type": "string",
      "description": "The name of the collaboration."
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "COLLABORATION_DELETED",
        "REMOVED"
      ],
      "description": "The status of the membership."
    }
  }
}