Amazon S3 Bucket

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

The Amazon S3 Bucket 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.

Note  When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

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

To use the the Amazon S3 Bucket 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.
  • Region: The region of the specified Bucket. This field is optional; however, in some cases the Amazon S3 trigger may be unable to validate the bucket without it.
  • 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: https://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 FTP Directory.
  • 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 Attributes

See Also

Tip  To view the output attributes from upstream components, click Show Upstream Attributes.
Attribute 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:

  • InvalidMessage: An error occurred while configuring this component, such as missing or malformed values.
  • DeadLetter: An error occured while connecting to an external resource. Examples may include connection issues, invalid credentials, or generic external resource exceptions.
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

Retry

  • Retry on failure: If checked, the automation attempts to run the action again if the initial attempt results in a failure to connect to the specified external resource for message delivery. The manner in which these retries are conducted is based on the remaining settings.
  • Use custom retry settings: If checked, the remaining retry settings are configurable. If not checked, they are set to the FME Flow default values.
  • Number of attempts: Maximum number of retries, if the action continues to fail.
  • Wait between attempts: Time to wait between retries. In conjunction with Backoff multiplier (below), the specified value is the wait time for the first retry.
  • Backoff multiplier: Factor by which to increase Wait between attempts on successive retries. For example, a value of 2.0 doubles the wait time for the next retry.
  • Randomization factor: Percentage by which to introduce randomness to Wait between attempts. For example, if Wait between attempts is 100 Seconds, and Randomization factor is 25, the wait time for each retry is randomly selected between 75 and 125 seconds.
  • Maximum wait between attempts: Maximum wait time between retries. In conjunction with Backoff multiplier, the specified value is the upper limit for wait time.