Upload to Amazon S3

The Amazon S3 (Simple Storage Service) external action receives messages and uploads objects to an Amazon S3 bucket.

The Amazon S3 external action has two output ports. The success port (✔) can send a message if the upload succeeds. The failure port (x) can send a message if the upload fails.

For more information about Amazon S3, see the Amazon S3 Getting Started Guide.

To use the the Amazon S3 external action, you will need:

  • Amazon Web Services (AWS) security credentials.
  • Ownership of the bucket where the data is to be uploaded or permission to upload to that bucket. (Optionally, permission to set the bucket versioning.)
  • The name of the bucket.
  • Path to the file/folder to be uploaded.

Parameters

  • Bucket: Provide the name of the Amazon S3 bucket to which you want to upload. The name is case-sensitive.
  • AWS Access Key ID and AWS Secret Access Key: Provide your security credentials. For more information, see AWS Security Credentials.
  • Encryption: (Optional) Enable Amazon S3 Server-Side Encryption. When enabled, Amazon S3 encrypts your data using AES-256 encryption mode.
  • Permissions: The predefined set of grantees and permissions to store with each uploaded object. The default is Private. For more information about predefined grants, see Access Control List (ACL) Overview > Canned ACL, in the AWS Documentation, at: http://docs.aws.amazon.com/AmazonS3/latest/dev/ACLOverview.html#CannedACL.
  • Destination Path: (Optional) Provide a location in the specified Bucket , using forward slashes (/).

    • For example, any of the following is acceptable:

    • myfolders/testfolder
    • /myfolders/testfolder
    • //myfolders/testfolder
    • myfolders/testfolder/
    • /myfolders/testfolder/

    If left blank, objects are uploaded to the bucket’s root. If the specified folder does not exist in the bucket, it is created during the upload.

  • Source Path: Provide the full path to the file/folder to be uploaded. If the source file is saved to a Resources directory, click the ellipsis (...) and select the file. If the file is in a different location, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\). Template macros are supported for this field; for an example, see Upload to FTP Server.
  • Enable File Versioning: (Optional) Enable/disable versioning for the specified bucket. To maintain the current behavior, or if you do not have permission to set bucket versioning, leave as Default.

Output Keys

See Also

Tip: To view the output keys from upstream components, click Show Upstream Keys.

Key Description
time Event time
source Event type
file.path (Success port only) File path
s3.etag (Success port only) Entity tag
error.type (Failure port only) Error type
error.message (Failure port only) Error message
aws.requestId (Failure port only) AWS Request ID
aws.status (Failure port only) AWS Status Code
aws.errorCode (Failure port only) AWS Error Code