• All Files

SQSReceiver

Using the Amazon Simple Queue Service (SQS), receives messages from an Amazon SQS queue.

Usage Notes

The performance of this transformer is dependent on the amount of memory allocated to the Java Virtual Machine (JVM). The following environment variables allow you to specify memory available to Java Plugins:

  • FME_JVM_MIN_HEAP_SIZE: Initial heap size for initializing the JVM. Default value is 1024K.

  • FME32_JVM_MIN_HEAP_SIZE: Same as FME_JVM_MIN_HEAP_SIZE, but applies to the 32-bit version of FME Desktop on Windows, and takes precedence over FME_JVM_MIN_HEAP_SIZE.

  • FME_JVM_MAX_HEAP_SIZE: Maximum heap size for initializing JVM. Default value is 16384K.

  • FME32_JVM_MAX_HEAP_SIZE: Same as FME_JVM_MAX_HEAP_SIZE, but applies to the 32-bit version of FME Desktop on Windows, and takes precedence over FME_JVM_MAX_HEAP_SIZE.

If unset, the JVM applies the default values. If set, the values must be multiples of 1024K (for example, 4M and 64M, or 4096K and 32768K).

Note: To pass additional parameters used by FME to the Java Virtual Machine, use the JAVA_TOOL_OPTIONS environment variable.

Input Ports

This transformer has no input ports.

Output Ports

ClosedOutput

Features containing messages received from the specified Amazon SQS queue. The content and other details of the message are stored as attributes of the feature. The following attributes are used:

Attribute Description
sqs_content The content of the message.
sqs_md5 The MD5 checksum of the message.
sqs_message_id The ID of the message.
sqs_receipt_handle The ID confirming receipt of the message.

Parameters

Amazon Simple Queue Service Parameters

ClosedAmazon SQS Queue URL

The URL of the Amazon queue to be polled.

ClosedAWS Access Key ID

An access key associated with a user with permission to receive messages from the queue.

ClosedAWS Secret Access Key

A secret key paired with the access key provided.

Receiver Options

ClosedPersistent Receiver

If Yes, the receiver runs indefinitely. If No, enter a maximum number of messages to read in Maximum Messages To Read.

ClosedMaximum Messages to Read

If Persistent Receiver is No, the maximum number of messages to read.

ClosedUse Queue Default Visibility Timeout

If Yes, received messages use the SQS queue default visibility timeout. If No, enter a new visibility timeout for received messages in Visibility Timeout.

ClosedVisibility Timeout

If Use Queue Default Visibility Timeout is No, the new visibility timeout for received messages.

ClosedDelete on Receive

Whether or not the receiver deletes each message before receiving a new one. If Yes, messages are deleted from the SQS queue before the feature exits the transformer. If No, use the SQS Deleter transformer to delete messages.

Working with SQS

For more information about receiving messages from a SQS queue using the Simple Queue Service (SQS), see the Amazon Simple Queue Service Publisher in the FME Server Reference Manual.

Editing Transformer Parameters

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

Transformer Categories

Integrations

Web

FME Licensing Level

FME Professional edition and above

Search FME Community

Search for samples and information about this transformer on the FME Community.