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

PreviewPrivacyImpact

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

Request Syntax


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

{
   "parameters": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

A unique identifier for one of your memberships for a collaboration. 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.

parameters

Specifies the desired epsilon and noise parameters to preview.

Type: PreviewPrivacyImpactParametersInput object

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "privacyImpact": { ... }
}

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.

privacyImpact

An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.

Type: PrivacyImpact object

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

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400