Amazon Simple Queue Service
Welcome to the Amazon SQS API Reference . Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the Amazon SQS API Reference .
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
between applications or microservices. Amazon SQS moves data between distributed application
components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer
Guide.
You can use Amazon Web Services SDKs to access
Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Product Page
Amazon SQS Developer Guide
Making API Requests
Amazon SQS Message Attributes
Amazon SQS Dead-Letter Queues
Amazon SQS in the Command Line Interface
Amazon Web Services General Reference
Regions and
Endpoints
Endpoints 23
- POSTAdd permission
/#X-Amz-Target=AmazonSQS.AddPermissionAdds a permission to a queue for a specific principal . This allows sharing access to the queue. When you create a queue, you have full control access rights… - POSTCancel message move task
/#X-Amz-Target=AmazonSQS.CancelMessageMoveTaskCancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task… - POSTChange message visibility
/#X-Amz-Target=AmazonSQS.ChangeMessageVisibilityChanges the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0… - POSTChange message visibility batch
/#X-Amz-Target=AmazonSQS.ChangeMessageVisibilityBatchChanges the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility . The result of the action on each message is reported… - POSTCreate queue
/#X-Amz-Target=AmazonSQS.CreateQueueCreates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind: If you don't specify the FifoQueue… - POSTDelete message
/#X-Amz-Target=AmazonSQS.DeleteMessageDeletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message ( not the MessageId which you… - POSTDelete message batch
/#X-Amz-Target=AmazonSQS.DeleteMessageBatchDeletes up to ten messages from the specified queue. This is a batch version of DeleteMessage . The result of the action on each message is reported… - POSTDelete queue
/#X-Amz-Target=AmazonSQS.DeleteQueueDeletes the queue specified by the QueueUrl , regardless of the queue's contents. Be careful with the DeleteQueue action: When you delete a queue, any… - POSTGet queue attributes
/#X-Amz-Target=AmazonSQS.GetQueueAttributesGets attributes for the specified queue. To determine whether a queue is FIFO , you can check whether QueueName ends with the .fifo suffix. - POSTGet queue url
/#X-Amz-Target=AmazonSQS.GetQueueUrlThe GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is useful when you know the queue's name but need to retrieve its URL for further… - POSTList dead letter source queues
/#X-Amz-Target=AmazonSQS.ListDeadLetterSourceQueuesReturns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue. The ListDeadLetterSourceQueues methods supports… - POSTList message move tasks
/#X-Amz-Target=AmazonSQS.ListMessageMoveTasksGets the most recent message movement tasks (up to 10) under a specific source queue. This action is currently limited to supporting message redrive from… - POSTList queue tags
/#X-Amz-Target=AmazonSQS.ListQueueTagsList all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .… - POSTList queues
/#X-Amz-Target=AmazonSQS.ListQueuesReturns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix… - POSTPurge queue
/#X-Amz-Target=AmazonSQS.PurgeQueueDeletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter. When you use the PurgeQueue action, you can't… - POSTReceive message
/#X-Amz-Target=AmazonSQS.ReceiveMessageRetrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see… - POSTRemove permission
/#X-Amz-Target=AmazonSQS.RemovePermissionRevokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of a queue can remove permissions from it.… - POSTSend message
/#X-Amz-Target=AmazonSQS.SendMessageDelivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more… - POSTSend message batch
/#X-Amz-Target=AmazonSQS.SendMessageBatchYou can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not… - POSTSet queue attributes
/#X-Amz-Target=AmazonSQS.SetQueueAttributesSets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the… - POSTStart message move task
/#X-Amz-Target=AmazonSQS.StartMessageMoveTaskStarts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting… - POSTTag queue
/#X-Amz-Target=AmazonSQS.TagQueueAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide . When you… - POSTUntag queue
/#X-Amz-Target=AmazonSQS.UntagQueueRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .…
API details
- Base URL
https://sqs.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 23 operations on 23 pathsPOST 23
- Description format
- AWS Smithy model, API version
2012-11-05 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Simple Queue Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Queue Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add permission” (POST /#X-Amz-Target=AmazonSQS.AddPermission), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Simple Queue Service?
Welcome to the Amazon SQS API Reference . Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or… It is listed under Developer tools and has 23 endpoints.
Who publishes the Amazon Simple Queue Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Simple Queue Service?
Requests go to https://sqs.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Simple Queue Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Simple Queue Service have?
23 operations on 23 paths (23 POST).
Is forking the Amazon Simple Queue Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.