HierarchyFilterDropDownControl
A control from a hierarchy filter that displays the hierarchy as a dropdown list. You can expand a value to see and select the values beneath it, and select either a single value or multiple values.
Contents
Note
In the following list, the required parameters are described first.
- FilterControlId
-
The ID of the
HierarchyFilterDropDownControl.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- SourceFilterId
-
The source filter ID of the
HierarchyFilterDropDownControl. This must be theFilterIdof aHierarchyFilter.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- CommitMode
-
The visibility configuration of the Apply button on a
HierarchyFilterDropDownControl.Type: String
Valid Values:
AUTO | MANUALRequired: No
- ControlSortConfigurations
-
The sort configuration for the values displayed in the control. Only one sort configuration can be applied per control.
Type: Array of ControlSortConfiguration objects
Array Members: Maximum number of 1 item.
Required: No
- ControlTitleFormatText
-
The title text format configuration for the control.
Type: ControlTitleFormatText object
Required: No
- DisplayOptions
-
The display options of a control.
Type: HierarchyFilterDropDownControlDisplayOptions object
Required: No
- Title
-
The title of the
HierarchyFilterDropDownControl.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- Type
-
The type of the
HierarchyFilterDropDownControl. Choose one of the following options:-
MULTI_SELECT: The user can select multiple entries from a dropdown menu. -
SINGLE_SELECT: The user can select a single entry from a dropdown menu.
Type: String
Valid Values:
MULTI_SELECT | SINGLE_SELECTRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
