View a markdown version of this page

AggregationThreshold - AWS Clean Rooms

AggregationThreshold

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

Contents

allowedAggregateExpressionType

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

Type: String

Valid Values: COLUMNS_ONLY | ANY_EXPRESSION

Required: Yes

identityColumns

The identity column, such as user_id, whose distinct values AWS 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.

Type: Array of strings

Array Members: Fixed number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

Required: Yes

minimumIdentityCount

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.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 100000.

Required: Yes

type

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.

Type: String

Valid Values: COUNT_DISTINCT

Required: Yes

outputColumnThresholds

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

Type: Array of OutputColumnThreshold objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: