AnalysisRuleAggregation ¶

class AnalysisRuleAggregation(TypedDict, closed=True):
    aggregate_columns: "capo_cleanrooms.types.aggregate_column_list.AggregateColumnList"
    """<p>The columns that query runners are allowed to use in aggregation queries.</p>"""
    join_columns: (
        "capo_cleanrooms.types.analysis_rule_column_list.AnalysisRuleColumnList"
    )
    """<p>Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.</p>"""
    join_required: NotRequired[
        "capo_cleanrooms.types.join_required_option.JoinRequiredOption"
    ]
    """<p>Control that requires member who runs query to do a join with their configured table and/or other configured table in query.</p>"""
    allowed_join_operators: NotRequired[
        "capo_cleanrooms.types.join_operators_list.JoinOperatorsList"
    ]
    """<p>Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>"""
    dimension_columns: (
        "capo_cleanrooms.types.analysis_rule_column_list.AnalysisRuleColumnList"
    )
    """<p>The columns that query runners are allowed to select, group by, or filter by.</p>"""
    scalar_functions: "capo_cleanrooms.types.scalar_functions_list.ScalarFunctionsList"
    """<p>Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.</p>"""
    output_constraints: (
        "capo_cleanrooms.types.aggregation_constraints.AggregationConstraints"
    )
    """<p>Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.</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> <p>The <code>additionalAnalyses</code> parameter is currently supported for the list analysis rule (<code>AnalysisRuleList</code>) and the custom analysis rule (<code>AnalysisRuleCustom</code>).</p>"""