Overview
This node enables interaction with AWS S3-compatible storage services, focusing on file operations such as downloading files from a specified bucket. The "File - Download" operation allows users to retrieve a file stored in an S3 bucket and output it as binary data within the workflow.
Common scenarios include:
- Automating retrieval of files stored in cloud buckets for further processing.
- Integrating S3 file downloads into workflows that require file content input.
- Backing up or synchronizing files from S3 storage to other systems.
For example, a user can configure this node to download a specific image or document from their S3 bucket and then pass it to another node for analysis or upload it elsewhere.
Properties
| Name | Meaning |
|---|---|
| Provider | The cloud storage provider. Default is "aws". This could be used to specify different S3-compatible providers if supported. |
| Region | The AWS region where the bucket is located. Options include various global AWS regions like "US East (N. Virginia) - us-east-1", "Europe (Frankfurt) - eu-central-1", etc. |
| Access Key ID | The access key identifier for authenticating with the S3 service. Required for API access. |
| Secret Access Key | The secret key corresponding to the access key ID. Used for authentication. Marked as a password field for security. |
| Custom Endpoint | Optional custom endpoint URL for connecting to an S3-compatible service other than AWS standard endpoints. Useful for private clouds or alternative providers. |
| Bucket Name | The name of the S3 bucket from which to download the file. Required. |
| File Key | The key (path) of the file inside the bucket to download. Must not end with a slash ("/") because downloading directories is not supported. Required. |
| Put Output File in Field | The name of the binary property in the output where the downloaded file will be stored. Defaults to "data". This allows subsequent nodes to access the file content as binary data. |
Output
The node outputs the downloaded file as binary data attached to each item in the workflow's data array. Specifically:
- The original JSON data of the input item is preserved.
- A new binary property (named by the user, default "data") is added containing the file content.
- The binary data includes the file content buffer and metadata such as the original filename and MIME type.
- If the input item already contains binary data, it is preserved and merged with the new binary property.
This structure allows downstream nodes to easily consume the downloaded file, for example, to process images, parse documents, or upload files elsewhere.
Dependencies
- Requires valid AWS credentials: an access key ID and secret access key with permissions to read objects from the specified bucket.
- Supports specifying a custom endpoint for S3-compatible services beyond AWS.
- No additional external dependencies are required beyond standard AWS S3 API access.
- The node expects the environment to have network access to the specified AWS region or custom endpoint.
Troubleshooting
Error: "Downloading a whole directory is not yet supported"
This error occurs if the file key ends with a slash "/", indicating a folder rather than a single file. To fix, specify the exact file key including the filename.Authentication errors
Ensure the provided access key ID and secret access key are correct and have sufficient permissions to access the bucket and object.File not found or access denied
Verify the bucket name and file key are correct. Check bucket policies and object ACLs to ensure the credentials have read access.Network or region issues
Confirm the selected region matches the bucket location. If using a custom endpoint, verify its correctness and accessibility.
Links and References
- AWS S3 Documentation – Official AWS documentation for S3 service.
- AWS Regions and Endpoints – List of AWS S3 regions and endpoints.
- n8n Binary Data Handling – How n8n handles binary data in workflows.