privacy_budget_templates

Creates, updates, deletes, gets or lists a privacy_budget_templates resource.

Overview

Name	privacy_budget_templates
Type	Resource
Id	aws.cleanrooms.privacy_budget_templates

Fields

The following fields are returned by SELECT queries:

get_privacy_budget_template

Name	Datatype	Description
id	string	The unique identifier of the privacy budget template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
arn	string	The ARN of the privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+</code>)
auto_refresh	string	How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, 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 queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes. (CALENDAR_MONTH, NONE)
collaboration_arn	string	The ARN of the collaboration that contains this privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	The unique ID of the collaboration that contains this privacy budget template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time at which the privacy budget template was created.
membership_arn	string	The Amazon Resource Name (ARN) of the member who created the privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The identifier for a membership resource. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
parameters	object	Specifies the epsilon and noise parameters for the privacy budget template.
privacy_budget_type	string	Specifies the type of the privacy budget template. (DIFFERENTIAL_PRIVACY, ACCESS_BUDGET)
update_time	string (date-time)	The most recent time at which the privacy budget template was updated.

list_privacy_budget_templates

Name	Datatype	Description
id	string	The unique identifier of the privacy budget template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
arn	string	The ARN of the privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+</code>)
collaboration_arn	string	The ARN of the collaboration that contains this privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	The unique ID of the collaboration that contains this privacy budget template. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time at which the privacy budget template was created.
membership_arn	string	The Amazon Resource Name (ARN) of the member who created the privacy budget template. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The identifier for a membership resource. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
privacy_budget_type	string	The type of the privacy budget template. (DIFFERENTIAL_PRIVACY, ACCESS_BUDGET)
update_time	string (date-time)	The most recent time at which the privacy budget template was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_privacy_budget_template	select	membership_identifier, privacy_budget_template_identifier, region		Returns details for a specified privacy budget template.
list_privacy_budget_templates	select	membership_identifier, region	nextToken, maxResults	Returns detailed information about the privacy budget templates in a specified membership.
create_privacy_budget_template	insert	membership_identifier, region, privacyBudgetType, parameters		Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.
update_privacy_budget_template	update	membership_identifier, privacy_budget_template_identifier, region, privacyBudgetType		Updates the privacy budget template for the specified collaboration.
delete_privacy_budget_template	delete	membership_identifier, privacy_budget_template_identifier, region		Deletes a privacy budget template for a specified collaboration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
membership_identifier	string	A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
privacy_budget_template_identifier	string	A unique identifier for your privacy budget template.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

get_privacy_budget_template

Returns details for a specified privacy budget template.

SELECT
id,
arn,
auto_refresh,
collaboration_arn,
collaboration_id,
create_time,
membership_arn,
membership_id,
parameters,
privacy_budget_type,
update_time
FROM aws.cleanrooms.privacy_budget_templates
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND privacy_budget_template_identifier = '{{ privacy_budget_template_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_privacy_budget_templates

Returns detailed information about the privacy budget templates in a specified membership.

SELECT
id,
arn,
collaboration_arn,
collaboration_id,
create_time,
membership_arn,
membership_id,
privacy_budget_type,
update_time
FROM aws.cleanrooms.privacy_budget_templates
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_privacy_budget_template

Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.

INSERT INTO aws.cleanrooms.privacy_budget_templates (
autoRefresh,
privacyBudgetType,
parameters,
tags,
membership_identifier,
region
)
SELECT 
'{{ autoRefresh }}',
'{{ privacyBudgetType }}' /* required */,
'{{ parameters }}' /* required */,
'{{ tags }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
privacy_budget_template
;

Manifest

# Description fields are for documentation purposes
- name: privacy_budget_templates
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the privacy_budget_templates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the privacy_budget_templates resource.
  - name: autoRefresh
    value: "{{ autoRefresh }}"
    valid_values: ['CALENDAR_MONTH', 'NONE']
  - name: privacyBudgetType
    value: "{{ privacyBudgetType }}"
    valid_values: ['DIFFERENTIAL_PRIVACY', 'ACCESS_BUDGET']
  - name: parameters
    description: |
      The epsilon and noise parameters that you want to use for the privacy budget template.
    value:
      differentialPrivacy:
        epsilon: {{ epsilon }}
        usersNoisePerQuery: {{ usersNoisePerQuery }}
      accessBudget:
        budgetParameters:
          - type_: "{{ type_ }}"
            budget: {{ budget }}
            autoRefresh: "{{ autoRefresh }}"
        resourceArn: "{{ resourceArn }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource

UPDATE examples

update_privacy_budget_template

Updates the privacy budget template for the specified collaboration.

UPDATE aws.cleanrooms.privacy_budget_templates
SET 
privacyBudgetType = '{{ privacyBudgetType }}',
parameters = '{{ parameters }}'
WHERE 
membership_identifier = '{{ membership_identifier }}' --required
AND privacy_budget_template_identifier = '{{ privacy_budget_template_identifier }}' --required
AND region = '{{ region }}' --required
AND privacyBudgetType = '{{ privacyBudgetType }}' --required
RETURNING
privacy_budget_template;

DELETE examples

delete_privacy_budget_template

Deletes a privacy budget template for a specified collaboration.

DELETE FROM aws.cleanrooms.privacy_budget_templates
WHERE membership_identifier = '{{ membership_identifier }}' --required
AND privacy_budget_template_identifier = '{{ privacy_budget_template_identifier }}' --required
AND region = '{{ region }}' --required
;