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:

&Attribute.1=this

&Attribute.2=that

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to SendMessageBatchAsync.

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

Syntax

C#
public virtual SendMessageBatchResponse SendMessageBatch(
         SendMessageBatchRequest request
)
Parameters
request
Type: Amazon.SQS.Model.SendMessageBatchRequest

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

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.

Examples

This example shows how to send messages in batch.

Batch send messages example

var client = new AmazonSQSClient();

var entry1 = new SendMessageBatchRequestEntry
{
  DelaySeconds = 0,
  Id = "Entry1",
  MessageAttributes = new Dictionary
  {
    {
      "MyNameAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "John Doe" }
    },
    {
      "MyAddressAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "123 Main St." }
    },
    {
      "MyRegionAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "Any Town, United States" }
    }
  },
  MessageBody = "John Doe customer information."
};

var entry2 = new SendMessageBatchRequestEntry
{
  DelaySeconds = 0,
  Id = "Entry2",
  MessageAttributes = new Dictionary
  {
    {
      "MyNameAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "Jane Doe" }
    },
    {
      "MyAddressAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "456 Center Road" }
    },
    {
      "MyRegionAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "Any City, United States" }
    }
  },
  MessageBody = "Jane Doe customer information."
};

var entry3 = new SendMessageBatchRequestEntry
{
  DelaySeconds = 0,
  Id = "Entry3",
  MessageAttributes = new Dictionary
  {
    {
      "MyNameAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "Richard Doe" }
    },
    {
      "MyAddressAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "789 East Blvd." }
    },
    {
      "MyRegionAttribute", new MessageAttributeValue 
        { DataType = "String", StringValue = "Anywhere, United States" }
    }
  },
  MessageBody = "Richard Doe customer information."
};

var request = new SendMessageBatchRequest
{
  Entries = new List() { entry1, entry2, entry3 },
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue"
};

var response = client.SendMessageBatch(request);

if (response.Successful.Count > 0)
{
  Console.WriteLine("Successfully sent:");

  foreach (var success in response.Successful)
  {
    Console.WriteLine("  For ID: '" + success.Id + "':");
    Console.WriteLine("    Message ID = " + success.MessageId);
    Console.WriteLine("    MD5 of message attributes = " +
      success.MD5OfMessageAttributes);
    Console.WriteLine("    MD5 of message body = " +
      success.MD5OfMessageBody);
  }
}

if (response.Failed.Count > 0)
{
  Console.WriteLine("Failed to be sent:");

  foreach (var fail in response.Failed)
  {
    Console.WriteLine("  For ID '" + fail.Id + "':");
    Console.WriteLine("    Code = " + fail.Code);
    Console.WriteLine("    Message = " + fail.Message);
    Console.WriteLine("    Sender's fault? = " +
      fail.SenderFault);
  }
}
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also