FME Flow: 2024.2

Amazon SQS Queue

The Amazon SQS (Simple Queue Service) Queue external action receives messages and sends them to an Amazon SQS queue. A queue retains an unlimited number messages for up to 14 days. For more information about the Amazon SQS, see the Amazon SQS Getting Started Guide.

The Amazon SQS Queue external action has two output ports. The success port (✔) can send a message if the Amazon SQS queue is notified successfully. The failure port (x) can send a message if the notification fails.

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

Requirements

To use the Amazon SQS Queue external action, you need:

  • Amazon Web Services (AWS) security credentials.
  • Ownership of the queue where messages are to be sent, or permission to send messages to that queue.
  • The URL of the queue where messages are to be sent. If you own the queue you can find this information by navigating to your queue through the AWS Management Console. Otherwise, ask the queue owner for the URL.

    • Mouse-over to vew screenshot:

Parameters

Note  See also Working with Parameters in Automations Workflows.
Tip  To test that your parameters work as expected, click Validate.
  • SQS Queue URL: Provide the URL of the queue.
  • AWS Access Key ID and AWS Secret Access Key: Provide your AWS security credentials.
  • Message Body Template: The default message you want to send to the queue. The message can be up to 64 KB of text in any format.

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
sqs.messageId (Success port only) Message ID
sqs.md5 (Success port only) Message MD5 Digest
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 AWS Request ID
aws.status 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.