Amazon S3: Download Folder

Description

This step downloads an entire folder and its contents from an S3 bucket to a local directory. You specify the bucket name, the folder's key name, and the local output path. If you provide "null" as the key name, all contents in the bucket are downloaded. You can also clear the output folder before downloading. Use this step in workflows that need to retrieve complete directory structures from S3 for local processing, archiving, or data migration.

Reference

• Download an object

• SDK: Manager Download

Known issues

• If an empty folder that is folder that does not contain any file is given, it will execute the workflow, but nothing will be downloaded.
• If the internet connection is disconnected in the middle of downloading a folder, the contents will be partially downloaded to the point where the internet was disconnected.
• The plugin executes successfully and does not throw any error for the object, which is not present.

Configurations

Field Name	Description
Step Name	Specify a unique name for the step.
Connection tab:	For the Amazone S3 connection fields details, click Common Tab: Connection Fields
INPUT tab:	Input fields
Bucket Name	Specify the name of the S3 bucket from where the object is to be downloaded. The data type is String. This field is mandatory.
Get	Click the button to populate the list of available Buckets.
Key Name	The object name that is to be downloaded. It downloads a single object(folder). The data type is String. This field is mandatory. Notes: - The Key Name field is the Object’s Key name. - If the ''null'' value is given in Key Name, all the contents in the given bucket will be downloaded.
Output Folder Path	Folder path to download a folder at the given location. The data type is String. This field is mandatory.
Browse	To browse the folder path to download a folder from Amazon S3.
ADDITIONAL INPUT tab:	Additional Input fields
Delete Output Folder Contents Before Downloading	Specify Yes to delete output folder contents before downloading else specify No. Allowed values: Yes, No. The default value is No. The data type is String.