| Next revision | Previous revisionLast revisionBoth sides next revision |
| transformations:amazoncommand [2020/10/06 05:05] – created dmitry | transformations:amazoncommand [2021/11/01 15:41] – craigt |
|---|
| ===== Amazon Command ===== | {{ transformations:AmazonCommandAction.png}} |
| | ====== AMAZON COMMAND ====== |
| | Category: Workflow / App/Cloud\\ |
| |
| The action performs file operations with Amazon S3 buckets. Requires a configured connector "Amazon S3". | \\ |
| | =====Description===== |
| | The action performs file operations with Amazon S3 buckets. A configured [[connectors:awss3|Amazon S3 connector]] is required. |
| |
| === Available commands === | Currently, the following commands are available: |
| | * List files |
| | * List folders |
| | * Download file |
| | * Download folder |
| | * Upload file |
| | * Upload folder |
| | * Delete file |
| |
| ^ Command ^ Description ^ | \\ |
| |List files | Produce a list of files in the specified S3 bucket. | | =====Action settings===== |
| |Download file | Download a single file from the specified S3 bucket to a local folder. | | ^ Setting ^ Description ^ |
| |Download folder | Download multiple files from the specified path in S3 bucket to a local folder. | | |Command|Select the file operation this action will perform. Options: //List files//, //List folders//, //Download file//, //Download folder//, //Upload file//, //Upload folder//, or //Delete file//. See below for details of each command type.| |
| |Upload file | Upload a single file from a local folder to the specified S3 bucket. | | |Connector<sup>*</sup>|Select the preconfigured Amazon S3 connector, or, build one by selecting //Add connector//.| |
| |Upload folder | Upload multiple files from the specified local folder (and, optionally, subfolders) to the specified folder in S3 bucket. | | |Bucket<sup>1</sup>|Select the Amazon S3 bucket to perform the command in.| |
| |Delete file | Delete a single file in the specified S3 bucket. | | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ |
| | <sup>1</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column. |
| |
| | \\ |
| | ====List files settings==== |
| | **Description:** Produce a list of files, with selected details, in a specified S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |Folder<sup>*</sup>|Select a folder containing the files to create the file list from.| |
| | |Columns|Select the details of the found files to be included in the dataset. Each detail creates a column in the dataset. Options: //File name with full path//, //File name only//, //File extension//, //Size//, and //Date modified//.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column. |
| |
| === See also === | \\ |
| * [[transformations:filecommand|File command]] | ====List folders settings==== |
| * [[transformations:folderlist|List of folders]] | **Description:** Produce a list of folders, with selected details, in a specified S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |Folder<sup>*</sup>|Enter or select a folder containing the subfolders to create the list of.| |
| | |Columns|Select the details of the folders to be included in the dataset. Each detail creates a column in the dataset. Options: //Folder name with full path// and //Folder name only//.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| |
| | \\ |
| | ====Download file settings==== |
| | **Description:** Downloads the specified file from the S3 bucket to the local location defined. |
| | ^ Setting ^ Description ^ |
| | |File path<sup>*</sup>|Enter or browse to the file in the S3 bucket to be downloaded.| |
| | |Local folder<sup>*</sup>|Enter or browse to the local folder to download the file to.| |
| | |If a file with such\\ name already exists|Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder.\\ Options: //Overwrite//, //Do nothing//, or //Halt project execution//. See the "File already exists" table below.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| |
| | \\ |
| | ====Download folder settings==== |
| | **Description:** Downloads multiple files from the specified folder from the S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |Folder path<sup>*</sup>|Enter or browse to the folder in S3 bucket containing the files to download.| |
| | |Local folder<sup>*</sup>|Enter or browse to the local folder to download the files to. This action will //overwrite// files with the same name(s)\\ that already exist(s) in the destination folder.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| | |
| | \\ |
| | ====Upload file settings==== |
| | **Description:** Uploads the specified local file to the specified folder in the S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |File path<sup>*</sup>|Enter or browse to the local file to upload.| |
| | |Target folder<sup>*</sup>|Enter or browse to a folder in the S3 bucket to upload the file to.| |
| | |If a file with such\\ name already exists|Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder.\\ Options: //Overwrite//, //Do nothing//, or //Halt project execution//. See the "File already exists" table below.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| | |
| | \\ |
| | ====Upload folder settings==== |
| | **Description:** Uploads multiple files (and, optionally, subfolders) with the specified local folder to a folder in the S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |Local folder<sup>*</sup>|Select the local folder to upload the files and subfolders (if selected) from.| |
| | |Upload subfolders recursively|When checked, all subfolders in the specified folder, regardless of depth, will be uploaded.| |
| | |Filter files|When checked, enter a filter to use on the filenames in the specified folder to constrain which files are uploaded. Using wildcards in the filter is supported.| |
| | |Target folder<sup>*</sup>|Enter or browse to a folder in the S3 bucket to upload the files to. This action will //overwrite// files with the same name(s) that already exist(s) in the destination folder.| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| | |
| | \\ |
| | ====Delete file settings==== |
| | **Description:** Deletes the specified file stored in the S3 bucket. |
| | ^ Setting ^ Description ^ |
| | |File path<sup>*</sup>|Enter or browse to the remote file in the S3 bucket to delete.| |
| | |If the file doesn't exist|Select how EasyMorph handles situations when the specified file does not exist. Options: //Do nothing// (nothing\\ happens, the workflow continues, no error is displayed), or //Halt project execution// (workflow stops, an error is displayed).| |
| | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]], or the first value of a column. |
| | |
| | \\ \\ |
| | ====File already exists options==== |
| | ^Option ^Description ^ |
| | |Overwrite|The new file replaces the original file.| |
| | |Do nothing|No file is downloaded/uploaded, the workflow does not halt, and no error is displayed.| |
| | |Halt project execution|The project will stop processing and this action will display an error.| |
| | |
| | \\ |
| | =====Remarks===== |
| | The easiest way to build a list of remote files in an S3 bucket to be downloaded or deleted is to use this action in its //File list// configuration, including the "File name with full path" option. This list can then be modified to generate the final list of files to be downloaded. |
| | |
| | \\ |
| | =====See also===== |
| | * [[transformations:filecommand|File command]] |
| | * [[transformations:folderlist|List of folders]] |
