collaboration_privacy_budget_templates

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

Overview

Name	collaboration_privacy_budget_templates
Type	Resource
Id	aws.cleanrooms.collaboration_privacy_budget_templates

Fields

The following fields are returned by SELECT queries:

get_collaboration_privacy_budget_template

Name	Datatype	Description
id	string	The unique identifier of the collaboration 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 collaboration 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 includes this collaboration 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 identifier of the collaboration that includes this collaboration 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 collaboration privacy budget template was created.
creator_account_id	string	The unique identifier of the account that created this collaboration privacy budget template. (pattern: <code>\d+</code>)
parameters	object	Specifies the epsilon and noise parameters for the privacy budget template.
privacy_budget_type	string	The type of privacy budget template. (DIFFERENTIAL_PRIVACY, ACCESS_BUDGET)
update_time	string (date-time)	The most recent time at which the collaboration privacy budget template was updated.

list_collaboration_privacy_budget_templates

Name	Datatype	Description
id	string	The unique identifier of the collaboration 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 collaboration 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 collaboration 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 identifier of the collaboration that contains this collaboration 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 collaboration privacy budget template was created.
creator_account_id	string	The unique identifier of the account that created this collaboration privacy budget template. (pattern: <code>\d+</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 collaboration privacy budget template was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_collaboration_privacy_budget_template	select	collaboration_identifier, privacy_budget_template_identifier, region		Returns details about a specified privacy budget template.
list_collaboration_privacy_budget_templates	select	collaboration_identifier, region	nextToken, maxResults	Returns an array that summarizes each privacy budget template in 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
collaboration_identifier	string	A unique identifier for one of your collaborations.
privacy_budget_template_identifier	string	A unique identifier for one of your privacy budget templates.
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_collaboration_privacy_budget_template

Returns details about a specified privacy budget template.

SELECT
id,
arn,
auto_refresh,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
parameters,
privacy_budget_type,
update_time
FROM aws.cleanrooms.collaboration_privacy_budget_templates
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND privacy_budget_template_identifier = '{{ privacy_budget_template_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_collaboration_privacy_budget_templates

Returns an array that summarizes each privacy budget template in a specified collaboration.

SELECT
id,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
privacy_budget_type,
update_time
FROM aws.cleanrooms.collaboration_privacy_budget_templates
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;