1. Using the Amazon Simple Queue Service (SQS) Adapter with Oracle Integration 3
  2. Add the Amazon Simple Queue Service (SQS) Adapter Connection to an Integration
  3. Invoke Configuration Page

Invoke Configuration Page

Enter the following details on the Configuration page.

List Dead Letter Source Queue, Delete Queue, Purge Queue, Tag Queue, Untag Queue, List Queue Tags, Delete Message, or Change Message Visibility Action

If you selected the List Dead Letter Source Queues, Delete Queue, Purge Queue, Tag Queue, Untag Queue, List Queue Tags, Delete Message, or Change Message Visibility action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.

Get Queue Attributes Action

If you selected the Get Queue Attributes action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.
Available Options

Displays a list of options for selection, such as Policy, Visibility Timeout, and so on.

Selected Options

Displays the list of options you have selected.

Set Queue Attributes Action

If you selected the Set Queue Attributes action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.
Configuration
  • Visibility Timeout: The period a message stays hidden from other consumers after retrieval from an Amazon SQS queue before becoming visible again for processing. The value should be between 0 to 43200 seconds.
  • Delivery Delay: The period between sending a message to an Amazon SQS queue and its availability for retrieval, allowing for scheduled delivery or time-sensitive processing. The value should be between 0 to 900 seconds.
  • Receive Message Wait Time: The maximum time an Amazon SQS client waits for messages to become available in a queue before returning an empty response, optimizing polling frequency and reducing unnecessary requests. The value should be between 0 to 20 seconds.
  • Message Retention Period: The duration for which messages are retained in an Amazon SQS queue before being automatically deleted. The value should be between 60 to 1209600 seconds.
  • Maximum Message Size: The largest allowable size, in bytes, for a single message that can be sent or received in an Amazon SQS queue. The value should be between 1024 to 2621444 bytes.
Access Policy

Provide a JSON access policy. For example:


{
  "Version": "<policy_version>",
  "Id": "<policy_ID>",
  "Statement": [
    {
      "Sid": "<statement_ID>",
      "Effect": "<allow_or_deny>",
      "Principal": {
        "AWS": "<AWS_account_ID>"
      },
      "Action": [
        "<action>"
      ],
      "Resource": "arn:aws:sqs:<region>:<AWS_account_ID>:<queue_name>"
    }
  ]
}
Redrive Allow Policy

Select the check box and choose an option from the following:

  • Allow All
  • By Queue
  • Deny All
Dead Letter Queue

Select the check box and specify a value for the following:

  • Queue Arn: Enter a dead queue type.
  • Max Receive Count: Enter a value between 1 and 1000.

Get Queue Url Action

If you selected the Get Queue Url action on the Basic Info page, the following options are displayed.

Element Description

Queue Name

The name of the queue whose URL must be fetched. A maximum of 80 characters is allowed. Valid values are alphanumeric characters, hyphens (-), and underscores (_ ).

Note: Queue URLs and names are case sensitive.

Queue Owner AWS AccountId

Displays the Amazon Web Services account ID of the account that created the queue.

Create Queue Action

If you selected Create Queue on the Basic Info page, the following options are displayed.

Element Description

Queue Name

Enter a name for the queue.
Type
Select the type of queue:
  • Standard
  • FIFO
Configuration
  • Visibility Timeout: The period a message stays hidden from other consumers after retrieval from an Amazon SQS queue before becoming visible again for processing. The value should be between 0 to 43200 seconds.
  • Delivery Delay: The period between sending a message to an Amazon SQS queue and its availability for retrieval, allowing for scheduled delivery or time-sensitive processing. The value should be between 0 to 900 seconds.
  • Receive Message Wait Time: The maximum time an Amazon SQS client waits for messages to become available in a queue before returning an empty response, optimizing polling frequency and reducing unnecessary requests. The value should be between 0 to 20 seconds.
  • Message Retention Period: The duration for which messages are retained in an Amazon SQS queue before being automatically deleted. The value should be between 60 to 1209600 seconds.
  • Maximum Message Size: The largest allowable size, in bytes, for a single message that can be sent or received in an Amazon SQS queue. The value should be between 1024 to 2621444 bytes.
Access Policy

Provide a JSON access policy. For example:


{
  "Version": "<policy_version>",
  "Id": "<policy_ID>",
  "Statement": [
    {
      "Sid": "<statement_ID>",
      "Effect": "<allow_or_deny>",
      "Principal": {
        "AWS": "<AWS_account_ID>"
      },
      "Action": [
        "<action>"
      ],
      "Resource": "arn:aws:sqs:<region>:<AWS_account_ID>:<queue_name>"
    }
  ]
}
Redrive Allow Policy

Select the check box and choose an option from the following:

  • Allow All
  • By Queue
  • Deny All
Dead Letter Queue

Select the check box and specify a value for the following:

  • Queue Arn: Enter a dead queue type.
  • Max Receive Count: Enter a value between 1 and 1000.

Receive Messages Action

If you selected the Receive Messages action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.

Select Format

Select XML or JSON as the format from the drop-down list.

Provide JSON Sample/Provide XML Sample

Based on the type of format selected, enter sample JSON or XML to describe the structure of data.
Enable decoding

Enable this feature to decode messages from base64 encoding, ensuring compatibility and integrity.
Configure Message Attributes Names

Configure the custom message attributes name. Click Add to add a custom message attributes name and description. Click Remove to remove the custom message attributes name.

Configure Message System Attribute Names
Select the check box and one or more options from the list.
  • Available Options: Displays a list of options for selection such as Policy, Visibility Timeout, and so on.
  • Selected Options: Displays the list of options you have selected.
Delete after Receive Message

When this attribute is enabled, the message is removed from the queue when it is successfully received and processed by a consumer. This process helps prevent the same message from being processed multiple times by different consumers.

Send Message Action

If you selected the Send Message action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.

Select Format

Select XML or JSON as the format from the drop-down list.

Provide XML namespace

This field appears only if you select the XML format.

Note: Only a single namespace is supported.

Provide JSON Sample/Provide XML Sample

Based on the type of format selected, enter sample JSON or XML to describe the structure of data.
Enable encoding

Enable this feature to encode messages using base64 for enhanced compatibility and integrity.
Configure Message Attributes

Configure the custom message attributes name. Click Add to add a custom message attributes name and description. Click Remove to remove the custom message attributes name.

List Message Move Tasks Action

If you selected the List Message Move Tasks action on the Basic Info page, the following options are displayed.

Element Description

Source ARN

Enter a dead letter source queue ARN.

Start Message Move Task Action

If you selected the Start Message Move Task action on the Basic Info page, the following options are displayed.

Element Description

Source ARN

Enter a dead letter source queue ARN.
Destination ARN

Enter a destination ARN.

Add Permission Action

If you selected the Add Permission action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.
Select Permissions
Select permissions from the following:
  • Send Message
  • Delete Message
  • Receive Message
  • Change Message Visibility
  • List Dead Letter Source Queues
  • Purge Queue
  • Get Queue Attributes
  • Get Queue Url

Remove Permission Action

If you selected the Remove Permission action on the Basic Info page, the following options are displayed.

Element Description

Select Queue

Select a specific queue from the list.