sendMessageBatch method

Future<SendMessageBatchResult> sendMessageBatch({
  1. required List<SendMessageBatchRequestEntry> entries,
  2. required String queueUrl,
})

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

May throw TooManyEntriesInBatchRequest. May throw EmptyBatchRequest. May throw BatchEntryIdsNotDistinct. May throw BatchRequestTooLong. May throw InvalidBatchEntryId. May throw UnsupportedOperation.

Parameter entries : A list of SendMessageBatchRequestEntry items.

Parameter queueUrl : The URL of the Amazon SQS queue to which batched messages are sent.

Queue URLs and names are case-sensitive.

Implementation

Future<SendMessageBatchResult> sendMessageBatch({
  required List<SendMessageBatchRequestEntry> entries,
  required String queueUrl,
}) async {
  ArgumentError.checkNotNull(entries, 'entries');
  ArgumentError.checkNotNull(queueUrl, 'queueUrl');
  final $request = <String, dynamic>{};
  $request['Entries'] = entries;
  $request['QueueUrl'] = queueUrl;
  final $result = await _protocol.send(
    $request,
    action: 'SendMessageBatch',
    version: '2012-11-05',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['SendMessageBatchRequest'],
    shapes: shapes,
    resultWrapper: 'SendMessageBatchResult',
  );
  return SendMessageBatchResult.fromXml($result);
}