SendMessageBatchRequestEntry Class

Contains the details of a single Amazon SQS message along with an Id.

Inheritance Hierarchy

System.Object
Amazon.SQS.Model.SendMessageBatchRequestEntry

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

Syntax

public class SendMessageBatchRequestEntry

The SendMessageBatchRequestEntry type exposes the following members

Constructors

	Name	Description
	SendMessageBatchRequestEntry()	Empty constructor used to set properties independently even when a simple constructor is available
	SendMessageBatchRequestEntry(string, string)	Instantiates SendMessageBatchRequestEntry with the parameterized properties

Properties

Name	Type	Description
DelaySeconds	System.Int32	Gets and sets the property DelaySeconds. The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive `DelaySeconds` value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied. When you set `FifoQueue`, you can't set `DelaySeconds` per message. You can set this parameter only on a queue level.
Id	System.String	Gets and sets the property Id. An identifier for a message in this batch used to communicate the result. The `Id`s of a batch request need to be unique within a request. This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
MessageAttributes	System.Collections.Generic.Dictionary<System.String, Amazon.SQS.Model.MessageAttributeValue>	Gets and sets the property MessageAttributes. Each message attribute consists of a `Name`, `Type`, and `Value`. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
MessageBody	System.String	Gets and sets the property MessageBody. The body of the message.
MessageDeduplicationId	System.String	Gets and sets the property MessageDeduplicationId. This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular `MessageDeduplicationId` is sent successfully, subsequent messages with the same `MessageDeduplicationId` are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Every message must have a unique `MessageDeduplicationId`, You may provide a `MessageDeduplicationId` explicitly. If you aren't able to provide a `MessageDeduplicationId` and you enable `ContentBasedDeduplication` for your queue, Amazon SQS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message). If you don't provide a `MessageDeduplicationId` and the queue doesn't have `ContentBasedDeduplication` set, the action fails with an error. If the queue has `ContentBasedDeduplication` set, your `MessageDeduplicationId` overrides the generated one. When `ContentBasedDeduplication` is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with `ContentBasedDeduplication` enabled and then another message with a `MessageDeduplicationId` that is the same as the one generated for the first `MessageDeduplicationId`, the two messages are treated as duplicates and only one copy of the message is delivered. The `MessageDeduplicationId` is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same `MessageDeduplicationId` after the deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of `MessageDeduplicationId` is 128 characters. `MessageDeduplicationId` can contain alphanumeric characters (`a-z`, `A-Z`, `0-9`) and punctuation (!"#$%&'()+,-./:;<=>?@[\]^_`{\|}~). For best practices of using `MessageDeduplicationId`, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide*.
MessageGroupId	System.String	Gets and sets the property MessageGroupId. This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use `MessageGroupId` values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty `MessageGroupId` with a message. If you don't provide a `MessageGroupId`, the action fails. `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the messages are sorted by time sent. The caller can't specify a `MessageGroupId`. The length of `MessageGroupId` is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()+,-./:;<=>?@[\]^_`{\|}~). For best practices of using `MessageGroupId`, see Using the MessageGroupId Property in the Amazon SQS Developer Guide*. `MessageGroupId` is required for FIFO queues. You can't use it for Standard queues.
MessageSystemAttributes	System.Collections.Generic.Dictionary<System.String, Amazon.SQS.Model.MessageSystemAttributeValue>	Gets and sets the property MessageSystemAttributes. The message system attribute to send Each message system attribute consists of a `Name`, `Type`, and `Value`. Currently, the only supported message system attribute is `AWSTraceHeader`. Its type must be `String` and its value must be a correctly formatted X-Ray trace header string. The size of a message system attribute doesn't count towards the total size of a message.

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<string, MessageAttributeValue>
  {
    {
      "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<string, MessageAttributeValue>
  {
    {
      "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<string, MessageAttributeValue>
  {
    {
      "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<SendMessageBatchRequestEntry>() { 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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5