Class: Aws::CleanRooms::Types::AggregationThreshold

Inherits:

Struct

• Object
• Struct
• Aws::CleanRooms::Types::AggregationThreshold

Includes:

Structure

Defined in:

lib/aws-sdk-cleanrooms/types.rb

Overview

Specifies the minimum number of distinct identities that each query output group must represent.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_aggregate_expression_type ⇒ String

  Specifies whether a query can aggregate a transformed column.

• #identity_columns ⇒ Array<String>

  The identity column, such as user_id, whose distinct values Clean Rooms counts to enforce minimum aggregation thresholds.

• #minimum_identity_count ⇒ Integer

  The minimum number of distinct identities that each query output group must represent.

• #output_column_thresholds ⇒ Array<Types::OutputColumnThreshold>

  The per-column overrides of minimumIdentityCount.

• #type ⇒ String

  The type of aggregation that the threshold enforces.

Instance Attribute Details

#allowed_aggregate_expression_type ⇒ String

Specifies whether a query can aggregate a transformed column. This applies to the arguments of both aggregate and window functions. Valid values are:

COLUMNS_ONLY – A query can aggregate only a direct column reference, such as SUM(amount), or a constant. Clean Rooms rejects a query that transforms a column and then aggregates it, such as SUM(amount * 2) or SUM(ROUND(amount)).

ANY_EXPRESSION – A query can aggregate any expression. This includes arithmetic, such as SUM(price * quantity); a cast, such as SUM(CAST(amount AS DECIMAL)); a nested function call, such as SUM(COALESCE(amount, 0)); and a conditional, such as SUM(CASE WHEN region = 'EU' THEN amount ELSE 0 END).

Returns:

• (String)

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

class AggregationThreshold < Struct.new(
  :identity_columns,
  :minimum_identity_count,
  :type,
  :output_column_thresholds,
  :allowed_aggregate_expression_type)
  SENSITIVE = []
  include Aws::Structure
end

#identity_columns ⇒ Array<String>

The identity column, such as user_id, whose distinct values Clean Rooms counts to enforce minimum aggregation thresholds. Currently, you can specify only one column, and its data type must be string, varchar, or char.

Returns:

• (Array<String>)

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

class AggregationThreshold < Struct.new(
  :identity_columns,
  :minimum_identity_count,
  :type,
  :output_column_thresholds,
  :allowed_aggregate_expression_type)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_identity_count ⇒ Integer

The minimum number of distinct identities that each query output group must represent. This threshold applies to all output columns in the table. To override this threshold for a specific column, use outputColumnThresholds.

Returns:

• (Integer)

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

class AggregationThreshold < Struct.new(
  :identity_columns,
  :minimum_identity_count,
  :type,
  :output_column_thresholds,
  :allowed_aggregate_expression_type)
  SENSITIVE = []
  include Aws::Structure
end

#output_column_thresholds ⇒ Array<Types::OutputColumnThreshold>

The per-column overrides of minimumIdentityCount. An output column without an override uses minimumIdentityCount.

Returns:

• (Array<Types::OutputColumnThreshold>)

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

class AggregationThreshold < Struct.new(
  :identity_columns,
  :minimum_identity_count,
  :type,
  :output_column_thresholds,
  :allowed_aggregate_expression_type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of aggregation that the threshold enforces. Currently, the only supported value is COUNT_DISTINCT, which counts the distinct values in the identity column.

Returns:

• (String)

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

class AggregationThreshold < Struct.new(
  :identity_columns,
  :minimum_identity_count,
  :type,
  :output_column_thresholds,
  :allowed_aggregate_expression_type)
  SENSITIVE = []
  include Aws::Structure
end