Skip to main content

ISQSMessageAttributeValue

Interface in AWS.SQS

Interface for SQS MessageAttributeValue.

Properties​

DataType​

property DataType: string

The data type of the message attribute value.

This field specifies how the value should be interpreted and processed. The data type consists of a type identifier and an optional custom type label. Supported data types include:

  • String – A Unicode string value
  • Number – A numeric value stored as a string
  • Binary – Binary data encoded as Base64
  • String.Custom – A string with custom type label (e.g., String.JSON)
  • Number.Custom – A number with custom type label (e.g., Number.int)
  • Binary.Custom – Binary data with custom type label (e.g., Binary.jpeg) Custom type labels allow you to provide additional semantic information about the data format, helping consumers understand how to process the attribute value appropriately. The data type is case-sensitive and must match exactly when sending and receiving messages.

BinaryListValues​

property BinaryListValues: TList<TBytes>

A collection of binary values for the message attribute.

Used when the message attribute contains multiple binary values. Each item in the collection is treated as a separate binary value, all encoded using Base64 during transmission. This field is used for scenarios where you need to send multiple related binary objects as part of a single message attribute. The total size of all binary values combined cannot exceed 1,024 KB. Each individual binary value is Base64-encoded independently.

BinaryValue​

property BinaryValue: TBytes

The binary value of the message attribute.

Used for Binary data types. Contains binary data that will be Base64-encoded when transmitted over the wire. Binary values can contain any binary data including images, serialized objects, encrypted data, or compressed content. Maximum size is 1,024 KB. This field is mutually exclusive with StringValue. Only one value field should be populated based on the specified DataType. For custom binary types (e.g., Binary.jpeg, Binary.pdf), the binary content should match the format specified by the custom type label. Amazon SQS handles the Base64 encoding/decoding automatically during message transmission.

StringListValues​

property StringListValues: TList<string>

A collection of string values for the message attribute.

Used when the message attribute contains multiple string values. Each item in the collection is treated as a separate string value. This field is commonly used for scenarios such as:

  • Lists of tags or categories
  • Multiple identifiers or reference numbers
  • Collections of related text values
  • Multiple recipients or routing destinations The total size of all string values combined cannot exceed 1,024 KB. Each string value can contain any valid Unicode characters.

StringValue​

property StringValue: string

The string value of the message attribute.

Used for String and Number data types. For string attributes, this contains the actual Unicode string value. For number attributes, this contains the numeric value represented as a string. String values can contain any valid Unicode characters and have a maximum length of 1,024 KB. Number values must be valid numeric representations (integers, floating-point, or scientific notation). This field is mutually exclusive with BinaryValue. Only one value field should be populated based on the specified DataType. For custom string types (e.g., String.JSON), the string value should conform to the format implied by the custom type label.