FME Flow: 2024.2

Amazon S3 Bucket

The Amazon S3 (Simple Storage Service) trigger polls activity on an Amazon S3 bucket, and sends JSON messages about that activity, including when files are added, changed, and deleted.

The Amazon S3 trigger has two output ports. The success port (✔) can send a message if the trigger polls successfully. The failure port (x) can send a message if the trigger fails to poll.

Note  When setting up an Amazon S3 trigger, you can specify how often to poll an S3 bucket. However, keep in mind that Amazon S3 is a pay-per-use service. Every poll is one request to this service.

Parameters

Note  See also Working with Parameters in Automations Workflows.
Tip  To test that your parameters work as expected, click Validate.
  • Bucket to Watch: The bucket name in the Amazon S3 account, case sensitive.
    • Note  For more information about locating buckets in the Amazon S3 Console, see Support for Viewing Data in the Console User Guide.
  • 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.
  • Path to Watch (Optional): Provide a folder location in the specified bucket to watch, using forward slashes.
    • Warning  Make sure the specified path is valid. The S3 Watch Publisher does not currently perform any verification that the path exists. If it does not, polling activity may produce false positive results.

    For example, any of the following is acceptable:

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

    If left blank, the trigger watches everything in the bucket. If the path does not exist, the publisher will not start.

    Note  For more information about locating folders in the Amazon S3 Console, see Support for Folders in the Console User Guide.
  • Watch Subdirectories: To watch activity in the selected directory and all subdirectories, specify Yes. To watch activity only in the selected directory and not in its subdirectories, specify No.
  • Poll Interval: Specify how often to poll from the S3 bucket.
    • Note  Amazon S3 is a pay-per-use service. Every poll is one request to this service.
  • Events to Watch for: By default, all actions on the specified directory are monitored, including adding (CREATE), changing (MODIFY), and deleting (DELETE) files (and folders, if applicable). To monitor only one or two of these actions, click the "x" beside the action you do not want to monitor to remove it. To add an action after removing it, click inside the dropbox and select it.
    • Note  Events trigger based on changes to the entity Tag (ETag), which is a representation of file contents. No message is triggered if a change to an existing file does not update the ETag. If a file is overwritten and the ETag value changes, a MODIFY event is triggered.

Output Attributes

See Also

Attribute Description
time

Event time
source Event type
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
file.event (Success port only) File action (Create/Modify/Delete)
file.path (Success port only) File path
file.rootName

(Success port only) File root name
s3.bucket (Success port only) Bucket