Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartProtectedQuery

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

Request Syntax


POST /memberships/membershipIdentifier/protectedQueries HTTP/1.1
Content-type: application/json

{
   "computeConfiguration": { ... },
   "queryComputePayerAccountId": "string",
   "resultConfiguration": { 
      "outputConfiguration": { ... }
   },
   "sqlParameters": { 
      "analysisTemplateArn": "string",
      "parameters": { 
         "string" : "string" 
      },
      "queryString": "string"
   },
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

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.

computeConfiguration

The compute configuration for the protected query.

Type: ComputeConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

queryComputePayerAccountId

The account ID of the member that pays for the query compute costs.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: No

resultConfiguration

The details needed to write the query results.

Type: ProtectedQueryResultConfiguration object

Required: No

sqlParameters

The protected SQL query parameters.

Type: ProtectedQuerySQLParameters object

Required: Yes

type

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": { 
      "computeConfiguration": { ... },
      "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",
      "queryComputePayerAccountId": "string",
      "result": { 
         "output": { ... }
      },
      "resultConfiguration": { 
         "outputConfiguration": { ... }
      },
      "sqlParameters": { 
         "analysisTemplateArn": "string",
         "parameters": { 
            "string" : "string" 
         },
         "queryString": "string"
      },
      "statistics": { 
         "billedResourceUtilization": { 
            "units": number
         },
         "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.

protectedQuery

The protected query.

Type: ProtectedQuery object

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

reason: A reason code for the exception.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

HTTP Status Code: 404