IronFlowDocs

s3_list_objects

List objects under a bucket and optional prefix.

Parameters

bucketstringrequireddefault env S3_BUCKET
Bucket to query.
prefixstringdefault ""
Prefix used to filter keys.
delimiterstringdefault ""
Optional delimiter for grouped prefixes.
max_keysnumber
Optional maximum items per request/page.
regionstringdefault S3_REGION / AWS_REGION
Explicit AWS/S3 region override.
endpoint_urlstringdefault env AWS_ENDPOINT_URL
Optional custom endpoint (for S3-compatible services).
force_path_stylebooldefault false
Force path-style bucket addressing.
output_keystringdefault "s3"
Prefix for context output keys.

Context Output

  • {output_key}_bucket — Queried bucket.
  • {output_key}_prefix — Prefix filter used.
  • {output_key}_count — Total objects returned (all pages).
  • {output_key}_objects — Array of objects (key, size, etag, last_modified, storage_class).
  • {output_key}_successtrue on success.

Example

local flow = Flow.new("s3_list")

flow:step("list", nodes.s3_list_objects({
    bucket = env("S3_BUCKET"),
    prefix = "raw/temp/notes/",
    max_keys = 50,
    output_key = "notes_list"
}))

flow:step("log", nodes.log({
    message = "Found ${ctx.notes_list_count} objects under ${ctx.notes_list_prefix}"
})):depends_on("list")

return flow

IronFlow documentation

Find the next step

Type a keyword to search the documentation.

to move · Enter to open · Esc to close