StartProtectedQuery - AWS Clean Rooms


Creates a protected query that is started by AWS Clean Rooms.

Request Syntax

POST /memberships/membershipIdentifier/protectedQueries HTTP/1.1 Content-type: application/json { "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "type": "string" }

URI Request Parameters

The request uses the following URI parameters.


A unique identifier for the membership to run this query against. Currently accepts a membership ID.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.


The details needed to write the query results.

Type: ProtectedQueryResultConfiguration object

Required: No


The protected SQL query parameters.

Type: ProtectedQuerySQLParameters object

Required: Yes


The type of the protected query to be started.

Type: String

Valid Values: SQL

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "protectedQuery": { "createTime": number, "differentialPrivacy": { "sensitivityParameters": [ { "aggregationExpression": "string", "aggregationType": "string", "maxColumnValue": number, "minColumnValue": number, "userContributionLimit": number } ] }, "error": { "code": "string", "message": "string" }, "id": "string", "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "statistics": { "totalDurationInMillis": number }, "status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The protected query.

Type: ProtectedQuery object


For information about the errors that are common to all actions, see Common Errors.


Caller does not have sufficient access to perform this action.

HTTP Status Code: 403


Unexpected error during processing of request.

HTTP Status Code: 500


Request references a resource which does not exist.

HTTP Status Code: 404


Request denied because service quota has been exceeded.

HTTP Status Code: 402


Request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: