View a markdown version of this page

SearchSchemaElement - Amazon DynamoDB

SearchSchemaElement

An element in the search schema of a vector index.

Contents

Note

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

AttributeName

The name of the attribute. This attribute must also be declared in the table's AttributeDefinitions.

Type: String

Length Constraints: Maximum length of 65535.

Required: Yes

SearchSchemaElementType

The role of the attribute in the search schema. Valid values:

  • HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression.

  • INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.

Type: String

Valid Values: HASH | INLINE_FILTER

Required: Yes

See Also

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