Skip to content
v2.277.0

AggregationFunctionProperty Struct ​

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Example ​

ts
// 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 aggregationFunctionProperty: quicksight.CfnAnalysis.AggregationFunctionProperty = {
  attributeAggregationFunction: {
    simpleAttributeAggregation: 'simpleAttributeAggregation',
    valueForMultipleValues: 'valueForMultipleValues',
  },
  categoricalAggregationFunction: 'categoricalAggregationFunction',
  dateAggregationFunction: 'dateAggregationFunction',
  numericalAggregationFunction: {
    percentileAggregation: {
      percentileValue: 123,
    },
    simpleNumericalAggregation: 'simpleNumericalAggregation',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

aggregation_function_property = quicksight.CfnAnalysis.AggregationFunctionProperty(
    attribute_aggregation_function=quicksight.CfnAnalysis.AttributeAggregationFunctionProperty(
        simple_attribute_aggregation="simpleAttributeAggregation",
        value_for_multiple_values="valueForMultipleValues"
    ),
    categorical_aggregation_function="categoricalAggregationFunction",
    date_aggregation_function="dateAggregationFunction",
    numerical_aggregation_function=quicksight.CfnAnalysis.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight.CfnAnalysis.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

AggregationFunctionProperty aggregationFunctionProperty = AggregationFunctionProperty.builder()
        .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                .simpleAttributeAggregation("simpleAttributeAggregation")
                .valueForMultipleValues("valueForMultipleValues")
                .build())
        .categoricalAggregationFunction("categoricalAggregationFunction")
        .dateAggregationFunction("dateAggregationFunction")
        .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                .percentileAggregation(PercentileAggregationProperty.builder()
                        .percentileValue(123)
                        .build())
                .simpleNumericalAggregation("simpleNumericalAggregation")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var aggregationFunctionProperty = new AggregationFunctionProperty {
    AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
        SimpleAttributeAggregation = "simpleAttributeAggregation",
        ValueForMultipleValues = "valueForMultipleValues"
    },
    CategoricalAggregationFunction = "categoricalAggregationFunction",
    DateAggregationFunction = "dateAggregationFunction",
    NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
        PercentileAggregation = new PercentileAggregationProperty {
            PercentileValue = 123
        },
        SimpleNumericalAggregation = "simpleNumericalAggregation"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

aggregationFunctionProperty := &AggregationFunctionProperty{
	AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
		SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
		ValueForMultipleValues: jsii.String("valueForMultipleValues"),
	},
	CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
	DateAggregationFunction: jsii.String("dateAggregationFunction"),
	NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
		PercentileAggregation: &PercentileAggregationProperty{
			PercentileValue: jsii.Number(123),
		},
		SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
	},
}

Properties ​

attributeAggregationFunctionoptionalIResolvable | CfnAnalysis.AttributeAggregationFunctionPropertyattribute_aggregation_functionoptionaltyping.Union[IResolvable, AttributeAggregationFunctionProperty]attributeAggregationFunctionoptionalIResolvableAttributeAggregationFunctionoptionalIResolvableAttributeAggregationFunctionoptionalinterface{}#
Aggregation for attributes.
categoricalAggregationFunctionoptionalstringcategorical_aggregation_functionoptionalstrcategoricalAggregationFunctionoptionalStringCategoricalAggregationFunctionoptionalstringCategoricalAggregationFunctionoptional*string#
Aggregation for categorical values.
  • COUNT : Aggregate by the total number of values, including duplicates.
  • DISTINCT_COUNT : Aggregate by the total number of distinct values.
dateAggregationFunctionoptionalstringdate_aggregation_functionoptionalstrdateAggregationFunctionoptionalStringDateAggregationFunctionoptionalstringDateAggregationFunctionoptional*string#
Aggregation for date values.
  • COUNT : Aggregate by the total number of values, including duplicates.
  • DISTINCT_COUNT : Aggregate by the total number of distinct values.
  • MIN : Select the smallest date value.
  • MAX : Select the largest date value.
numericalAggregationFunctionoptionalIResolvable | CfnAnalysis.NumericalAggregationFunctionPropertynumerical_aggregation_functionoptionaltyping.Union[IResolvable, NumericalAggregationFunctionProperty]numericalAggregationFunctionoptionalIResolvableNumericalAggregationFunctionoptionalIResolvableNumericalAggregationFunctionoptionalinterface{}#
Aggregation for numerical values.