TopicColumn - Amazon QuickSight
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).

TopicColumn

Represents a column in a dataset.

Contents

Note

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

ColumnName

The name of the column.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

Aggregation

The type of aggregation that is performed on the column data when it's queried.

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 column. 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

CellValueSynonyms

The other names or aliases for the column cell value.

Type: Array of CellValueSynonym objects

Required: No

ColumnDataRole

The role of the column in the data. Valid values are DIMENSION and MEASURE.

Type: String

Valid Values: DIMENSION | MEASURE

Required: No

ColumnDescription

A description of the column and its contents.

Type: String

Length Constraints: Maximum length of 256.

Required: No

ColumnFriendlyName

A user-friendly name for the column.

Type: String

Length Constraints: Maximum length of 256.

Required: No

ColumnSynonyms

The other names or aliases for the column.

Type: Array of strings

Length Constraints: Maximum length of 256.

Required: No

ComparativeOrder

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

Type: ComparativeOrder object

Required: No

DefaultFormatting

The default formatting used for values in the column.

Type: DefaultFormatting object

Required: No

DisableIndexing

A Boolean value that indicates whether the column shows in the autocomplete functionality.

Type: Boolean

Required: No

IsIncludedInTopic

A Boolean value that indicates whether the column is included in the query results.

Type: Boolean

Required: No

NeverAggregateInFilter

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

Type: Boolean

Required: No

NonAdditive

The non additive value for the column.

Type: Boolean

Required: No

NotAllowedAggregations

The list of aggregation types that are not allowed for the column. 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 of data contained in the column.

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: