Skip to Content

Amazon SQS Connector

Summary

The Amazon SQS connector establishes access to Amazon SQS.

The Amazon SQS connector provides an interface for creating an Amazon SQS connection, the foundation used for generating instances of Amazon SQS activities. These activities, once configured, interact with Amazon SQS through the connection.

The Amazon SQS connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure an Amazon SQS connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Amazon SQS connection and its activities are referred to as an Amazon SQS endpoint:

Amazon SQS activity types

  • Send Messages: Sends messages from an Amazon SQS queue and is intended to be used as a target in an operation.

  • Receive Message: Listens for and retrieves messages from an Amazon SQS queue and is intended to be used as a source in an operation.

  • Get Messages: Retrieves all Amazon SQS messages available in a specific queue and is intended to be used as a source in an operation.

  • Create Queue: Creates standard queues or FIFO queues in Amazon SQS and is intended to be used as a target in an operation.

  • Delete Messages: Deletes messages from an Amazon SQS queue and is intended to be used as a target in an operation.

  • List Queues: Lists Amazon SQS queues and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Amazon SQS connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

To successfully use all activities in this connector, you must have the following AWS IAM account permissions:

  • sqs:CreateQueue
  • sqs:DeleteMessage
  • sqs:GetQueueUrl
  • sqs:ListQueues
  • sqs:ReceiveMessage
  • sqs:SendMessage

Cross-account permissions don't apply to this action. For more information, see Basic Examples of Amazon SQS Policies in the Amazon SQS Developer Guide.

The Amazon SQS connector uses the AWS SDK for Java version 1.12.522. Refer to the API documentation for information on the schema nodes and fields.

Prior to using the Receive Message activity, certain prerequisites must be met.

Troubleshooting

If you experience issues with the Amazon SQS connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using these specific configuration entries of logger name and level. Add both lines:

    <logger name="org.jitterbit.connector.verbose.logging.amazonsqs" level="DEBUG"/>
    <logger name="org.jitterbit.connector.amazonsqs" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.