Skip to content
AWS for Query.Farm

aws.cleanrooms.get_schema_analysis_rule

Example SQL Queries

SELECT * FROM
aws.cleanrooms.get_schema_analysis_rule
WHERE
"collaboration_identifier" = 'VALUE'
AND "name" = 'VALUE'
AND "type" = 'VALUE';

Description

Retrieves a schema analysis rule.

Table Definition

Column NameColumn Data Type
collaboration_identifier Required Input Column

A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

VARCHAR
name Required Input Column

The name of the schema to retrieve the analysis rule for.

VARCHAR
type Required Input Column

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

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
analysis_rule

A specification about how data from the configured table can be used.

STRUCT(
    "collaboration_id" VARCHAR,
    "type" VARCHAR,
    "name" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "policy" STRUCT(
        "v1" STRUCT(
            "list" STRUCT(
                "join_columns" VARCHAR[],
                "allowed_join_operators" VARCHAR[],
                "list_columns" VARCHAR[],
                "additional_analyses" VARCHAR
            ),
            "aggregation" STRUCT(
                "aggregate_columns" STRUCT(
                    "column_names" VARCHAR[],
                    "function" VARCHAR
                )[],
                "join_columns" VARCHAR[],
                "join_required" VARCHAR,
                "allowed_join_operators" VARCHAR[],
                "dimension_columns" VARCHAR[],
                "scalar_functions" VARCHAR[],
                "output_constraints" STRUCT(
                    "column_name" VARCHAR,
                    "minimum" BIGINT,
                    "type" VARCHAR
                )[],
                "additional_analyses" VARCHAR
            ),
            "custom" STRUCT(
                "allowed_analyses" VARCHAR[],
                "allowed_analysis_providers" VARCHAR[],
                "additional_analyses" VARCHAR,
                "disallowed_output_columns" VARCHAR[],
                "differential_privacy" STRUCT(
                    "columns" STRUCT(
                        "name" VARCHAR
                    )[]
                )
            ),
            "id_mapping_table" STRUCT(
                "join_columns" VARCHAR[],
                "query_constraints" STRUCT(
                    "require_overlap" STRUCT(
                        "columns" VARCHAR[]
                    )
                )[],
                "dimension_columns" VARCHAR[]
            )
        )
    )
)
Show child fields
analysis_rule.collaboration_id

The unique ID for the associated collaboration.

analysis_rule.create_time

The time the analysis rule was created.

analysis_rule.name

The name for the analysis rule.

analysis_rule.policy

A policy that describes the associated data usage limitations.

Show child fields
analysis_rule.policy.v1

Controls on the query specifications that can be run on configured table.

Show child fields
analysis_rule.policy.v1.aggregation

Analysis rule type that enables only aggregation queries on a configured table.

Show child fields
analysis_rule.policy.v1.aggregation.additional_analyses

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

analysis_rule.policy.v1.aggregation.aggregate_columns[]
Show child fields
analysis_rule.policy.v1.aggregation.aggregate_columns[].column_names[]
analysis_rule.policy.v1.aggregation.aggregate_columns[].function

Aggregation function that can be applied to aggregate column in query.

analysis_rule.policy.v1.aggregation.allowed_join_operators[]
analysis_rule.policy.v1.aggregation.dimension_columns[]
analysis_rule.policy.v1.aggregation.join_columns[]
analysis_rule.policy.v1.aggregation.join_required

Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

analysis_rule.policy.v1.aggregation.output_constraints[]
Show child fields
analysis_rule.policy.v1.aggregation.output_constraints[].column_name

Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

analysis_rule.policy.v1.aggregation.output_constraints[].minimum

The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

analysis_rule.policy.v1.aggregation.output_constraints[].type

The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.

analysis_rule.policy.v1.aggregation.scalar_functions[]
analysis_rule.policy.v1.custom

Analysis rule type that enables custom SQL queries on a configured table.

Show child fields
analysis_rule.policy.v1.custom.additional_analyses

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

analysis_rule.policy.v1.custom.allowed_analyses[]
analysis_rule.policy.v1.custom.allowed_analysis_providers[]
analysis_rule.policy.v1.custom.differential_privacy

The differential privacy configuration.

Show child fields
analysis_rule.policy.v1.custom.differential_privacy.columns[]
Show child fields
analysis_rule.policy.v1.custom.differential_privacy.columns[].name

The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.

analysis_rule.policy.v1.custom.disallowed_output_columns[]
analysis_rule.policy.v1.id_mapping_table

The ID mapping table.

Show child fields
analysis_rule.policy.v1.id_mapping_table.dimension_columns[]
analysis_rule.policy.v1.id_mapping_table.join_columns[]
analysis_rule.policy.v1.id_mapping_table.query_constraints[]
Show child fields
analysis_rule.policy.v1.id_mapping_table.query_constraints[].require_overlap

An array of column names that specifies which columns are required in the JOIN statement.

Show child fields
analysis_rule.policy.v1.id_mapping_table.query_constraints[].require_overlap.columns[]
analysis_rule.policy.v1.list

Analysis rule type that enables only list queries on a configured table.

Show child fields
analysis_rule.policy.v1.list.additional_analyses

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

analysis_rule.policy.v1.list.allowed_join_operators[]
analysis_rule.policy.v1.list.join_columns[]
analysis_rule.policy.v1.list.list_columns[]
analysis_rule.type

The type of analysis rule.

analysis_rule.update_time

The time the analysis rule was last updated.