Manage Files on Amazon S3
- 14 Dec 2021
- 2 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Manage Files on Amazon S3
- Updated on 14 Dec 2021
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The Amazon Web Services (AWS) Module allows users to manage files on the AWS S3 cloud-based storage. The AWS module provides pre-built Flow steps that allow users to store or delete files on the Amazon S3 file storage system.
Prerequisite:
- Installation of the AWS module. To learn how to install a module, Installing Modules in Decisions.
- Configuration of the AWS module. To learn more see Amazon Web Services Module.
- Active AWS account and application
Step Names
Use the region code instead of the region name. Region codes can be found in AWS documentation.
Create Folder
The Create Folder step allows a user to add a folder to Amazon S3 to store files into.
| Input Parameter | Description | |
|---|---|---|
| Bucket | Name of bucket in S3 | |
| Folder | Desired folder name | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Delete File From S3
The Delete File From S3 allows a user to remove a specified file from Amazon S3.
| Input Parameter | Description | |
|---|---|---|
| Bucket | Name of the bucket in S3 | |
| Key | Key for the specified file | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Get Client
The Get Client step allows a user to get the client information based on the region.
| Input Parameter | Description | |
|---|---|---|
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Get File Contents
The Get File Contents step allows a user to get the file information of a specified file.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of bucket in S3 | |
| FIle Name | The full file name of the specified file | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Get File From S3 And Store At
The Get FIle From S3 And Store At step allows a user to retrieve a file from S3 and store it.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of bucket in S3 | |
| File Name | The full file name | |
| Local File to Store | local file to store | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
List Objects
The List Objects step allows a user to list the options in the Amazon S3.
| Input Parameter | Description |
|---|---|
| Bucket Name | Name of the bucket in S3 |
List Objects with Text Prefix
The List Objects with Text Prefix step allows a user to list the objects in AMazon S3 with the specified text prefix.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of the bucket in S3 | |
| Prefix | Text prefix | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Put File In S3 From File Location
The Put File In S3 From File Location allows a user to add a file to S3 from a specified local file storage location.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of the bucket in S3 | |
| File Name To Store | FIle name to store in S3 | |
| Path To File On Workflow Server | Full path to file | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Put File In S3 From File Location With ACL
The Put File In S3 From File Location With ACL allows a user to add a file with ACL in S3 from the file location.
| Input Parameter | Description | |
|---|---|---|
| Acl | Access control list | |
| Bucket Name | Name of the bucket in S3 | |
| Folder | Desired name of the folder | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Put File In S3 With ACL
The Put FIle In S3 WIth ACL allows a user to put a specified file in S3 with ACL.
| Input Parameter | Description | |
|---|---|---|
| ACL | Access control list | |
| Bucket Name | Name of the bucket in S3 | |
| File | The desired file to upload | |
| File Name to Store | File name for the file to store | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Put File In S3
The Put File In S3 steps allows a user to add a specified file to S3.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of the bucket in S3 | |
| File | File to upload | |
| File Name To Store | Filename to use to store | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Set ACL On File
The Set ACL On FIle step allows a user to set the ACL permission on a specified file.
| Input Parameter | Description | |
|---|---|---|
| Bucket Name | Name of the bucket in S3 | |
| Canonical User Id | The user's canonical user is | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Set Canned ACLOn File
The Set Canned ACL On File allows a user to set canned ACL wrapper on a specified file.
| Input Parameter | Description | |
|---|---|---|
| ACLTo Set | Access Control List to set on file | |
| Bucket Name | Name of the bucket in S3 | |
| File Name | Filename of the specified file | |
| Region | ||
| DisplayName | Region name | |
| RegionSystemName | Region code | |
Was this article helpful?
