To interact with the Amazon Web Services® (AWS) Simple Storage Service® (S3) service, add a step in a chain that uses an Amazon S3® connection command. For example:
- Upload, download, or manage files
- Manage buckets
- List objects
- Pre-sign object URLs
These commands map to the current operations provided with the AWS command-line interface (CLI) for S3. To enable these commands, an IT admin first creates an Amazon S3 connector.
Copy file
To copy a file from one location to another in S3, use a Copy file command.
Properties
| Property |
Detail |
| Source file |
Enter the location of the file to copy, such as bucket/path/to/file/in/S3. |
| Bucket |
Enter the name of the bucket to copy to. |
| S3 file path (Key) |
Enter the full path to copy the object to. |
Outputs
| Output |
Output type |
| Copy result |
JSON |
| Target bucket |
String |
| Target key |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Create bucket
To create a new S3 bucket, use a Create bucket command.
Properties
| Property |
Detail |
| Bucket |
Enter the name of the bucket to create. |
Outputs
| Output |
Output type |
| Bucket |
JSON |
| Bucket name |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Delete bucket
To delete an S3 bucket, use a Delete bucket command.
Properties
| Property |
Detail |
| Bucket |
Enter the name of the bucket to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Delete object
To delete an object from S3, use a Delete object command.
Properties
| Property |
Detail |
| Bucket |
Enter the name of the bucket to delete from. |
| S3 file path (key) |
Enter the location of the bucket to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Download file
To download a file from an S3 bucket, use a Download file command.
Properties
| Property |
Detail |
| Destination name |
Enter the name to give the downloaded file. |
| Bucket |
Enter the name of the bucket to download from. |
| S3 file path (key) |
Enter the full path to the download location. |
Outputs
| Output |
Output type |
| Downloaded file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
List buckets
To list all S3 buckets the user can access, use a List buckets command.
Properties
None
Outputs
| Output |
Output type |
| Response |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
List objects
To list all objects in an S3 bucket that match a prefix, use a List objects command.
Properties
| Property |
Detail |
| Bucket |
Enter the name of the bucket with the objects to list. |
| Prefix |
Enter the prefix of the objects to list. The command returns all objects with a path that starts with the prefix. |
Outputs
| Output |
Output type |
| Objects |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Pre-sign object URL
To create a pre-signed object URL that can be accessed for the specified period of time, use a Pre-sign object URL command.
Properties
| Property |
Detail |
| Bucket |
Enter the name of the bucket to make accessible. |
| S3 file path (key) |
Enter the full path to access. |
| Duration |
Enter how long to make the URL available, based on Unit. |
| Unit |
Select the unit of time for Duration. |
Outputs
| Output |
Output type |
| File details |
JSON |
| Pre-signed URL |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |
Upload file
To upload a file to an S3 bucket, use an Upload file command.
Properties
| Property |
Detail |
| Source file |
Enter the file to upload to S3. |
| Bucket |
Enter the name of the bucket to upload to. |
| S3 file path (key) |
Enter the full path to the upload location. |
Outputs
| Output |
Output type |
| Upload details |
JSON |
| Bucket |
String |
| Key |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed |