description = SQSExtension.EXTENSION_DESCRIPTION

Configurations

Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Host

String

The optional proxy port

 

Port

Number

The optional proxy port

 

Username

String

The optional proxy username

 

Password

String

The optional proxy password

 

Domain

String

The optional proxy domain

 

Workstation

String

The optional proxy workstation

 

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.

50000

 

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended.

50000

 

Access Key

String

x 

Secret Key

String

x 

Try Default AWSCredentials Provider Chain

Boolean

false

 

Queue Name

String

Name of the queue to connect, if one does not exist the connector will automatically create one. Required if Queue URL has not been defined.

 

Queue URL

String

Queue URL takes priority over the Queue Name and is required if Queue Name has not been defined.

 

Region Endpoint

Enumeration, one of:

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

  • EUWEST1

  • EUCENTRAL1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • APNORTHEAST1

  • SAEAST1

Queue Region

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 
Role
Parameters
Name Type Description Default Value Required

Host

String

The optional proxy port

 

Port

Number

The optional proxy port

 

Username

String

The optional proxy username

 

Password

String

The optional proxy password

 

Domain

String

The optional proxy domain

 

Workstation

String

The optional proxy workstation

 

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.

50000

 

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended.

50000

 

Access Key

String

x 

Secret Key

String

x 

Try Default AWSCredentials Provider Chain

Boolean

false

 

Queue Name

String

Name of the queue to connect, if one does not exist the connector will automatically create one. Required if Queue URL has not been defined.

 

Queue URL

String

Queue URL takes priority over the Queue Name and is required if Queue Name has not been defined.

 

Region Endpoint

Enumeration, one of:

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

  • EUWEST1

  • EUCENTRAL1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • APNORTHEAST1

  • SAEAST1

Queue Region

 

Role ARN

String

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Associated Operations

Associated Sources

Operations

Add Permission

<sqs:add-permission>

Adds a permission to this message queue.

a name for this permission the AWS account ID's for the account to share this queue with a list to indicate how much to share (SendMessage, ReceiveMessage, ChangeMessageVisibility, DeleteMessage, GetQueueAttributes) Permissions will be added to the queue represented by this URL. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Label

String

x 

Account Ids

Array of String

x 

Actions

Array of String

x 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Change Message Visibility

<sqs:change-message-visibility>

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.

The receipt handle associated with the message whose visibility timeout should be changed. The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout. The URL of the Amazon SQS queue to take action on. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Receipt Handle

String

#[header:inbound:sqs.message.receipt.handle]

 

Visibility Timeout

Number

x 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Change Message Visibility Batch

<sqs:change-message-visibility-batch>

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

A list of receipt handles of the messages for which the visibility timeout must be changed. The URL of the Amazon SQS queue to take action on. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Receipt Handles

#[payload]

 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Create Queue

<sqs:create-queue>

Creates a new queue, or returns the URL of an existing one.

The name for the queue to be created. A map of attributes with their corresponding values. Valid Map Keys: Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

x 

Attributes

Object

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Delete Message

<sqs:delete-message>

Deletes the message identified by message object on the queue this object represents.

Receipt handle of the message to be deleted The URL of the queue to delete messages from If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Receipt Handle

String

#[header:inbound:sqs.message.receipt.handle]

 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Delete Message Batch

<sqs:delete-message-batch>

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.

A list of receipt handles for the messages to be deleted. The URL of the queue to delete messages as a batch from. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Receipt Handles

#[payload]

 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Delete Queue

<sqs:delete-queue>

Deletes the message queue represented by this object. Will delete non-empty queue.

The URL of the queue to delete. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Get Approximate Number Of Messages

<sqs:get-approximate-number-of-messages>

Gets an approximate number of visible messages for a queue.

The URL of the queue If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Get Queue Attributes

<sqs:get-queue-attributes>

Gets queue attributes. This is provided to expose the underlying functionality.

A list of attribute retrieve information for. The URL of the Amazon SQS queue to take action on. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attribute Names

Array of String

#[payload]

 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Get Queue Url

<sqs:get-queue-url>

Returns the URL of an existing queue.

The name of the queue whose URL must be fetched. The AWS account ID of the owner that created the queue. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

x 

Queue Owner AWS Account Id

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

List Dead Letter Source Queues

<sqs:list-dead-letter-source-queues>

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

The queue URL of a dead letter queue. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

List Queues

<sqs:list-queues>

Returns a list of your queues. The maximum number of queues that can be returned is 1000.

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name Prefix

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Purge Queue

<sqs:purge-queue>

Deletes the messages in a queue specified by the queue URL.

the queue URL where messages are to be fetched from. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Read

<sqs:read>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Url

String

 

Max Number Of Messages

Number

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Message

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Remove Permission

<sqs:remove-permission>

Removes a permission from this message queue.

a name for the permission to be removed Permissions will be deleted from the queue represented by this URL. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Label

String

x 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Send Message

<sqs:send-message>

Sends a message to a specified queue. The message must be between 1 and 256K bytes long.

Container for the parameters to the sendmessage operation. the queue where the message is to be sent. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Message

#[payload]

 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Send Message Batch

<sqs:send-message-batch>

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage

the queue where the message is to be sent. A list of SendMessageBatchRequestEntry items. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Messages

#[payload]

 

Queue Url

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Set Queue Attributes

<sqs:set-queue-attributes>

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

A map of attributes to set. The URL of the queue. If any internal errors are encountered inside the connector while attempting to make the request or handle the response. For example if a network connection is not available.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attributes

Object

#[payload]

 

Queue Url

String

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SQS:RETRY_EXHAUSTED  

  • SQS:CONNECTIVITY  

Sources

Receivemessages

<sqs:receivemessages>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Visibility Timeout

Number

30

 

Preserve Messages

Boolean

false

 

Number Of Messages

Number

1

 

Queue Url

String

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

Attributes Type

String

For Configurations.

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

The object store where the redelivery counter for each message is going to be stored.

Change Message Visibility Batch Result

Field Type Description Default Value Required

Failed

Successful

Batch Result Error Entry

Field Type Description Default Value Required

Code

String

Id

String

Message

String

Sender Fault

Boolean

Change Message Visibility Batch Result Entry

Field Type Description Default Value Required

Id

String

Change Message Visibility Batch Request Entry

Field Type Description Default Value Required

Id

String

Receipt Handle

String

Visibility Timeout

Number

Create Queue Result

Field Type Description Default Value Required

Queue Url

String

Delete Message Batch Result

Field Type Description Default Value Required

Failed

Successful

Delete Message Batch Result Entry

Field Type Description Default Value Required

Id

String

Delete Message Batch Request Entry

Field Type Description Default Value Required

Id

String

Receipt Handle

String

Get Queue Attributes Result

Field Type Description Default Value Required

Attributes

Object

Get Queue Url Result

Field Type Description Default Value Required

Queue Url

String

List Dead Letter Source Queues Result

Field Type Description Default Value Required

Queue Urls

Array of String

List Queues Result

Field Type Description Default Value Required

Queue Urls

Array of String

Message

Field Type Description Default Value Required

Delay Seconds

Number

Message Attributes

Object

Message Body

String

Message Group Id

String

Message Id

String

Receipt Handle

String

Send Message Result

Field Type Description Default Value Required

MD5 Of Message Attributes

String

MD5 Of Message Body

String

M D5 Of Message Attributes

String

M D5 Of Message Body

String

Message Id

String

Send Message Batch Result

Field Type Description Default Value Required

Failed

Successful

Send Message Batch Result Entry

Field Type Description Default Value Required

MD5 Of Message Attributes

String

MD5 Of Message Body

String

Id

String

Message Id

String

Send Message Batch Request Entry

Field Type Description Default Value Required

Delay Seconds

Number

Id

String

Message Attributes

Object

Message Body

String

Message Group Id

String