View a markdown version of this page

HierarchyFilterNode - Amazon Quick
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).

HierarchyFilterNode

A node in the selection tree of a HierarchyFilter. Each node records the values that are selected at one level of the hierarchy. Nodes nest through Children to record selections at deeper levels.

The tree cannot be deeper than the number of levels declared in HierarchyLevels. A tree can be a maximum of 5 levels deep, and a node can have a maximum of 1,000 children.

Contents

Note

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

Column

The column that this node selects values from. This column must match the column of the corresponding level in HierarchyFilter$HierarchyLevels. The node at depth 1 must match the first level, the node at depth 2 must match the second level, and so on.

Type: ColumnIdentifier object

Required: Yes

Children

The nodes that record the selections at the next level of the hierarchy. You can specify a maximum of 1,000 children per node.

Type: Array of HierarchyFilterNode objects

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Required: No

HierarchyValues

The values that are selected at this level of the hierarchy. You can specify a maximum of 2,000 values per node.

Type: Array of strings

Array Members: Maximum number of 2000 items.

Length Constraints: Maximum length of 512.

Required: No

ParentValue

The value in the parent node's HierarchyValues that this node belongs to. When a parent selects several values, each of its children repeats one of them here to identify which branch of the hierarchy that child describes.

Omit this attribute on the root node of HierarchyTree, which has no parent.

Type: String

Length Constraints: Maximum length of 512.

Required: No

See Also

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