Skip to content
AWS for Query.Farm

aws.cleanrooms.get_privacy_budget_template

Example SQL Queries

SELECT * FROM
aws.cleanrooms.get_privacy_budget_template
WHERE
"membership_identifier" = 'VALUE'
AND "privacy_budget_template_identifier" = 'VALUE';

Description

Returns details for a specified privacy budget template.

Table Definition

Column NameColumn Data Type
membership_identifier Required Input Column

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

VARCHAR
privacy_budget_template_identifier Required Input Column

A unique identifier for your privacy budget template.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
privacy_budget_template

Returns the details of the privacy budget template that you requested.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "membership_id" VARCHAR,
    "membership_arn" VARCHAR,
    "collaboration_id" VARCHAR,
    "collaboration_arn" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "privacy_budget_type" VARCHAR,
    "auto_refresh" VARCHAR,
    "parameters" STRUCT(
        "differential_privacy" STRUCT(
            "epsilon" BIGINT,
            "users_noise_per_query" BIGINT
        )
    )
)
Show child fields
privacy_budget_template.arn

The ARN of the privacy budget template.

privacy_budget_template.auto_refresh

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.

privacy_budget_template.collaboration_arn

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

privacy_budget_template.collaboration_id

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

privacy_budget_template.create_time

The time at which the privacy budget template was created.

privacy_budget_template.id

The unique identifier of the privacy budget template.

privacy_budget_template.membership_arn

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

privacy_budget_template.membership_id

The identifier for a membership resource.

privacy_budget_template.parameters

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

Show child fields
privacy_budget_template.parameters.differential_privacy

The epsilon and noise parameters.

Show child fields
privacy_budget_template.parameters.differential_privacy.epsilon

The epsilon value that you specified.

privacy_budget_template.parameters.differential_privacy.users_noise_per_query

Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.

privacy_budget_template.privacy_budget_type

Specifies the type of the privacy budget template.

privacy_budget_template.update_time

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