TopicFilter - Amazon QuickSight

TopicFilter

A structure that represents a filter used to select items for a topic.

Contents

Note

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

FilterName

The name of the filter.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

OperandFieldName

The name of the field that the filter operates on.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

CategoryFilter

The category filter that is associated with this filter.

Type: TopicCategoryFilter object

Required: No

DateRangeFilter

The date range filter.

Type: TopicDateRangeFilter object

Required: No

FilterClass

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Type: String

Valid Values: ENFORCED_VALUE_FILTER | CONDITIONAL_VALUE_FILTER | NAMED_VALUE_FILTER

Required: No

FilterDescription

A description of the filter used to select items for a topic.

Type: String

Length Constraints: Maximum length of 256.

Required: No

FilterSynonyms

The other names or aliases for the filter.

Type: Array of strings

Length Constraints: Maximum length of 256.

Required: No

FilterType

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Type: String

Valid Values: CATEGORY_FILTER | NUMERIC_EQUALITY_FILTER | NUMERIC_RANGE_FILTER | DATE_RANGE_FILTER | RELATIVE_DATE_FILTER

Required: No

NumericEqualityFilter

The numeric equality filter.

Type: TopicNumericEqualityFilter object

Required: No

NumericRangeFilter

The numeric range filter.

Type: TopicNumericRangeFilter object

Required: No

RelativeDateFilter

The relative date filter.

Type: TopicRelativeDateFilter object

Required: No

See Also

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