TopicCalculatedField - Amazon Quick Sight
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TopicCalculatedField

A structure that represents a calculated field.

Contents

Note

In the following list, the required parameters are described first.

CalculatedFieldName

The calculated field name.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

Expression

The calculated field expression.

Type: String

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

Required: Yes

Aggregation

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

Type: String

Valid Values: SUM | MAX | MIN | COUNT | DISTINCT_COUNT | AVERAGE | MEDIAN | STDEV | STDEVP | VAR | VARP

Required: No

AllowedAggregations

The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

Type: Array of strings

Valid Values: COUNT | DISTINCT_COUNT | MIN | MAX | MEDIAN | SUM | AVERAGE | STDEV | STDEVP | VAR | VARP | PERCENTILE

Required: No

CalculatedFieldDescription

The calculated field description.

Type: String

Length Constraints: Maximum length of 256.

Required: No

CalculatedFieldSynonyms

The other names or aliases for the calculated field.

Type: Array of strings

Length Constraints: Maximum length of 256.

Required: No

CellValueSynonyms

The other names or aliases for the calculated field cell value.

Type: Array of CellValueSynonym objects

Required: No

ColumnDataRole

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

Type: String

Valid Values: DIMENSION | MEASURE

Required: No

ComparativeOrder

The order in which data is displayed for the calculated field when it's used in a comparative context.

Type: ComparativeOrder object

Required: No

DefaultFormatting

The default formatting definition.

Type: DefaultFormatting object

Required: No

DisableIndexing

A Boolean value that indicates if a calculated field is visible in the autocomplete.

Type: Boolean

Required: No

IsIncludedInTopic

A boolean value that indicates if a calculated field is included in the topic.

Type: Boolean

Required: No

NeverAggregateInFilter

A Boolean value that indicates whether to never aggregate calculated field in filters.

Type: Boolean

Required: No

NonAdditive

The non additive for the table style target.

Type: Boolean

Required: No

NotAllowedAggregations

The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

Type: Array of strings

Valid Values: COUNT | DISTINCT_COUNT | MIN | MAX | MEDIAN | SUM | AVERAGE | STDEV | STDEVP | VAR | VARP | PERCENTILE

Required: No

SemanticType

The semantic type.

Type: SemanticType object

Required: No

TimeGranularity

The level of time precision that is used to aggregate DateTime values.

Type: String

Valid Values: SECOND | MINUTE | HOUR | DAY | WEEK | MONTH | QUARTER | YEAR

Required: No

See Also

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