SQSCLI is a desktop application we have developed to help AWS users to browse SQS messages and peak into SQS Queues
This is a GUI-based application designed to leverage your AWS CLI profile configured in your local system.
Here is a snapshot of the SQSCLI interface.
For higher security, we have designed this to use the AWS CLI profile available in your local system. So this makes AWS CLI as a prerequisite
Before moving on to the SQSCLI installation and configuration instructions. Let us take a quick look into all prerequisites
Prerequisites
- AWS Account with Programming Access - AWS Access Key
- IAM User with SQS privileges to list Queues and to read messages
- AWS CLI to be installed and configured on your local where you are going to launch SQSCLI (Mac/Windows)
How to create AWS Programming Access / Access Key
Creating AWS Accesskey is associated with the IAM user account creation.
If you already have an existing user in EC2 creating API Key and Secret is not a big deal.
Or you can create a new user and set it up.
Step1: Add a new user and key in the UserName
Click to view the image
Step2: Attach Existing Policies and Select Admin
Click to view the image
Let the Values be Default Click Next till you see the following Screen
Step3: Completion and Download
Click to view the image
How to install and configure AWS CLI
If you are new to AWS CLI. Please install and configure
- Installing AWS CLI version 2 on Linux or Unix
- Installing AWS CLI version 2 on macOS
- Installing AWS CLI version 2 on Windows
By default, AWS CLI would create a single profile named default
At times we might manage multiple AWS accounts using AWS CLI and have multiple profiles. It is known as a Named profile.
Read more about what is AWS CLI named profiles here
To check whether if you have AWS CLI installed on your local and to see the list of profiles, you can use the following commands
# aws – version # aws configure list-profiles
Quick Demo of SQSCLI
What could be better than a practical demo to understand the application? Here is the video of SQSCLI
We have made SQSCLI an OpenSource
After 100+ downloads and years of extensive usage. we decided to release the SQSCLI source code as open source to the public.
You can clone the repository or checkout the source code on the following GitHub repository
https://github.com/Gritfy/SQSCLI
Download the SQSCLI Community Edition - Executable
You can enter your email ID and receive Download link directly in your inbox
Why do we need your email ID ?
We are just collecting this email ID to confirm that you are human not some spammer or a robot. You can always choose to clone our github repo and build from source. if you do not want to share us your email ID
We do not sell your email ID or spam. this is just to stop bot downloads.
Send download link to:
If you like our product and want to support us, please consider buying us a coffee
FAQs
Would my messages be removed from the SQS?
No, your messages would not be deleted from the SQS once read through SQSCLI. The messages that have been read would go into the Transit state and be unavailable for the configured Visibility Timeout seconds.
SQSCLI does not perform any delete action so the messages in SQS are not deleted
Read more about Visibility Timeout here
Does SQSCLI use Short Polling or Long Polling?
SQSCLI use Long Polling to be able to read all the messages from the SQSCLI. Not just the sampled ones.
SQSCLI is configured with the maximum long polling wait time of 20 seconds
Read more about Short and Long polling here
How about data security? Does SQSCLI collect or send any data?
SQSCLI is designed with security best practices in mind, that's the reason we are not supporting the direct use of AWS Access Key and Secret and insisting users to setup AWS CLI and named profiles.
So SQSCLI does not collect or send any data externally.
is SQSCLI Free?
SQSCLI is free and Open Source and would remain the same
I get More or Fewer messages than what I asked for. What to do?
This is the known behaviour of SQS where we can read only 10 messages per API call. While SQSCLI tries its best to read the requested number of messages from SQS. The number of messages actually read from SQS would be less or more. Mostly more.
I get Exceptions sometimes. What to do?
We tried to address some of the known issues and we have kept descriptive alerts to let you know what went wrong. if you see an exception
There are a few things you can check from your end
- Is the number of messages in your queue is less than 1 or 2?
- Are you able to connect to SQS API using the AWS CLI profile you are using with SQSCLI?
- Is there any network issue that could prevent SQSCLI connect to AWS API
If you have checked everything and think it is a bug from our end.
please let us know at [email protected]
Who to contact for support or feedback regarding SQSCLI?
You can write to [email protected] for any queries or feedback regarding SQSCLI
You can also use the comments section on this post to reach out to us
Cheers
Sarav AK & Hanu
You can follow Hanumanth and Sarav on linked in
