s3vector_put_vectors
Store vectors in an Amazon S3 Vector index.
Parameters
- vector_bucket_namestringrequired*default environment-only fallback
- Bucket that owns a named index. Uses
S3VECTOR_BUCKET_NAME, then legacyS3_BUCKET, only when no target field is configured. - bucketstringdefault no
- Alias for
vector_bucket_name. - index_namestringrequired*default environment-only fallback
- Target index name. Uses
S3VECTOR_INDEX_NAMEonly when no target field is configured. - indexstringdefault no
- Alias for
index_name. - index_arnstringrequired*default environment-only fallback
- Self-contained alternative target. Uses
S3VECTOR_INDEX_ARNonly when no target field is configured. - vectorsarray<object>required
- Vector payload list. Each item requires
keyanddata, optionalmetadata. - vectors_source_keystring
- Context key containing the vector array (alternative to
vectors). - regionstringdefault AWS region chain
- Override
S3VECTORS_REGION,S3_REGION,AWS_REGION, orAWS_DEFAULT_REGION. - endpoint_urlstringdefault AWS_ENDPOINT_URL env var
- Override the S3 Vectors service endpoint.
- output_keystringdefault s3vector
- Prefix for context output keys.
Target Resolution
Use exactly one supported shape: vector_bucket_name/bucket plus
index_name/index, or index_arn by itself. Bucket ARN plus index name is not
supported. If any target field is configured, the complete shape must come from
node configuration after interpolation; identifier environment variables
neither complete nor override it. With no configured target field, the node
accepts the same coherent environment-only shapes from
S3VECTOR_BUCKET_NAME (falling back to legacy S3_BUCKET) plus
S3VECTOR_INDEX_NAME, or from S3VECTOR_INDEX_ARN alone. Conflicting forms and
non-string, incomplete, or blank targets fail before the AWS client is built.
Vector Payload
Each vector object in vectors must contain:
key(string): vector key.data(array): numeric vector values. metadata(object, optional): metadata map associated with the vector.
Context Output
{output_key}_vector_count— Number of vectors attempted to store.{output_key}_vector_keys— List of vector keys sent.{output_key}_success—trueon success.
Example
local flow = Flow.new("s3vector_put_vectors_example")
flow:step("put_vectors", nodes.s3vector_put_vectors({
vector_bucket_name = "ironflow-vectors-demo",
index_name = "ironflow-demo-index",
vectors = {
{ key = "doc-1", data = { 0.11, 0.22, 0.33 }, metadata = { source = "docs" } },
{ key = "doc-2", data = { 0.41, 0.52, 0.63 }, metadata = { source = "docs" } },
},
output_key = "put"
}))
return flow