S3

S3 (s3)

Stream data from an S3 object.

Object Store Cloud binary json raw

Minimal example

input:
  s3:
    bucket-name: ~
    object-names: []

JSON

{
  "input": {
    "s3": {
      "bucket-name": null,
      "object-names": []
    }
  }
}

Contents

• Minimal example

• Fields

• Trigger

• Location

• Behavior

• Processing

• Authentication

• Object Properties

• Filtering

• Reliability

• Schema

Fields

Field	Type	Required	Description
bucket-name Location	string	✅	Bucket name.
object-names Location	string[]	✅	Object names or prefixes to target. When using list modes these are treated as search prefixes. An empty list could result in all objects being downloaded — take care with large buckets. Prompt (if empty): An empty list could result in all objects being downloaded.
trigger Trigger	Trigger		Run on the provided cadence; if omitted, this input runs exactly once.
region Location	string		S3 Region.
endpoint Location	string		S3 Endpoint.
mode Behavior	Mode		Input behavior: use list-and-download, list, or download depending on whether you want to enumerate objects, fetch contents, or download specific names directly. Allowed values: list-and-download-objects, list-objects, download-objects
ignore-linebreaks Behavior	boolean (bool)		Treat the entire object as a single event. When false, objects are split on newlines unless json=true instructs the runtime to parse JSON arrays.
payload-mode Behavior	Payload Mode		Select how payloads should be interpreted (auto, json, raw, binary). Allowed values: auto, json, raw, binary
preprocessors Processing	Preprocessors[]		Preprocessors (process downloaded data before making it available to the job) these processors will be run in the order they are specified. Allowed values: extension, gzip, parquet, base64
access-key Authentication	string		Access Key ID.
secret-key Authentication	string		Secret Key ID.
security-token Authentication	string		Security Token.
session-token Authentication	string		Session Token.
role-arn Authentication	string		A Role ARN for assuming role using above credentials.
object-name-field Object Properties	field (string)		The field that the object name from an operation should be stored in. Examples: data_field
creation-time-field Object Properties	field (string)		The field that the object creation time should be stored in. Examples: data_field
last-modified-field Object Properties	field (string)		The field that the object last modified time should be stored in. Examples: data_field
content-length-field Object Properties	field (string)		The field that the object content length information should be stored in. Examples: data_field
content-type-field Object Properties	field (string)		The field that the object content type information should be stored in. Examples: data_field
etag-field Object Properties	field (string)		The field that the object ETag should be stored in. Examples: data_field
data-field Object Properties	field (string)		A field that the object data should be nested in. Examples: data_field
timestamp-mode Behavior	Timestamp Mode		Derive a timestamp for this object for filtering purposes based on the selected strategy (e.g., object creation time vs. last modification).
maximum-age Filtering	Maximum Age		Ignore objects older than the provided duration (e.g., 5m, 1h30m). Leave empty to process all visible objects.
fingerprinting Reliability	boolean (bool)		Enable object fingerprinting to download each object only once, even across restarts.
maximum-fingerprint-age Reliability	duration (string)		How long to retain stored fingerprints before they are eligible for cleanup.
include-regex Filtering	regex[] (string)		Include objects matching the specified regular expressions. Examples: \d+[A-Z]*
exclude-regex Filtering	regex[] (string)		Exclude objects matching the specified regular expressions. Examples: \d+[A-Z]*
retry Reliability	Retry		How to retry failed operations (backoff, max attempts, etc.).

Trigger

Show fields

Field	Type	Required	Description
trigger	Trigger		Run on the provided cadence; if omitted, this input runs exactly once.

Location

Show fields

Field	Type	Required	Description
bucket-name	string	✅	Bucket name.
object-names	string[]	✅	Object names or prefixes to target. When using list modes these are treated as search prefixes. An empty list could result in all objects being downloaded — take care with large buckets. Prompt (if empty): An empty list could result in all objects being downloaded.
region	string		S3 Region.
endpoint	string		S3 Endpoint.

Behavior

Show fields

Field	Type	Required	Description
mode	Mode		Input behavior: use list-and-download, list, or download depending on whether you want to enumerate objects, fetch contents, or download specific names directly. Allowed values: list-and-download-objects, list-objects, download-objects
ignore-linebreaks	boolean (bool)		Treat the entire object as a single event. When false, objects are split on newlines unless json=true instructs the runtime to parse JSON arrays.
payload-mode	Payload Mode		Select how payloads should be interpreted (auto, json, raw, binary). Allowed values: auto, json, raw, binary
timestamp-mode	Timestamp Mode		Derive a timestamp for this object for filtering purposes based on the selected strategy (e.g., object creation time vs. last modification).

Processing

Show fields

Field	Type	Required	Description
preprocessors	Preprocessors[]		Preprocessors (process downloaded data before making it available to the job) these processors will be run in the order they are specified. Allowed values: extension, gzip, parquet, base64

Authentication

Show fields

Field	Type	Required	Description
access-key	string		Access Key ID.
secret-key	string		Secret Key ID.
security-token	string		Security Token.
session-token	string		Session Token.
role-arn	string		A Role ARN for assuming role using above credentials.

Object Properties

Show fields

Field	Type	Required	Description
object-name-field	field (string)		The field that the object name from an operation should be stored in. Examples: data_field
creation-time-field	field (string)		The field that the object creation time should be stored in. Examples: data_field
last-modified-field	field (string)		The field that the object last modified time should be stored in. Examples: data_field
content-length-field	field (string)		The field that the object content length information should be stored in. Examples: data_field
content-type-field	field (string)		The field that the object content type information should be stored in. Examples: data_field
etag-field	field (string)		The field that the object ETag should be stored in. Examples: data_field
data-field	field (string)		A field that the object data should be nested in. Examples: data_field

Filtering

Show fields

Field	Type	Required	Description
maximum-age	Maximum Age		Ignore objects older than the provided duration (e.g., 5m, 1h30m). Leave empty to process all visible objects.
include-regex	regex[] (string)		Include objects matching the specified regular expressions. Examples: \d+[A-Z]*
exclude-regex	regex[] (string)		Exclude objects matching the specified regular expressions. Examples: \d+[A-Z]*

Reliability

Show fields

Field	Type	Required	Description
fingerprinting	boolean (bool)		Enable object fingerprinting to download each object only once, even across restarts.
maximum-fingerprint-age	duration (string)		How long to retain stored fingerprints before they are eligible for cleanup.
retry	Retry		How to retry failed operations (backoff, max attempts, etc.).

Schema

• Trigger - Cron - Window - Start Options
• Trigger - Interval - Window - Start Options
• Trigger Options
• Timestamp Mode Options
• Trigger - Message Fields
• Trigger - Cron - Window - Start - Start Time Fields
• Trigger - Cron - Window Fields
• Trigger - Cron Fields
• Trigger - Interval - Window - Start - Start Time Fields
• Trigger - Interval - Window Fields
• Trigger - Interval Fields
• Maximum Age Fields
• Retry Fields
• Trigger - Message - Filter Kind Options
• Trigger - Message - Filter Source Options
• Trigger - Message - Filter Type Options
• Mode Options
• Payload Mode Options
• Preprocessors Options

Trigger - Cron - Window - Start Options

Option	Name	Type	Description
start-time	Start Time	object
tracked	Tracked	string	Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window - Start Options

Option	Name	Type	Description
start-time	Start Time	object
tracked	Tracked	string	Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger Options

Option	Name	Type	Description
message	Message	object
cron	Cron	object
interval	Interval	object

Timestamp Mode Options

Option	Name	Type	Description
none	None	map	The default mode, do not filter based on timestamps.
last-modified	Last Modified	map	Filter object on the last-modified timestamp reported by the service.
blob-name-pattern	Blob Name Pattern	string	Filter blobs on the timestamp derived from the object name for example: relevant-name-pattern: =(?P<Y>[\\d]{4,4})-(?P<m>[\\d]{2,2})-(?P<d>[\\d]{2,2})/.

Trigger - Message Fields

Field	Type	Required	Description
limit	number (integer)		The number of times to run the input. Examples: 42, 1.2e-10
filter-kind	Filter Kind		Specifies whether the message originated from the “system” or by the “user”. Allowed values: system, user, runtime-artifact-fetch, runtime-artifact-fetch-error, runtime-artifact-clear, runtime-artifact-clear-ack, runtime-artifact-fetch-reply, runtime-artifact-update, …
filter-source	Filter Source[]		Specifies what process generated the message. Was it a “server”, “worker” or “job”? Allowed values: job, worker, server
filter-worker	string		Specifies what worker to select.
filter-job	string		Specifies the name of the job that the message came from.
filter-type	Filter Type[]		Specifies that particular types of message ought to match. Allowed values: worker-licensed, worker-unlicensed, variable, variable-deleted, begin-shutting-down-job, begin-shutting-down-server, begin-shutting-down-worker, broadcast-job-thread-state, …
filter-tag	string		Specifies that messages matched ought to carry a tag with a particular value. This only matches against user-generated messages.

Trigger - Cron - Window - Start - Start Time Fields

Field	Type	Required	Description
start-time	time-format (string)	✅	Allows the windowing to start at a specified time. Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-file	path (string)	✅	Specify file where timestamp would be stored in order to resume, for when Job has been restarted. Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Cron - Window Fields

Field	Type	Required	Description
size	duration (string)	✅	Window size.
offset	duration (string)		Window offset.
start	Start		Specify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Cron Fields

Field	Type	Required	Description
cron	cron-expression (string)	✅	The Cron pattern.
immediate	boolean (bool)		Run as soon as invoked, instead of waiting for the specified cron interval.
random-offset	duration (string)		Sets a random offset to the schedule, then sticks to it.
window	Window		Optional window definition when the schedule should only read a bounded range.

Trigger - Interval - Window - Start - Start Time Fields

Field	Type	Required	Description
start-time	time-format (string)	✅	Allows the windowing to start at a specified time. Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-file	path (string)	✅	Specify file where timestamp would be stored in order to resume, for when Job has been restarted. Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window Fields

Field	Type	Required	Description
size	duration (string)	✅	Window size.
offset	duration (string)		Window offset.
start	Start		Specify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Interval Fields

Field	Type	Required	Description
duration	duration (string)	✅	Duration to wait between events.
random-offset	duration (string)		Sets a random offset to the schedule, then sticks to it.
window	Window		Optional window definition when the interval should only cover a bounded range.

Maximum Age Fields

Field	Type	Required	Description
value	duration (string)	✅

Retry Fields

Field	Type	Required	Description
timeout	time-interval (string)	✅	timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h
retries	number (integer)		number of retries. Examples: 42, 1.2e-10

Trigger - Message - Filter Kind Options

Value	Description
system	System
user	User
runtime-artifact-fetch	Runtime Artifact Fetch
runtime-artifact-fetch-error	Runtime Artifact Fetch Error
runtime-artifact-clear	Runtime Artifact Clear
runtime-artifact-clear-ack	Runtime Artifact Clear Ack
runtime-artifact-fetch-reply	Runtime Artifact Fetch Reply
runtime-artifact-update	Runtime Artifact Update
runtime-artifact-update-ack	Runtime Artifact Update Ack

Trigger - Message - Filter Source Options

Value	Description
job	Job
worker	Worker
server	Server

Trigger - Message - Filter Type Options

Value	Description
worker-licensed	Worker Licensed
worker-unlicensed	Worker Unlicensed
variable	Variable
variable-deleted	Variable Deleted
begin-shutting-down-job	Begin Shutting Down Job
begin-shutting-down-server	Begin Shutting Down Server
begin-shutting-down-worker	Begin Shutting Down Worker
broadcast-job-thread-state	Broadcast Job Thread State
broadcast-server-thread-state	Broadcast Server Thread State
broadcast-worker-thread-state	Broadcast Worker Thread State
check-job-report-time	Check Job Report Time
check-worker-report-time	Check Worker Report Time
de-register-job-thread-dependency	De Register Job Thread Dependency
de-register-server-thread-dependency	De Register Server Thread Dependency
de-register-worker-thread-dependency	De Register Worker Thread Dependency
deployed-job-active	Deployed Job Active
deployed-job-removed	Deployed Job Removed
deployed-job-should-be-running	Deployed Job Should Be Running
deployment-phase	Deployment Phase
heart-beat	Heart Beat
initialise-internal-state	Initialise Internal State
initialise-job-states	Initialise Job States
job-batch-end	Job Batch End
job-backlog-update	Job Backlog Update
job-checkpoint-update	Job Checkpoint Update
job-deploy-ready	Job Deploy Ready
job-deployed	Job Deployed
job-document-end	Job Document End
job-document-start	Job Document Start
job-errors	Job Errors
job-execution-anomaly	Job Execution Anomaly
job-execution-status	Job Execution Status
job-emit-custom	Job Emit Custom
job-finished	Job Finished
job-idle	Job Idle
job-initiated	Job Initiated
job-is-processing	Job Is Processing
job-logs	Job Logs
job-metrics	Job Metrics
job-notifications	Job Notifications
job-removing	Job Removing
job-removed	Job Removed
job-remove-failed	Job Remove Failed
job-remove-ready	Job Remove Ready
job-replaced	Job Replaced
job-required	Job Required
job-run-ended	Job Run Ended
job-runtime-error	Job Runtime Error
job-runtime-settings	Job Runtime Settings
job-run-started	Job Run Started
job-running-docker	Job Running Docker
job-running-script	Job Running Script
job-running-subprocess	Job Running Subprocess
job-running-system-d	Job Running System D
job-settings	Job Settings
job-step-statistics	Job Step Statistics
job-started	Job Started
job-staged	Job Staged
job-state-transition	Job State Transition
job-shutting-down	Job Shutting Down
job-stopping	Job Stopping
job-stopped	Job Stopped
job-timed-out	Job Timed Out
job-suspicious-silence	Job Suspicious Silence
job-thread-state	Job Thread State
job-trace	Job Trace
job-trace-requires-samples	Job Trace Requires Samples
job-updated	Job Updated
job-worker-comms-error	Job Worker Comms Error
job-unstaged	Job Unstaged
license-state-changed	License State Changed
license-validation-failed	License Validation Failed
license-validation-ok	License Validation Ok
license-volume-violation	License Volume Violation
new-license	New License
override-job-coordinated-shutdown	Override Job Coordinated Shutdown
override-server-coordinated-shutdown	Override Server Coordinated Shutdown
override-worker-coordinated-shutdown	Override Worker Coordinated Shutdown
register-job-thread-dependency	Register Job Thread Dependency
register-server-thread-dependency	Register Server Thread Dependency
register-worker-thread-dependency	Register Worker Thread Dependency
run-job-failure	Run Job Failure
server-logs	Server Logs
server-metrics-batch	Server Metrics Batch
server-started	Server Started
server-starting	Server Starting
server-stopping	Server Stopping
server-thread-state	Server Thread State
server-worker-comms-error	Server Worker Comms Error
shutdown-jobs	Shutdown Jobs
shutdown-worker	Shutdown Worker
system-shutdown	System Shutdown
update-upstream-sync-for-job	Update Upstream Sync For Job
update-upstream-sync-for-worker	Update Upstream Sync For Worker
update-variable	Update Variable
user-alert	User Alert
user-generated	User Generated
user-notification	User Notification
worker-command-for-job	Worker Command For Job
worker-auth-lease-ack	Worker Auth Lease Ack
worker-connected	Worker Connected
worker-created	Worker Created
worker-debug-heart-beat	Worker Debug Heart Beat
worker-error	Worker Error
worker-first-seen	Worker First Seen
worker-heart-beat	Worker Heart Beat
worker-logs	Worker Logs
worker-metrics-batch	Worker Metrics Batch
worker-offline	Worker Offline
worker-requests-auth-lease	Worker Requests Auth Lease
worker-server-comms-error	Worker Server Comms Error
worker-settings	Worker Settings
worker-shutdown	Worker Shutdown
worker-shutting-down	Worker Shutting Down
worker-started	Worker Started
worker-state-uuid	Worker State Uuid
worker-stopping	Worker Stopping
worker-suspicious-silence	Worker Suspicious Silence
worker-system-information	Worker System Information
worker-thread-state	Worker Thread State
worker-updated	Worker Updated
worker-modified	Worker Modified
worker-removed	Worker Removed
context-changed	Context Changed
rerender-deployment	Rerender Deployment
job-killed	Job Killed
message-serviced	Message Serviced
failed-to-service-message	Failed To Service Message
worker-wants-initial-settings	Worker Wants Initial Settings
worker-wants-initial-settings-reply	Worker Wants Initial Settings Reply
worker-wants-deployed-jobs	Worker Wants Deployed Jobs
worker-wants-deployed-jobs-reply	Worker Wants Deployed Jobs Reply
worker-wants-job-configuration	Worker Wants Job Configuration
worker-wants-job-configuration-reply	Worker Wants Job Configuration Reply
job-wants-dslir-key	Job Wants Dslir Key
job-wants-dslir-key-reply	Job Wants Dslir Key Reply
worker-wants-dslir-key	Worker Wants Dslir Key
worker-wants-dslir-key-reply	Worker Wants Dslir Key Reply
job-wants-variables	Job Wants Variables
job-wants-variables-reply	Job Wants Variables Reply
job-wants-credentials	Job Wants Credentials
job-wants-credentials-reply	Job Wants Credentials Reply
job-wants-credentials-error	Job Wants Credentials Error
job-wants-secret-variables-reply	Job Wants Secret Variables Reply
job-credentials-invalidated	Job Credentials Invalidated
aggregator-health	Aggregator Health
worker-verification-token	Worker Verification Token
worker-requests-verification-token	Worker Requests Verification Token
runtime-artifact-update	Runtime Artifact Update
runtime-artifact-update-ack	Runtime Artifact Update Ack
runtime-artifact-clear	Runtime Artifact Clear
runtime-artifact-clear-ack	Runtime Artifact Clear Ack
runtime-artifact-fetch	Runtime Artifact Fetch
runtime-artifact-fetch-reply	Runtime Artifact Fetch Reply
runtime-artifact-fetch-error	Runtime Artifact Fetch Error

Mode Options

Value	Description
list-and-download-objects	List Objects and Download
list-objects	List Objects
download-objects	Download Given Objects

Payload Mode Options

Value	Description
auto	Auto
json	Json
raw	Raw
binary	Binary

Preprocessors Options

Value	Description
extension	Preprocess the object or blob based on the extension of the object or blob name (.gz, .parquet)
gzip	UnGzip the received data
parquet	Extract the received data as JSON rows from a parquet file
base64	Encode the binary data as base64