ISQSSendMessageBatchRequestEntry

Interface in AWS.SQS

Batch entry interface for a SendMessageBatch request.

Properties

DelaySeconds

property DelaySeconds: TOptional<Integer>

The length of time, in seconds, for which to delay message delivery.

Valid values range from 0 to 900 seconds (15 minutes). Messages with a positive DelaySeconds value become available for processing after the delay period finishes. If not specified, the default delay value configured for the queue applies. For FIFO queues, this parameter can only be set at the queue level, not per message.

Id

property Id: string

An identifier for this message within the batch used to communicate the result.

The identifier must be unique within the batch request and can have up to 80 characters. Only alphanumeric characters, hyphens (-), and underscores (_) are accepted. This identifier is returned in the response to correlate successful and failed messages with their corresponding batch entries.

MessageAttributes

property MessageAttributes: TDictionary<string, ISQSMessageAttributeValue>

Type: ISQSMessageAttributeValue

Custom attributes to include with the message for application-specific metadata.

Each message attribute consists of a Name, Type, and Value. Message attributes enable applications to attach custom metadata to messages without modifying the message body. For more information about message attributes, see the Amazon SQS Developer Guide.

MessageBody

property MessageBody: string

The message content to send to the queue.

The message body must be between 1 character and 1 MiB (1,048,576 bytes) in size. Messages can include only XML, JSON, and unformatted text with specific Unicode characters. Allowed Unicode characters include: #x9, #xA, #xD, #x20 to #xD7FF, #xE000 to #xFFFD, and #x10000 to #x10FFFF.

MessageDeduplicationId

property MessageDeduplicationId: string

Token used for deduplication of messages in FIFO queues.

This parameter applies only to FIFO (first-in-first-out) queues. Messages with the same MessageDeduplicationId sent within the 5-minute deduplication interval are accepted but only delivered once. If not provided and ContentBasedDeduplication is enabled on the queue, Amazon SQS generates a SHA-256 hash of the message body as the deduplication ID. Maximum length is 128 characters. Valid characters include alphanumeric characters and punctuation: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~`

MessageGroupId

property MessageGroupId: string

Tag that specifies message group membership for ordering and fair queue processing.

For FIFO queues, messages within the same message group are processed in strict order, while messages in different groups may be processed concurrently. For standard queues, MessageGroupId enables fair queue behavior by identifying the tenant a message belongs to, ensuring consistent message dwell time across all tenants. Maximum length is 128 characters. Valid characters include alphanumeric characters and punctuation: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~`

MessageSystemAttributes

property MessageSystemAttributes: TDictionary<string, ISQSMessageSystemAttributeValue>

System attributes for AWS service integration, currently supporting AWS X-Ray tracing.

Currently, the only supported message system attribute is AWSTraceHeader for AWS X-Ray distributed tracing integration. The size of message system attributes does not count towards the total message size limit.

Methods

AddMessageAttribute

procedure AddMessageAttribute(const AName: string; const AMessageAttributeValue: ISQSMessageAttributeValue);

ISQSMessageAttributeValue

Add a name/value pair to MessageAttributes.

Parameters

Name	Description
AName	Specify the name of the message attribute to add to MessageAttributes.
AMessageAttributeValue	Specify a value for the message attribute to add to MessageAttributes.

AddMessageSystemAttribute

procedure AddMessageSystemAttribute(const AName: string; const AMessageSystemAttributeValue: ISQSMessageSystemAttributeValue);

Add a name/value pair to MessageSystemAttributes.

Parameters

Name	Description
AName	Specify the name of the message system attribute to add to MessageSystemAttributes.
AMessageSystemAttributeValue	Specify a value for the message system attribute to add to MessageSystemAttributes.