Amazon S3: Download File
Description
Amazon S3: Download File plugin step downloads a single file (object) from a bucket on Amazon S3.
Note:
Provide access (whitelist) to the following URL through your firewall and network: https://amazonaws.com/
Known issue
If the internet connection is disconnected in the middle of downloading a file, the contents will be partially downloaded to the point where the internet was disconnected.
Reference
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. The 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(file). If the file resides in any folder, it should be given as “foldername/filename.extension”. The data type is string. The field is mandatory. Notes: - The Key Name field is the Object’s Key name. - If the file to be downloaded resides in any folder/subdirectory, the Key Name should be given as “foldername/filename.extension”. |
| Output Folder Path | Folder path to download a file at the given location. The data type is string. The field is mandatory. |
| Browse | To browse the folder path to download a file from Amazon S3. |
| Version ID | The specific version ID of the object to be downloaded. Bucket versioning should be enabled. The data type is String. Notes: - To download an object of a specific version, S3 bucket versioning should be enabled. - If the version ID is not given, the latest file (without the ‘L’ marker) is downloaded. |
| 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. Default value: No. The data type is String. |
| Add Date TimeStamp For Duplicate File | Specify Yes to add Date TimeStamp for duplicate files. Allowed values: Yes, No. Default value: No. The data type is String. |
| Add File To Result | Specify Yes to add the downloaded files to the result set and display the download link on AE otherwise else select No. Allowed values: Yes, No. Default value: No. The data type is String. |
| OUTPUT tab: | Output fields |
| File Overwritten | Specify the output variable name in the field. The default output variable name is FileOverwritten. If the downloaded file already exists in the given location, the output response is Yes, else the response is No. |