`s3vector_get_bucket`

Get metadata for an existing Amazon S3 Vector bucket.

This node is read-only but requires S3 Vectors service access through the AWS SDK credential chain and configured region/endpoint. The runnable s3vector_vector_workflow.lua creates the bucket and index it inspects. It deletes demo vectors on the success path, then deletes the index and bucket. An earlier failure or interrupted run can still skip that success-dependent cleanup.

Parameters

vector_bucket_namestringrequired*default environment-only fallback: Bucket name to query. Uses S3VECTOR_BUCKET_NAME, then legacy S3_BUCKET, only when no target field is configured.
bucketstringdefault no: Alias for vector_bucket_name.
vector_bucket_arnstringrequired*default environment-only fallback: Bucket ARN to query. Uses S3VECTOR_BUCKET_ARN only when no target field is configured.
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

Use exactly one bucket target: vector_bucket_name/bucket, or vector_bucket_arn. If any target field is configured, its interpolated value must form the complete config-only target; bucket identifier environment variables neither complete nor override it. With no configured target, the node accepts one coherent environment-only form: S3VECTOR_BUCKET_NAME (falling back to legacy S3_BUCKET) or S3VECTOR_BUCKET_ARN. Conflicting forms and non-string, incomplete, or blank targets fail before the AWS client is built.

Context Output

{output_key}_bucket_name — Returned bucket name.
{output_key}_bucket_arn — Returned bucket ARN.
{output_key}_creation_time — ISO timestamp string.
{output_key}_encryption_configuration — Encryption configuration object (best-effort string encoding).
{output_key}_success — true on success.

Example

See the linked workflow for the executable, cataloged example. Minimal use:

local flow = Flow.new("s3vector_get_bucket_example")

flow:step("get_bucket", nodes.s3vector_get_bucket({
    vector_bucket_name = "ironflow-vectors-demo",
    output_key = "bucket"
}))

return flow