Skip to content

AnalysisRuleCustom

Source code in docs_src/capo_cleanrooms/types/analysis_rule_custom.py
class AnalysisRuleCustom(TypedDict, closed=True):
    allowed_analyses: "capo_cleanrooms.types.allowed_analyses_list.AllowedAnalysesList"
    """<p>The ARN of the analysis templates that are allowed by the custom analysis rule.</p>"""
    allowed_analysis_providers: NotRequired[
        "capo_cleanrooms.types.allowed_analysis_provider_list.AllowedAnalysisProviderList"
    ]
    """<p>The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>"""
    additional_analyses: NotRequired[
        "capo_cleanrooms.types.additional_analyses.AdditionalAnalyses"
    ]
    """<p> An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.</p>"""
    disallowed_output_columns: NotRequired[
        "capo_cleanrooms.types.analysis_rule_column_list.AnalysisRuleColumnList"
    ]
    """<p> A list of columns that aren't allowed to be shown in the query output.</p>"""
    differential_privacy: NotRequired[
        "capo_cleanrooms.types.differential_privacy_configuration.DifferentialPrivacyConfiguration"
    ]
    """<p>The differential privacy configuration.</p>"""
    aggregation_thresholds: NotRequired[
        "capo_cleanrooms.types.aggregation_threshold_list.AggregationThresholdList"
    ]
    """<p>The aggregation thresholds that each query output group must satisfy. Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when <code>allowedAnalyses</code> allows only jobs.</p>"""
    comparison_controls: NotRequired[
        "capo_cleanrooms.types.comparison_controls.ComparisonControls"
    ]
    """<p>The controls that restrict how a query can compare the columns in the configured table. You can't use comparison controls with differential privacy, or when <code>allowedAnalyses</code> allows only jobs.</p>"""
    allowed_result_receivers: NotRequired[
        "capo_cleanrooms.types.allowed_result_receivers.AllowedResultReceivers"
    ]
    """<p>The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the configured table.</p>"""
    allowed_additional_analyses: NotRequired[
        "capo_cleanrooms.types.allowed_additional_analyses.AllowedAdditionalAnalyses"
    ]
    """<p>The list of allowed additional analyses for the custom analysis rule.</p>"""

additional_analyses instance-attribute

additional_analyses: NotRequired[AdditionalAnalyses]

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

aggregation_thresholds instance-attribute

aggregation_thresholds: NotRequired[AggregationThresholdList]

The aggregation thresholds that each query output group must satisfy. Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when allowedAnalyses allows only jobs.

allowed_additional_analyses instance-attribute

allowed_additional_analyses: NotRequired[AllowedAdditionalAnalyses]

The list of allowed additional analyses for the custom analysis rule.

allowed_analyses instance-attribute

allowed_analyses: AllowedAnalysesList

The ARN of the analysis templates that are allowed by the custom analysis rule.

allowed_analysis_providers instance-attribute

allowed_analysis_providers: NotRequired[AllowedAnalysisProviderList]

The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

allowed_result_receivers instance-attribute

allowed_result_receivers: NotRequired[AllowedResultReceivers]

The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the configured table.

comparison_controls instance-attribute

comparison_controls: NotRequired[ComparisonControls]

The controls that restrict how a query can compare the columns in the configured table. You can't use comparison controls with differential privacy, or when allowedAnalyses allows only jobs.

differential_privacy instance-attribute

differential_privacy: NotRequired[DifferentialPrivacyConfiguration]

The differential privacy configuration.

disallowed_output_columns instance-attribute

disallowed_output_columns: NotRequired[AnalysisRuleColumnList]

A list of columns that aren't allowed to be shown in the query output.