Amazon SQS connection¶
Introduction¶
An Amazon SQS connection, created using the Amazon SQS connector, establishes access to Amazon SQS. Once a connection is configured, you can create instances of Amazon SQS activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or edit an Amazon SQS connection¶
A new Amazon SQS connection is created using the Amazon SQS connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Amazon SQS connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure an Amazon SQS connection¶
Each user interface element of the Amazon SQS connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Amazon SQS connection and must not contain forward slashes (
/
) or colons (:
). This name is also used to identify the Amazon SQS endpoint, which refers to both a specific connection and its activities. -
Access Key ID: Enter the IAM access key ID configured for Amazon SQS.
-
Secret Access Key: Enter the IAM secret access key configured for Amazon SQS.
-
AWS Region: Select the AWS Region associated with the Amazon SQS queue.
-
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After an Amazon SQS connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
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.