Amazon Clean Rooms · Schema

StartProtectedQueryRequest

Request body for starting a protected query.

Clean RoomsData CollaborationPrivacyAnalyticsMarketing

Properties

Name Type Description
type string The type of the protected query.
sqlParameters object The parameters for the SQL type protected query.
resultConfiguration object Contains configuration details for protected query results.
View JSON Schema on GitHub

JSON Schema

clean-rooms-start-protected-query-request-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-start-protected-query-request-schema.json",
  "title": "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"
  ]
}