Skip to content

CreatePrivacyBudgetTemplateInput

Source code in docs_src/capo_cleanrooms/types/create_privacy_budget_template_input.py
class CreatePrivacyBudgetTemplateInput(TypedDict, closed=True):
    membership_identifier: (
        "capo_cleanrooms.types.membership_identifier.MembershipIdentifier"
    )
    """<p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.</p>"""
    auto_refresh: NotRequired[
        "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, you can 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 queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p> </important>"""
    privacy_budget_type: "capo_cleanrooms.types.privacy_budget_type.PrivacyBudgetType"
    """<p>Specifies the type of the privacy budget template.</p>"""
    parameters: "capo_cleanrooms.types.privacy_budget_template_parameters_input.PrivacyBudgetTemplateParametersInput"
    """<p>Specifies your parameters for the privacy budget template.</p>"""
    tags: NotRequired["capo_cleanrooms.types.tag_map.TagMap"]
    """<p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>"""

auto_refresh instance-attribute

auto_refresh: NotRequired[PrivacyBudgetTemplateAutoRefresh]

How often the privacy budget refreshes.

If you plan to regularly bring new data into the collaboration, you can 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 queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

membership_identifier instance-attribute

membership_identifier: MembershipIdentifier

A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.

parameters instance-attribute

Specifies your parameters for the privacy budget template.

privacy_budget_type instance-attribute

privacy_budget_type: PrivacyBudgetType

Specifies the type of the privacy budget template.

tags instance-attribute

tags: NotRequired[TagMap]

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.