ReceiveMessage

Source: src/AWS/SQS/ReceiveMessage.ts

Runtime binding for sqs:ReceiveMessage.

Bind this operation to a Queue inside a function runtime to poll messages on demand. The binding grants the host function sqs:ReceiveMessage on the queue. Provide the ReceiveMessageHttp layer on the Function to implement the binding.

For push-based consumption (Lambda event-source mapping) use consumeQueueMessages instead of polling manually.

Receiving Messages

// init (provide SQS.ReceiveMessageHttp on the Function)
const receiveMessage = yield* SQS.ReceiveMessage(queue);

// runtime: long-poll for up to 10 messages
const result = yield* receiveMessage({
  MaxNumberOfMessages: 10,
  WaitTimeSeconds: 2,
});
for (const message of result.Messages ?? []) {
  // message.Body, message.ReceiptHandle
}