Struct VectorIndexDescription 

#[non_exhaustive]
pub struct VectorIndexDescription {
    pub index_name: Option<String>,
    pub search_schema: Option<Vec<SearchSchemaElement>>,
    pub projection: Option<Projection>,
    pub vector_attribute: Option<VectorAttributeDefinition>,
    pub dimensions: Option<i64>,
    pub distance_function: Option<VectorDistanceFunction>,
    pub index_status: Option<IndexStatus>,
    pub backfilling: Option<bool>,
    pub index_size_bytes: Option<i64>,
    pub item_count: Option<i64>,
    pub index_arn: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_name: Option<String>

The name of the vector index.

search_schema: Option<Vec<SearchSchemaElement>>

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

projection: Option<Projection>

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

vector_attribute: Option<VectorAttributeDefinition>

The vector attribute configuration for the index.

dimensions: Option<i64>

The number of dimensions in each vector.

distance_function: Option<VectorDistanceFunction>

The distance function used to calculate similarity between vectors.

index_status: Option<IndexStatus>

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.

backfilling: Option<bool>

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

index_size_bytes: Option<i64>

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.

item_count: Option<i64>

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.

index_arn: Option<String>

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

Implementations

impl VectorIndexDescription

pub fn index_name(&self) -> Option<&str>

The name of the vector index.

pub fn search_schema(&self) -> &[SearchSchemaElement]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .search_schema.is_none().

pub fn projection(&self) -> Option<&Projection>

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

pub fn vector_attribute(&self) -> Option<&VectorAttributeDefinition>

The vector attribute configuration for the index.

pub fn dimensions(&self) -> Option<i64>

The number of dimensions in each vector.

pub fn distance_function(&self) -> Option<&VectorDistanceFunction>

The distance function used to calculate similarity between vectors.

pub fn index_status(&self) -> Option<&IndexStatus>

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.

pub fn backfilling(&self) -> Option<bool>

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

pub fn index_size_bytes(&self) -> Option<i64>

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.

pub fn item_count(&self) -> Option<i64>

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.

pub fn index_arn(&self) -> Option<&str>

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

impl VectorIndexDescription

pub fn builder() -> VectorIndexDescriptionBuilder

Creates a new builder-style object to manufacture VectorIndexDescription.

Trait Implementations

impl Clone for VectorIndexDescription

fn clone(&self) -> VectorIndexDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VectorIndexDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VectorIndexDescription

fn eq(&self, other: &VectorIndexDescription) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for VectorIndexDescription