MessageAttributeValue Class | AWS SDK for .NET Version 4

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KiB or 262,144 bytes).

Inheritance Hierarchy

System.Object
Amazon.SQS.Model.MessageAttributeValue

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

Syntax

public class MessageAttributeValue

The MessageAttributeValue type exposes the following members

Constructors

	Name	Description
	MessageAttributeValue()

Properties

Name	Type	Description
BinaryListValues	System.Collections.Generic.List<System.IO.MemoryStream>	Gets and sets the property BinaryListValues. Not implemented. Reserved for future use. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
BinaryValue	System.IO.MemoryStream	Gets and sets the property BinaryValue. Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
DataType	System.String	Gets and sets the property DataType. Amazon SQS supports the following logical data types: `String`, `Number`, and `Binary`. For the `Number` data type, you must use `StringValue`. You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
StringListValues	System.Collections.Generic.List<System.String>	Gets and sets the property StringListValues. Not implemented. Reserved for future use. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
StringValue	System.String	Gets and sets the property StringValue. Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

Examples

This example shows how to send a message.

Send message example

    var client = new AmazonSQSClient();

    var request = new SendMessageRequest
    {
        DelaySeconds = (int)TimeSpan.FromSeconds(5).TotalSeconds,
        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.",
        QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue"
    };

    var response = await client.SendMessageAsync(request);

    Console.WriteLine("For message ID '" + response.MessageId + "':");
    Console.WriteLine("  MD5 of message attributes: " +
      response.MD5OfMessageAttributes);
    Console.WriteLine("  MD5 of message body: " + response.MD5OfMessageBody);

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer