SQSAccess¶
SQS Access
- class awsimple.sqs.SQSAccess(queue_name: str, immediate_delete: bool = True, visibility_timeout: int | None = None, minimum_visibility_timeout: int = 0, auto_create: bool = False, **kwargs)¶
Bases:
AWSAccessSQS access
- Parameters:
queue_name – queue name
immediate_delete – True to immediately delete read message(s) upon receipt, False to require the user to call delete_message()
visibility_timeout – visibility timeout (if explicitly given) - set to None to automatically attempt to determine the timeout
minimum_visibility_timeout – visibility timeout will be at least this long (do not set if visibility_timeout set)
kwargs – kwargs to send to base class
- add_permission(source_arn: str)¶
allow source (e.g. SNS topic) to send to this SQS queue
- Parameters:
source_arn – source arn (e.g. SNS queue arn)
- calculate_nominal_work_time() float¶
- calculate_visibility_timeout() int¶
- create_queue() str | None¶
create SQS queue
- Returns:
queue URL or None if not successful
- delete_queue()¶
delete queue
- exists() bool¶
test if SQS queue exists
- Returns:
True if exists
- get_arn() str¶
get SQS ARN
- Returns:
ARN string
- messages_available() int¶
return number of messages available :return: number of messages available
- purge()¶
purge all messages in the queue
- receive_message() SQSMessage | None¶
receive SQS message from this queue :return: one SQSMessage if one available, else None
- receive_messages(max_messages: int | None = None) List[SQSMessage]¶
receive a (possibly empty) list of SQS messages from this queue
- Parameters:
max_messages – maximum number of messages to receive (None for all available messages)
- Returns:
list of messages
- send(message: str)¶
Send SQS message. If the queue doesn’t exist, it will be created.
- Parameters:
message – message string
- class awsimple.sqs.SQSMessage(message: str, _m: Any, _q: Any)¶
Bases:
objectSQS Message
- delete()¶
- get_aws_message()¶
- get_id()¶
- message: str¶
- class awsimple.sqs.SQSPollAccess(queue_name: str, **kwargs)¶
Bases:
SQSAccessSQS Access with long polling.
SQS access
- Parameters:
queue_name – queue name
immediate_delete – True to immediately delete read message(s) upon receipt, False to require the user to call delete_message()
visibility_timeout – visibility timeout (if explicitly given) - set to None to automatically attempt to determine the timeout
minimum_visibility_timeout – visibility timeout will be at least this long (do not set if visibility_timeout set)
kwargs – kwargs to send to base class
- awsimple.sqs.get_all_sqs_queues(prefix: str = '', **kwargs) List[str]¶
get all SQS queues
- Parameters:
prefix – prefix to filter queue names (empty string for all queues)
kwargs – kwargs for AWSAccess (e.g. profile_name, region_name) so the listing uses the same credentials as the caller
- Returns:
list of queue names