VectorIndexDescription
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.
Contents
Note
In the following list, the required parameters are described first.
- Backfilling
-
Specifies whether the index is currently backfilling. During backfill,
SearchVectorsoperations might return incomplete results.Type: Boolean
Required: No
- Dimensions
-
The number of dimensions in each vector.
Type: Long
Valid Range: Minimum value of 1.
Required: No
- DistanceFunction
-
The distance function used to calculate similarity between vectors.
Type: String
Valid Values:
COSINE | DOT_PRODUCT | EUCLIDEANRequired: No
- IndexArn
-
The Amazon Resource Name (ARN) that uniquely identifies the vector index.
Type: String
Required: No
- IndexName
-
The name of the vector index.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+Required: No
- IndexSizeBytes
-
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.
Type: Long
Required: No
- 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.
Type: String
Valid Values:
CREATING | UPDATING | DELETING | ACTIVERequired: No
-
- ItemCount
-
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.
Type: Long
Required: No
- Projection
-
Specifies attributes that are copied (projected) from the table into the vector index.
Type: Projection object
Required: No
- SearchSchema
-
The search schema that defines partition key and inline filter attributes for the vector index.
Type: Array of SearchSchemaElement objects
Array Members: Minimum number of 1 item.
Required: No
- VectorAttribute
-
The vector attribute configuration for the index.
Type: VectorAttributeDefinition object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
