Index
Note
Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.
The attributes of a vector index.
Contents
- creationTime
-
Date and time when the vector index was created.
Type: Timestamp
Required: Yes
- dataType
-
The data type of the vectors inserted into the vector index.
Type: String
Valid Values:
float32Required: Yes
- dimension
-
The number of values in the vectors that are inserted into the vector index.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 4096.
Required: Yes
- distanceMetric
-
The distance metric to be used for similarity search.
Type: String
Valid Values:
euclidean | cosineRequired: Yes
- indexArn
-
The Amazon Resource Name (ARN) of the vector index.
Type: String
Required: Yes
- indexName
-
The name of the vector index.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: Yes
- vectorBucketName
-
The name of the vector bucket that contains the vector index.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: Yes
- metadataConfiguration
-
The metadata configuration for the vector index.
Type: MetadataConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: