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

UpdatePrivacyBudgetTemplate

Updates the privacy budget template for the specified membership.

Request Syntax


PATCH /memberships/membershipIdentifier/privacybudgettemplates/privacyBudgetTemplateIdentifier HTTP/1.1
Content-type: application/json

{
   "parameters": { ... },
   "privacyBudgetType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. 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

privacyBudgetTemplateIdentifier

A unique identifier for your privacy budget template that you want to update.

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 epsilon and noise parameters for the privacy budget template.

Type: PrivacyBudgetTemplateUpdateParameters object

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

Required: No

privacyBudgetType

Specifies the type of the privacy budget template.

Type: String

Valid Values: DIFFERENTIAL_PRIVACY

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "privacyBudgetTemplate": { 
      "arn": "string",
      "autoRefresh": "string",
      "collaborationArn": "string",
      "collaborationId": "string",
      "createTime": number,
      "id": "string",
      "membershipArn": "string",
      "membershipId": "string",
      "parameters": { ... },
      "privacyBudgetType": "string",
      "updateTime": number
   }
}

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.

privacyBudgetTemplate

Summary of the privacy budget template.

Type: PrivacyBudgetTemplate object

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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