Skip to content

DynamoDB  >  Structures  >  VectorIndexDescription

VectorIndexDescription

Structure Class

VectorIndexDescription dataclass

Contains the current state and configuration of a vector index, including its status, size, item count, and the settings specified when the index was created.

Attributes

backfilling class-attribute instance-attribute 
backfilling: bool | None = None

Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.

dimensions class-attribute instance-attribute 
dimensions: int | None = None

The number of dimensions in each vector.

distance_function class-attribute instance-attribute 
distance_function: VectorDistanceFunction | None = None

The distance function used to calculate similarity between vectors.

index_arn class-attribute instance-attribute 
index_arn: str | None = None

The Amazon Resource Name (ARN) that uniquely identifies the vector index.

index_name class-attribute instance-attribute 
index_name: str | None = None

The name of the vector index.

index_size_bytes class-attribute instance-attribute 
index_size_bytes: int | None = None

The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

index_status class-attribute instance-attribute 
index_status: IndexStatus | None = None

The current state of the vector index:

  • CREATING - The index is being created.

  • ACTIVE - The index is ready for use.

  • DELETING - The index is being deleted.

item_count class-attribute instance-attribute 
item_count: int | None = None

The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

projection class-attribute instance-attribute 
projection: Projection | None = None

Specifies attributes that are copied (projected) from the table into the vector index.

search_schema class-attribute instance-attribute 
search_schema: list[SearchSchemaElement] | None = None

The search schema that defines partition key and inline filter attributes for the vector index.

vector_attribute class-attribute instance-attribute 
vector_attribute: VectorAttributeDefinition | None = None

The vector attribute configuration for the index.