UpdateProtectedQuery - AWS Clean Rooms


Updates the processing of a currently running query.

Request Syntax

PATCH /memberships/membershipIdentifier/protectedQueries/protectedQueryIdentifier HTTP/1.1 Content-type: application/json { "targetStatus": "string" }

URI Request Parameters

The request uses the following URI parameters.


The identifier for a member of a protected query instance.

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


The identifier for a protected query instance.

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 target status of a query. Used to update the execution status of a currently running query.

Type: String

Valid Values: CANCELLED

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 output.

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


Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409


Unexpected error during processing of request.

HTTP Status Code: 500


Request references a resource which does not exist.

HTTP Status Code: 404


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: