Skip to main content

Amazon SQS Distribution Channels

Receive real-time system notifications via Amazon SQS.

Jon Tam avatar
Written by Jon Tam
Updated over 2 years ago

You can receive new notifications via Amazon SQS. Follow the steps below to configure SQS for receiving update notifications and staying informed about the health and quality of your data.

You can configure as many SQS channels as you would like. When you add multiple SQS channels to a Notification Rule, you will receive multiple notifications, one per each SQS URL specified in the rule.


Create an SQS Distribution Channel

To create an SQS distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select SQS.

  3. Click on the Add new SQS channel button.

  4. Give your channel a unique Channel display name so you can later easily locate it.

  5. Provide SQS URL that identifies your SQS queue. To assure notification delivery, ensure the SQS URL is properly formatted and matches your cloud account.

  6. Provide Role ARN details, which is your Amazon Resource Name (ARN) for the queue where you want to receive SQS alerts. Role ARNs generally have one of the following formats.

    arn:partition:service:region:account-id:resource-id arn:partition:service:region:account-id:resource-type/resource-id arn:partition:service:region:account-id:resource-type:resource-id

  7. Click on the Add SQS button on the dialog to save the new SQS distribution channel.

To learn more about configuring Amazon SQS visit Identity and access management in Amazon SQS. Refer to the AWS IAM tutorial for more information about users and roles.

Edit an SQS Distribution Channel

To edit an SQS distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select SQS.

  3. Locate the SQS distribution channel you would like to modify.

  4. Click on the ... menu located at the end of the distribution channel row, and click on the ✏️ Edit option.

  5. Make changes. You have the flexibility to change the following:

    • Channel display name

    • SQS URL

    • Role ARN

  6. Click the Update button on the dialog to save your changes.

Enable and Disable an SQS Distribution Channel

To enable or disable an SQS distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select SQS.

  3. Locate the SQS distribution channel you would like to enable or disable.

  4. Modify the on/off toggle located next to the SQS distribution channel.

Delete an SQS Distribution Channel

To delete an SQS distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select SQS.

  3. Locate the SQS distribution channel you would like to delete.

  4. Click on the ... menu located at the end of the distribution channel row, and click on the Delete option. This action cannot be undone.

Troubleshooting SQS Distribution Channels

To delete an SQS distribution channel it should not be in use by any Notification Rules. If you attempt to delete an SQS distribution channel assigned to one or more Notification Rules, deleting the SQS channel will fail with the "Channel is currently assigned to one or more rules" error.

You have two alternatives to resolve this issue. Remove all dependencies on this SQS channel and substitute with alternative distribution channels, or remove the notification rules that depend on it.

Go to the Rules menu, and locate the notification rule(s) that use this SQS distribution channel. Substitute this SQS channel with an alternative distribution channel. You can select another SQS channel or an alternative protocol such as Pub/Sub, Webhook, or Email. Alternatively, you can delete all notification rules that use this SQS channel. After successfully removing notification rules that depend on this SQS channel, you will be able to delete it.


Closing Thoughts

You have to have an Editor or an Admin role to configure SQS Distribution Channels for data products in your organization.

See also:

Did this answer your question?