README
¶
S3vectors
Parity grade: B · SDK aws-sdk-go-v2/service/s3vectors@v1.16.3 · last audited 2026-10-18 (c1af87ba3)
Coverage
| Metric | Value |
|---|---|
| PARITY entries audited | 21 (21 ok) |
| Feature families | 6 (6 ok) |
| Known gaps | 8 |
| Structural gaps (can't be emulated) | 1 |
| Deferred items | 0 |
| Resource leaks | clean |
Known gaps
- Limits: topK 100, batch sizes 500 and 100, metadata byte limits and the 10000 bucket and index quotas come from AWS documentation; the SDK does not encode them
- Filter semantics: a missing field satisfies $ne and $nin and fails every other operator, and list-valued metadata matches when any element matches; both are taken from the documented operator behaviour, not SDK evidence
- PutVectors: a key repeated inside one batch keeps the last occurrence; AWS behaviour is unverified
- Index mode cutoff: the 2026-09-30 rule for CLASSIC comes from SDK documentation text and compares against the emulator clock
- Encryption: sseType and kmsKeyArn are stored but nothing is encrypted and the KMS key is not looked up, so the Kms*Exception errors are never raised
- Bucket policies: stored and returned, not enforced
- Throttling: TooManyRequestsException and ServiceUnavailableException are never produced
- Memory: vectors live in process memory (4 bytes per dimension plus metadata) with no spill to disk
Structural gaps
These do not block an A grade — no implementation could produce real data here because the underlying data source cannot exist in an emulator.
- QueryVectors in CLASSIC mode: AWS filters during an approximate search and may return fewer than topK matches; the emulator is exact in both modes
More
Documentation
¶
Overview ¶
Package s3vectors emulates Amazon S3 Vectors: vector buckets, indexes and exact nearest-neighbour search.
Index ¶
- type Bucket
- type Encryption
- type Handler
- func (h *Handler) ChaosOperations() []string
- func (h *Handler) ChaosRegions() []string
- func (h *Handler) ChaosServiceName() string
- func (h *Handler) ExtractOperation(c *echo.Context) string
- func (h *Handler) ExtractResource(c *echo.Context) string
- func (h *Handler) GetSupportedOperations() []string
- func (h *Handler) Handler() echo.HandlerFunc
- func (h *Handler) MatchPriority() int
- func (h *Handler) Name() string
- func (h *Handler) Reset()
- func (h *Handler) Restore(ctx context.Context, data []byte) error
- func (h *Handler) RouteMatcher() service.Matcher
- func (h *Handler) Snapshot(ctx context.Context) []byte
- type InMemoryBackend
- type Index
- type Provider
- type Vector
- type VectorSet
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bucket ¶
type Bucket struct {
Created time.Time `json:"created"`
Tags map[string]string `json:"tags,omitempty"`
Encryption Encryption `json:"encryption"`
Account string `json:"account"`
Region string `json:"region"`
Name string `json:"name"`
ARN string `json:"arn"`
DefaultIndexMode string `json:"defaultIndexMode"`
Policy string `json:"policy,omitempty"`
}
Bucket is a vector bucket.
type Encryption ¶
type Encryption struct {
SseType string `json:"sseType"`
KmsKeyArn string `json:"kmsKeyArn,omitempty"`
}
Encryption is a bucket or index encryption configuration.
type Handler ¶
type Handler struct {
Backend *InMemoryBackend
DefaultRegion string
// contains filtered or unexported fields
}
Handler serves the S3 Vectors REST-JSON API.
func (*Handler) ChaosOperations ¶
ChaosOperations lists the fault-injectable operations.
func (*Handler) ChaosRegions ¶
ChaosRegions lists the regions this handler serves.
func (*Handler) ChaosServiceName ¶
ChaosServiceName returns the lowercase service name for fault rules.
func (*Handler) ExtractOperation ¶
ExtractOperation returns the operation name.
func (*Handler) ExtractResource ¶
ExtractResource returns the tagged resource ARN, when the operation has one.
func (*Handler) GetSupportedOperations ¶
GetSupportedOperations lists every implemented operation.
func (*Handler) Handler ¶
func (h *Handler) Handler() echo.HandlerFunc
Handler returns the echo handler.
func (*Handler) MatchPriority ¶
MatchPriority returns the routing priority.
func (*Handler) RouteMatcher ¶
RouteMatcher matches by SigV4 signing name (or SDK user agent) plus a known path shape.
type InMemoryBackend ¶
type InMemoryBackend struct {
// contains filtered or unexported fields
}
InMemoryBackend is the S3 Vectors state; one coarse lock guards every table.
func NewInMemoryBackend ¶
func NewInMemoryBackend(accountID, region string) *InMemoryBackend
NewInMemoryBackend creates an empty backend.
func (*InMemoryBackend) AccountID ¶
func (b *InMemoryBackend) AccountID() string
AccountID returns the default account.
func (*InMemoryBackend) Region ¶
func (b *InMemoryBackend) Region() string
Region returns the default Region.
type Index ¶
type Index struct {
Created time.Time `json:"created"`
Tags map[string]string `json:"tags,omitempty"`
Encryption Encryption `json:"encryption"`
Account string `json:"account"`
Region string `json:"region"`
Bucket string `json:"bucket"`
Name string `json:"name"`
ARN string `json:"arn"`
DataType string `json:"dataType"`
DistanceMetric string `json:"distanceMetric"`
Mode string `json:"mode"`
NonFilterable []string `json:"nonFilterable,omitempty"`
Dimension int `json:"dimension"`
}
Index is a vector index inside a bucket.
type Provider ¶
type Provider struct{}
Provider implements service.Provider for Amazon S3 Vectors.
func (*Provider) Init ¶
func (p *Provider) Init(ctx *service.AppContext) (service.Registerable, error)
Init builds the backend and handler.
Source Files