Skip to content

SearchSchemaElement

Source code in docs_src/capo_dynamodb/types/search_schema_element.py
class SearchSchemaElement(TypedDict, closed=True):
    attribute_name: "capo_dynamodb.types.attribute_name.AttributeName"
    """<p>The name of the attribute.</p>"""
    search_schema_element_type: (
        "capo_dynamodb.types.search_schema_element_type.SearchSchemaElementType"
    )
    """<p>The role of the attribute in the search schema. Valid values:</p> <ul> <li> <p> <code>HASH</code> - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the <code>SearchConditionExpression</code>.</p> </li> <li> <p> <code>INLINE_FILTER</code> - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the <code>SearchConditionExpression</code>.</p> </li> </ul>"""

attribute_name instance-attribute

attribute_name: AttributeName

The name of the attribute.

search_schema_element_type instance-attribute

search_schema_element_type: 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.