TopicIRFilterOption - Amazon QuickSight

TopicIRFilterOption

The definition for a TopicIRFilterOption.

Contents

Note

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

AggMetrics

The agg metrics for the TopicIRFilterOption.

Type: Array of FilterAggMetrics objects

Array Members: Maximum number of 100 items.

Required: No

Aggregation

The aggregation for the TopicIRFilterOption.

Type: String

Valid Values: SUM | MIN | MAX | COUNT | AVERAGE | DISTINCT_COUNT | STDEV | STDEVP | VAR | VARP | PERCENTILE | MEDIAN | PTD_SUM | PTD_MIN | PTD_MAX | PTD_COUNT | PTD_DISTINCT_COUNT | PTD_AVERAGE | COLUMN | CUSTOM

Required: No

AggregationFunctionParameters

The aggregation function parameters for the TopicIRFilterOption.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Value Length Constraints: Maximum length of 1024.

Required: No

AggregationPartitionBy

The AggregationPartitionBy for the TopicIRFilterOption.

Type: Array of AggregationPartitionBy objects

Array Members: Maximum number of 50 items.

Required: No

Anchor

The anchor for the TopicIRFilterOption.

Type: Anchor object

Required: No

Constant

The constant for the TopicIRFilterOption.

Type: TopicConstantValue object

Required: No

FilterClass

The filter class for the TopicIRFilterOption.

Type: String

Valid Values: ENFORCED_VALUE_FILTER | CONDITIONAL_VALUE_FILTER | NAMED_VALUE_FILTER

Required: No

FilterType

The filter type for the TopicIRFilterOption.

Type: String

Valid Values: CATEGORY_FILTER | NUMERIC_EQUALITY_FILTER | NUMERIC_RANGE_FILTER | DATE_RANGE_FILTER | RELATIVE_DATE_FILTER | TOP_BOTTOM_FILTER | EQUALS | RANK_LIMIT_FILTER | ACCEPT_ALL_FILTER

Required: No

Function

The function for the TopicIRFilterOption.

Type: String

Valid Values: CONTAINS | EXACT | STARTS_WITH | ENDS_WITH | CONTAINS_STRING | PREVIOUS | THIS | LAST | NEXT | NOW

Required: No

Inclusive

The inclusive for the TopicIRFilterOption.

Type: Boolean

Required: No

Inverse

The inverse for the TopicIRFilterOption.

Type: Boolean

Required: No

LastNextOffset

The last next offset for the TopicIRFilterOption.

Type: TopicConstantValue object

Required: No

NullFilter

The null filter for the TopicIRFilterOption.

Type: String

Valid Values: ALL_VALUES | NON_NULLS_ONLY | NULLS_ONLY

Required: No

OperandField

The operand field for the TopicIRFilterOption.

Type: Identifier object

Required: No

Range

The range for the TopicIRFilterOption.

Type: TopicConstantValue object

Required: No

SortDirection

The sort direction for the TopicIRFilterOption.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

TimeGranularity

The time granularity for the TopicIRFilterOption.

Type: String

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

Required: No

TopBottomLimit

The TopBottomLimit for the TopicIRFilterOption.

Type: TopicConstantValue object

Required: No

See Also

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