Amazon S3 Reader Component
This component downloads files from an Amazon S3 Bucket. The component can either download the file or files in the bucket and path specified in its configuration, or the bucket and path passed into it via its input channel. The component can be used to download either a single file or an entire directory of files depending on how it is configured.
Data Governance
The Amazon S3 Reader Component will register all the File Data objects it returns with the Data Governance System. The File Data objects are registered as being derived from the object that triggered the download, either a Signal Data or a Simple Mapped Data object.
Input Channels
execute — Receives a SignalData object that instructs the component to execute its query. The component will download files according to its configuration. If a query is already executing, the message is ignored and logged.
executeWithParams — Receives a SimpleMappedData object that instructs the component to execute its query. The component will download files according to the configuration stored in the SimpleMappedData object. If a query is already executing, the message is ignored and logged. The object should contain the name of the bucker from which to read files in the "bucket" key, and the path from which to read files in the "path" key.
Output Channels
default — Outputs FileData objects for each file that is downloaded from the Amazon S3 Bucket.
noResults — Outputs a SignalData object if there are no files to download from the target location on the Amazon S3 Bucket.
error — Outputs ErrorOutput objects if there is an error communicating with the Amazon S3 Bucket.
Parameters
bucket — (String) The name of the Amazon S3 bucket from which files are to be downloaded when triggered by the execute input channel.
basePath — (String) The path in the Amazon S3 Bucket from which to download files when triggered by the execute input channel. If the download path points to a file, that single file is downloaded, and the component stops. If the download path points to a directory, all files in that directory are downloaded.