Amazon Clean Rooms · JSON Structure

Clean Rooms Start Protected Query Request Structure

Request body for starting a protected query.

Type: object Properties: 3 Required: 2
Clean RoomsData CollaborationPrivacyAnalyticsMarketing

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

Properties

type sqlParameters resultConfiguration

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

JSON Structure

Raw ↑ 
{
  "$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-start-protected-query-request-structure.json",
  "name": "StartProtectedQueryRequest",
  "description": "Request body for starting a protected query.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "SQL"
      ],
      "description": "The type of the protected query."
    },
    "sqlParameters": {
      "type": "object",
      "description": "The parameters for the SQL type protected query.",
      "properties": {
        "queryString": {
          "type": "string",
          "description": "The query string to be submitted."
        }
      }
    },
    "resultConfiguration": {
      "type": "object",
      "description": "Contains configuration details for protected query results."
    }
  },
  "required": [
    "type",
    "resultConfiguration"
  ]
}