Class: Aws::CleanRooms::Types::AnalysisRuleAggregation

Inherits:

Struct

• Object
• Struct
• Aws::CleanRooms::Types::AnalysisRuleAggregation

Includes:

Structure

Defined in:

lib/aws-sdk-cleanrooms/types.rb

Overview

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_analyses ⇒ String

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

• #aggregate_columns ⇒ Array<Types::AggregateColumn>

  The columns that query runners are allowed to use in aggregation queries.

• #allowed_join_operators ⇒ Array<String>

  Which logical operators (if any) are to be used in an INNER JOIN match condition.

• #dimension_columns ⇒ Array<String>

  The columns that query runners are allowed to select, group by, or filter by.

• #join_columns ⇒ Array<String>

  Columns in configured table that can be used in join statements and/or as aggregate columns.

• #join_required ⇒ String

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

• #output_constraints ⇒ Array<Types::AggregationConstraint>

  Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

• #scalar_functions ⇒ Array<String>

  Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Instance Attribute Details

#additional_analyses ⇒ String

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).

Returns:

• (String)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#aggregate_columns ⇒ Array<Types::AggregateColumn>

The columns that query runners are allowed to use in aggregation queries.

Returns:

• (Array<Types::AggregateColumn>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_join_operators ⇒ Array<String>

Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#dimension_columns ⇒ Array<String>

The columns that query runners are allowed to select, group by, or filter by.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#join_columns ⇒ Array<String>

Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#join_required ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#output_constraints ⇒ Array<Types::AggregationConstraint>

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

Returns:

• (Array<Types::AggregationConstraint>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end

#scalar_functions ⇒ Array<String>

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 622

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints,
  :additional_analyses)
  SENSITIVE = []
  include Aws::Structure
end