interface AggregateOperationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSet.AggregateOperationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSet_AggregateOperationProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSet.AggregateOperationProperty`
Python	`aws_cdk.aws_quicksight.CfnDataSet.AggregateOperationProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDataSet` » `AggregateOperationProperty`

A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const aggregateOperationProperty: quicksight.CfnDataSet.AggregateOperationProperty = {
  aggregations: [{
    aggregationFunction: {
      listAggregation: {
        distinct: false,
        separator: 'separator',

        // the properties below are optional
        inputColumnName: 'inputColumnName',
      },
      percentileAggregation: {
        percentileValue: 123,

        // the properties below are optional
        inputColumnName: 'inputColumnName',
      },
      simpleAggregation: {
        functionType: 'functionType',

        // the properties below are optional
        inputColumnName: 'inputColumnName',
      },
    },
    newColumnId: 'newColumnId',
    newColumnName: 'newColumnName',
  }],
  alias: 'alias',
  source: {
    transformOperationId: 'transformOperationId',

    // the properties below are optional
    columnIdMappings: [{
      sourceColumnId: 'sourceColumnId',
      targetColumnId: 'targetColumnId',
    }],
  },

  // the properties below are optional
  groupByColumnNames: ['groupByColumnNames'],
};

Properties

Name	Type	Description
aggregations	`IResolvable` `\| (IResolvable` `\|` `AggregationProperty)[]`	The list of aggregation functions to apply to the grouped data, such as `SUM` , `COUNT` , or `AVERAGE` .
alias	`string`	Alias for this operation.
source	`IResolvable` `\|` `TransformOperationSourceProperty`	The source transform operation that provides input data for the aggregation.
groupByColumnNames?	`string[]`	The list of column names to group by when performing the aggregation.

aggregations

Type: IResolvable | (IResolvable | AggregationProperty)[]

The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .

alias

Type: string

Alias for this operation.

source

Type: IResolvable | TransformOperationSourceProperty

The source transform operation that provides input data for the aggregation.

groupByColumnNames?

Type: string[] (optional)

The list of column names to group by when performing the aggregation.

Rows with the same values in these columns will be grouped together.