Amazon SQS

Frends.AmazonSQS.Receive / 2.0.0

Summary

Takes messages off an SQS queue, up to a requested count per call. Receiving is destructive in the usual queue sense, so a message a Process fails to handle needs its own retry path.

Typical use — draining a queue on a schedule, where the batch becomes the Process's unit of work

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0

Input parameters.

Name Type Default Example Description
QueueUrl String https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME} https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}

Queue url. Examples: https:///queue.|api-domain|//

MaxNumberOfMessages Int32 1 1

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Amazon does not provide an option to force an exact number of messages.

An unhandled error has occurred. Reload 🗙