Import files from Amazon S3
🤖/s3/import imports whole directories of files from your S3 bucket.
Keep your credentials safe. Since you need to provide credentials to this Robot, please always use this together with Templates and/or Template Credentials, so that you can never leak any secrets while transmitting your Assembly Instructions.
ignore_errorsArray of Strings / Boolean ⋅ default:
Possible array members are
You might see an error when trying to extract metadata from your imported files. This happens, for example, for files with a size of zero bytes. Including
"meta"in the array will cause the Robot to not stop the import (and the entire Assembly) when that happens.
"import"in the array will ensure the Robot does not cease to function on any import errors either.
To keep backwards compatibility, setting this parameter to
truewill set it to
Please create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your S3 bucket, Key, Secret and Bucket region.
While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead:
pathString / Array of Stringsrequired
The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example:
If it points to a directory, indicated by a trailing slash (
/), then all files that are direct descendants to this directory will be imported. For example:
Directories are not imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the
If you want to import all files from the root directory, please use
/as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with
/, you'll receive an error:
A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.
You can also use an array of path strings here to import multiple paths in the same Robot's Step.
recursiveBoolean ⋅ default:
Setting this to
truewill enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.
Please use the pagination parameters
page_numberInteger ⋅ default:
The pagination page number. For now, in order to not break backwards compatibility in non-recursive imports, this only works when recursive is set to
When doing big imports, make sure no files are added or removed from other scripts within your path, otherwise you might get weird results with the pagination.
files_per_pageInteger ⋅ default:
The pagination page size. This only works when recursive is
truefor now, in order to not break backwards compatibility in non-recursive imports.
Related blog posts
- Introducing the new /s3/import Robot July 17, 2013
- A Happy 2014 from Transloadit! January 14, 2014
- Kicking Transloadit Into Gear for the New Year February 1, 2015
- Raising prices (for new customers) February 7, 2018
- Adding recursive imports to our /s3/import Robot December 14, 2018
- Let's Build: An Image Alt-Text Generator May 9, 2022
- Setting up S3 for Transloadit March 25, 2023