privacy_budgets

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

Overview

Name	privacy_budgets
Type	Resource
Id	aws.cleanrooms.privacy_budgets

Fields

The following fields are returned by SELECT queries:

list_privacy_budgets

Name	Datatype	Description
id	string	The unique identifier of the 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 provided privacy budget.
collaboration_arn	string	The ARN of the collaboration that contains 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 contains 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.
membership_arn	string	The Amazon Resource Name (ARN) of the member who created the privacy budget summary. (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_template_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>)
privacy_budget_template_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>)
type_	string	Specifies the type of the privacy budget. (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_privacy_budgets	select	membership_identifier, privacyBudgetType, region	nextToken, maxResults, accessBudgetResourceArn	Returns detailed information about the privacy budgets in a specified membership.

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 is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
privacyBudgetType	string	The privacy budget type.
region	string	AWS region (default: us-east-1)
accessBudgetResourceArn	string	The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.
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_privacy_budgets

Returns detailed information about the privacy budgets in a specified membership.

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