Help Desk

Submit a ticket My Tickets
Welcome
Login

Amazon S3 Command Reference

This BizApp provides the ability to interact with the AWS S3 service. It provides functionality to do everything that you can do with the AWS CLI for S3

Connections

Amazon S3

This BizApp provides the ability to interact with the AWS S3 service. It provides functionality to do everything that you can do with the AWS CLI for S3

Inputs

Input Type Detail Notes
Access Key Id TextField The AWS user's Access Key ID
Access Key Secret TextField The AWS user's Access Key Secret
Default Region TextField The default AWS region for this connection.
Alternate Endpoint TextField If your AWS S3 is hosted at a different address than the default endpoint, enter that URL here

Commands

Copy File

Copy a file from one location to another in S3.

Inputs

Input Type Detail Notes
Source File FileField The location of the file to copy. (e.g. bucket/path/to/file/in/S3)
Bucket TextField The name of the bucket to copy to.
S3 File Path (Key) TextField The full path to copy the object to.
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
Copy Result Json
Target Bucket String
Target Key String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Create Bucket

Create a new bucket.

Inputs

Input Type Detail Notes
Bucket TextField The name of the bucket to create
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
Bucket Json
Bucket Name String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Delete Bucket

Delete a bucket.

Inputs

Input Type Detail Notes
Bucket TextField The name of the bucket to delete..
Region TextField Optionally override the default region for the connection

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Delete Object

Delete an object in S3.

Inputs

Input Type Detail Notes
Bucket TextField The name of the bucket to delete from.
S3 File Path (Key) TextField The location of the object to delete.
Region TextField Optionally override the default region for the connection

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Download File

Upload a fille to an Amazon S3 bucket.

Inputs

Input Type Detail Notes
Destination Name FileField The name to give the file downloaded
Bucket TextField The name of the bucket to download from.
S3 File Path (Key) TextField The full path to the download location.
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
Downloaded File File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

List Buckets

List all buckets the user has access to.

Inputs

None

Outputs

Output Output Type Notes
Response File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

List Objects

List all of the objects in a bucket that match a prefix.

Inputs

Input Type Detail Notes
Bucket TextField The name of the bucket the objects are stored in
Prefix TextField The prefix of objects to match. All objects with a path that start with the prefix will be returned.
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
Objects File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Presign Object URL

Create a presigned object URL that can be accessed for the specified period of time.

Inputs

Input Type Detail Notes
Bucket TextField The name of the bucket the object is stored in.
S3 File Path (Key) TextField The full path to the object.
Duration NumberField The duration of time to make the URL available in the unit of time selected.
Unit DropdownField The unit of time for the duration.
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
File Details Json
Presigned URL String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed

Upload File

Upload a fille to an Amazon S3 bucket.

Inputs

Input Type Detail Notes
Source File FileField The file to upload to S3
Bucket TextField The name of the bucket to upload to.
S3 File Path (Key) TextField The full path to the upload location.
Region TextField Optionally override the default region for the connection

Outputs

Output Output Type Notes
Upload Details Json
Bucket String
Key String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.