IronFlowDocs

s3vector_delete_vectors

Delete vectors by keys from an Amazon S3 Vector index.

For complete teardown, run this node before s3vector_delete_index, then run s3vector_delete_bucket after every index in the bucket has been deleted.

Parameters

vector_bucket_namestringrequired*
Explicit bucket name that owns a named index.
bucketstringdefault no
Alias for vector_bucket_name.
index_namestringrequired*
Explicit target index name.
indexstringdefault no
Alias for index_name.
index_arnstringrequired*
Explicit self-contained alternative target.
keysarray<string>required
Keys to delete from the index.
keys_source_keystring
Context key containing string-array keys.
regionstringdefault AWS region chain
Override S3VECTORS_REGION, S3_REGION, AWS_REGION, or AWS_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 and Safety

Use exactly one explicit configured shape after interpolation: vector_bucket_name/bucket plus index_name/index, or index_arn by itself. Bucket ARN plus index name is not supported. Resource identifier environment variables are deliberately never consulted for vector deletion; region, endpoint, and AWS credentials may still come from the environment. Conflicting forms and non-string, incomplete, or blank targets fail before the AWS client is built.

Context Output

  • {output_key}_deleted_count — Number of keys submitted for deletion.
  • {output_key}_deleted_keys — Key list.
  • {output_key}_successtrue on success.

Example

local flow = Flow.new("s3vector_delete_vectors_example")

flow:step("delete_vectors", nodes.s3vector_delete_vectors({
    vector_bucket_name = "ironflow-vectors-demo",
    index_name = "ironflow-demo-index",
    keys = { "doc-1", "doc-2" },
    output_key = "delete"
}))

return flow

IronFlow documentation

Find the next step

Type a keyword to search the documentation.

to move · Enter to open · Esc to close