Amazon S3: Download Folder
Description
Amazon S3: Download Folder plugin step downloads a single folder (object) from a bucket on Amazon S3.
Reference
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: | Connection fields |
| Region | Specify a valid AWS region or click the Get button to choose a region from the Region Explorer window. The field type is String. This field is mandatory. |
| Button: Get | Click Get button to open the Region Explorer window populated with the list of Regions available on the Amazon S3 instance. Choose a Region. |
| Access Key: | Access key to authenticate an Amazon S3 cloud instance. |
| Accept Values from fields | Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Access Key field to appear as Text box. |
| Access Key | Specify the Access Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory. |
| Secret Key: | Secret key to authenticate Amazon AWS cloud. |
| Accept Values from fields | Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Secret Key field to appear as Text box. |
| Secret Key | Specify the Secret Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory. |
| Button: Test Connection | Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon S3 cloud instance. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
| 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. |