Skip to content

PrivacyBudgetTemplate

Source code in docs_src/capo_cleanrooms/types/privacy_budget_template.py
class PrivacyBudgetTemplate(TypedDict, closed=True):
    id: "capo_cleanrooms.types.privacy_budget_template_identifier.PrivacyBudgetTemplateIdentifier"
    """<p>The unique identifier of the privacy budget template.</p>"""
    arn: "capo_cleanrooms.types.privacy_budget_template_arn.PrivacyBudgetTemplateArn"
    """<p>The ARN of the privacy budget template.</p>"""
    membership_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The identifier for a membership resource.</p>"""
    membership_arn: "capo_cleanrooms.types.membership_arn.MembershipArn"
    """<p>The Amazon Resource Name (ARN) of the member who created the privacy budget template.</p>"""
    collaboration_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID of the collaboration that contains this privacy budget template.</p>"""
    collaboration_arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The ARN of the collaboration that contains this privacy budget template.</p>"""
    create_time: "datetime.datetime"
    """<p>The time at which the privacy budget template was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the privacy budget template was updated.</p>"""
    privacy_budget_type: "capo_cleanrooms.types.privacy_budget_type.PrivacyBudgetType"
    """<p>Specifies the type of the privacy budget template.</p>"""
    auto_refresh: "capo_cleanrooms.types.privacy_budget_template_auto_refresh.PrivacyBudgetTemplateAutoRefresh"
    """<p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> 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.</p> </important>"""
    parameters: "capo_cleanrooms.types.privacy_budget_template_parameters_output.PrivacyBudgetTemplateParametersOutput"
    """<p>Specifies the epsilon and noise parameters for the privacy budget template.</p>"""

arn instance-attribute

The ARN of the privacy budget template.

auto_refresh instance-attribute

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.

collaboration_arn instance-attribute

collaboration_arn: CollaborationArn

The ARN of the collaboration that contains this privacy budget template.

collaboration_id instance-attribute

collaboration_id: UUID

The unique ID of the collaboration that contains this privacy budget template.

create_time instance-attribute

create_time: datetime

The time at which the privacy budget template was created.

id instance-attribute

The unique identifier of the privacy budget template.

membership_arn instance-attribute

membership_arn: MembershipArn

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

membership_id instance-attribute

membership_id: UUID

The identifier for a membership resource.

parameters instance-attribute

Specifies the epsilon and noise parameters for the privacy budget template.

privacy_budget_type instance-attribute

privacy_budget_type: PrivacyBudgetType

Specifies the type of the privacy budget template.

update_time instance-attribute

update_time: datetime

The most recent time at which the privacy budget template was updated.