CreatePrivacyBudgetTemplate - AWS Clean Rooms


Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

Request Syntax

POST /memberships/membershipIdentifier/privacybudgettemplates HTTP/1.1 Content-type: application/json { "autoRefresh": "string", "parameters": { ... }, "privacyBudgetType": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.


A unique identifier for one of your memberships for a collaboration. The privacy budget template is created 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

Request Body

The request accepts the following data in JSON format.


How often the privacy budget refreshes.


If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

Type: String


Required: Yes


Specifies your parameters for the privacy budget template.

Type: PrivacyBudgetTemplateParametersInput object

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

Required: Yes


Specifies the type of the privacy budget template.

Type: String


Required: Yes


An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

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.


A summary of the elements in the privacy budget template.

Type: PrivacyBudgetTemplate 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: