collaboration_privacy_budgets

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

Overview

Name	collaboration_privacy_budgets
Type	Resource
Id	aws.cleanrooms.collaboration_privacy_budgets

Fields

The following fields are returned by SELECT queries:

list_collaboration_privacy_budgets

Name	Datatype	Description
id	string	The unique identifier of the collaboration privacy budget. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
budget	object	The includes epsilon provided and utility in terms of aggregations.
collaboration_arn	string	The ARN of the collaboration that includes this privacy budget. (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 privacy budget. (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 was created.
creator_account_id	string	The unique identifier of the account that created this privacy budget. (pattern: <code>\d+</code>)
privacy_budget_template_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>)
privacy_budget_template_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>)
type_	string	The type of privacy budget template. (DIFFERENTIAL_PRIVACY, ACCESS_BUDGET)
update_time	string (date-time)	The most recent time at which the privacy budget was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_collaboration_privacy_budgets	select	collaboration_identifier, privacyBudgetType, region	maxResults, nextToken, accessBudgetResourceArn	Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

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.
privacyBudgetType	string	Specifies the type of the privacy budget.
region	string	AWS region (default: us-east-1)
accessBudgetResourceArn	string	The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.
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

list_collaboration_privacy_budgets

Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

SELECT
id,
budget,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
privacy_budget_template_arn,
privacy_budget_template_id,
type_,
update_time
FROM aws.cleanrooms.collaboration_privacy_budgets
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND privacyBudgetType = '{{ privacyBudgetType }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND accessBudgetResourceArn = '{{ accessBudgetResourceArn }}'
;