Skip to main content

S3 Read

The S3 Read activity reads a file from an Amazon S3 bucket and returns its content for use in subsequent workflow steps.

info

Ensure the IAM user or role has s3:GetObject permission on the target bucket.

Configuring the S3 Read Activity

To configure the S3 Read activity, fill in the required fields in the activity panel.

Configuration

FieldRequiredDescriptionExample
NameRequiredSpecify the name for this activity.MyActivity
DescriptionOptionalSpecify the description for this activity.Reads a file from S3
ResourceRequiredDrag and drop an S3 Connection resource from the workspace.
Bucket NameOptionalS3 bucket name.my-data-bucket
File PathOptionalPath to the file. (mapping supported)data/reports/2024/report.csv
File NameOptionalFile name including extension. (mapping supported)report-2024.csv

Advanced

FieldRequiredDescriptionExample
Encryption TypeOptionalEncryption type applied to the file. Options: NONE, PGP.NONE, PGP
Encryption ResourceOptionalDrag and drop a certificate for encryption/decryption.
Content TypeOptionalFormat of the file content to be read. Options: CSV, JSON, XML, TEXT, BINARY.CSV, JSON, XML
Compression TypeOptionalCompression applied to the file. Options: NONE, ZIP.NONE, ZIP

Input

FieldRequiredData TypeDescriptionExample
Bucket NameOptionalStringS3 bucket name.
File PathOptionalStringFile path.data/reports/2024/report.csv
File NameOptionalStringFile name.report-2024.csv
StreamingOptionalBooleanEnable streaming mode.

Output

FieldRequiredData TypeDescriptionExample
Bucket NameOptionalStringS3 bucket name.
KeyOptionalStringObject key.
File NameOptionalStringFile name.report-2024.csv
ContentOptionalStringContent.
Content LengthOptionalNumberContent size in bytes.0