Read S3 object
Reads one bounded S3-compatible object into a run-scoped file.
@lainstack/s3/read-object · Object storage
How to use it
Section titled “How to use it”Read S3 object downloads one object by its exact key and stores it as a run file. Reference file from blocks that take a file, such as @lainstack/csv/parse, @lainstack/document/extract-text or @lainstack/xml/validate. The bytes are never placed in the block output. Use @lainstack/s3/list-objects first when you do not know the key.
Traps:
- Objects larger than 5 MiB fail the step. There is no streaming or partial read.
- A missing key does not fail the run. The step pauses and asks a person for a corrected
key, then retries with it. Check keys with@lainstack/s3/list-objectswhen they are not fixed. - The key is exact, not a prefix or pattern. It is relative to the connection’s configured prefix and cannot start with
http://,https://,s3://orarn:. bucketis optional. Set it only when the connection does not already select one.
Settings
Section titled “Settings”| Setting | Key | Type | Details |
|---|---|---|---|
| S3-compatible connection (required) | credentialId |
Connection | Uses the selected S3-compatible object-storage connection. At most 255 characters. |
| Bucket | bucket |
Text | Optional exact bucket when the connection does not already select one. Keys are relative to the configured connection prefix. |
| Object key (required) | key |
Text | Exact object key, relative to the configured connection prefix. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| File | file |
Value |
| Object key | key |
Text |
| Size | size |
Number |