AWS Code Sample
Catalog

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

receive_message.py

receive_message.py demonstrates how to retrieve messages from an Amazon SQS queue.

# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import logging import boto3 from botocore.exceptions import ClientError def retrieve_sqs_messages(sqs_queue_url, num_msgs=1, wait_time=0, visibility_time=5): """Retrieve messages from an SQS queue The retrieved messages are not deleted from the queue. :param sqs_queue_url: String URL of existing SQS queue :param num_msgs: Number of messages to retrieve (1-10) :param wait_time: Number of seconds to wait if no messages in queue :param visibility_time: Number of seconds to make retrieved messages hidden from subsequent retrieval requests :return: List of retrieved messages. If no messages are available, returned list is empty. If error, returns None. """ # Validate number of messages to retrieve if num_msgs < 1: num_msgs = 1 elif num_msgs > 10: num_msgs = 10 # Retrieve messages from an SQS queue sqs_client = boto3.client('sqs') try: msgs = sqs_client.receive_message(QueueUrl=sqs_queue_url, MaxNumberOfMessages=num_msgs, WaitTimeSeconds=wait_time, VisibilityTimeout=visibility_time) except ClientError as e: logging.error(e) return None # Return the list of retrieved messages return msgs['Messages'] def delete_sqs_message(sqs_queue_url, msg_receipt_handle): """Delete a message from an SQS queue :param sqs_queue_url: String URL of existing SQS queue :param msg_receipt_handle: Receipt handle value of retrieved message """ # Delete the message from the SQS queue sqs_client = boto3.client('sqs') sqs_client.delete_message(QueueUrl=sqs_queue_url, ReceiptHandle=msg_receipt_handle) def main(): """Exercise retrieve_sqs_messages()""" # Assign this value before running the program sqs_queue_url = 'SQS_QUEUE_URL' num_messages = 2 # Set up logging logging.basicConfig(level=logging.DEBUG, format='%(levelname)s: %(asctime)s: %(message)s') # Retrieve SQS messages msgs = retrieve_sqs_messages(sqs_queue_url, num_messages) if msgs is not None: for msg in msgs: logging.info(f'SQS: Message ID: {msg["MessageId"]}, ' f'Contents: {msg["Body"]}') # Remove the message from the queue delete_sqs_message(sqs_queue_url, msg['ReceiptHandle']) if __name__ == '__main__': main()

Sample Details

Service: sqs

Last tested: 2019-04-29

Author: AWS

Type: snippet

On this page: