AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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).

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSendMessageBatch and EndSendMessageBatch.

Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<SendMessageBatchResponse> SendMessageBatchAsync(
         SendMessageBatchRequest request,
         CancellationToken cancellationToken
)
Parameters
request
Type: Amazon.SQS.Model.SendMessageBatchRequest

Container for the necessary parameters to execute the SendMessageBatch service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the SendMessageBatch service method, as returned by SQS.

Exceptions

ExceptionCondition
BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
BatchRequestTooLongException The length of all the messages put together is more than the limit.
EmptyBatchRequestException The batch request doesn't contain any entries.
InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
UnsupportedOperationException Error code 400. Unsupported operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also