# Data Types
<a name="API_Types"></a>

The Amazon Simple Queue Service API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [BatchResultErrorEntry](API_BatchResultErrorEntry.md) 
+  [ChangeMessageVisibilityBatchRequestEntry](API_ChangeMessageVisibilityBatchRequestEntry.md) 
+  [ChangeMessageVisibilityBatchResultEntry](API_ChangeMessageVisibilityBatchResultEntry.md) 
+  [DeleteMessageBatchRequestEntry](API_DeleteMessageBatchRequestEntry.md) 
+  [DeleteMessageBatchResultEntry](API_DeleteMessageBatchResultEntry.md) 
+  [ListMessageMoveTasksResultEntry](API_ListMessageMoveTasksResultEntry.md) 
+  [Message](API_Message.md) 
+  [MessageAttributeValue](API_MessageAttributeValue.md) 
+  [MessageSystemAttributeValue](API_MessageSystemAttributeValue.md) 
+  [SendMessageBatchRequestEntry](API_SendMessageBatchRequestEntry.md) 
+  [SendMessageBatchResultEntry](API_SendMessageBatchResultEntry.md) 

# BatchResultErrorEntry
<a name="API_BatchResultErrorEntry"></a>

Gives a detailed description of the result of an action on each entry in the request.

## Contents
<a name="API_BatchResultErrorEntry_Contents"></a>

 ** Code **   <a name="SQS-Type-BatchResultErrorEntry-Code"></a>
An error code representing why the action failed on this entry.  
Type: String  
Required: Yes

 ** Id **   <a name="SQS-Type-BatchResultErrorEntry-Id"></a>
The `Id` of an entry in a batch request.  
Type: String  
Required: Yes

 ** SenderFault **   <a name="SQS-Type-BatchResultErrorEntry-SenderFault"></a>
Specifies whether the error happened due to the caller of the batch API action.  
Type: Boolean  
Required: Yes

 ** Message **   <a name="SQS-Type-BatchResultErrorEntry-Message"></a>
A message explaining why the action failed on this entry.  
Type: String  
Required: No

## See Also
<a name="API_BatchResultErrorEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/BatchResultErrorEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/BatchResultErrorEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/BatchResultErrorEntry) 

# ChangeMessageVisibilityBatchRequestEntry
<a name="API_ChangeMessageVisibilityBatchRequestEntry"></a>

Encloses a receipt handle and an entry ID for each message in ` ChangeMessageVisibilityBatch.` 

## Contents
<a name="API_ChangeMessageVisibilityBatchRequestEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-ChangeMessageVisibilityBatchRequestEntry-Id"></a>
An identifier for this particular receipt handle 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 (\$1).
Type: String  
Required: Yes

 ** ReceiptHandle **   <a name="SQS-Type-ChangeMessageVisibilityBatchRequestEntry-ReceiptHandle"></a>
A receipt handle.  
Type: String  
Required: Yes

 ** VisibilityTimeout **   <a name="SQS-Type-ChangeMessageVisibilityBatchRequestEntry-VisibilityTimeout"></a>
The new value (in seconds) for the message's visibility timeout.  
Type: Integer  
Required: No

## See Also
<a name="API_ChangeMessageVisibilityBatchRequestEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/ChangeMessageVisibilityBatchRequestEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/ChangeMessageVisibilityBatchRequestEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/ChangeMessageVisibilityBatchRequestEntry) 

# ChangeMessageVisibilityBatchResultEntry
<a name="API_ChangeMessageVisibilityBatchResultEntry"></a>

Encloses the `Id` of an entry in ` ChangeMessageVisibilityBatch.` 

## Contents
<a name="API_ChangeMessageVisibilityBatchResultEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-ChangeMessageVisibilityBatchResultEntry-Id"></a>
Represents a message whose visibility timeout has been changed successfully.  
Type: String  
Required: Yes

## See Also
<a name="API_ChangeMessageVisibilityBatchResultEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/ChangeMessageVisibilityBatchResultEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/ChangeMessageVisibilityBatchResultEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/ChangeMessageVisibilityBatchResultEntry) 

# DeleteMessageBatchRequestEntry
<a name="API_DeleteMessageBatchRequestEntry"></a>

Encloses a receipt handle and an identifier for it.

## Contents
<a name="API_DeleteMessageBatchRequestEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-DeleteMessageBatchRequestEntry-Id"></a>
The identifier for this particular receipt handle. This is 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 (\$1).
Type: String  
Required: Yes

 ** ReceiptHandle **   <a name="SQS-Type-DeleteMessageBatchRequestEntry-ReceiptHandle"></a>
A receipt handle.  
Type: String  
Required: Yes

## See Also
<a name="API_DeleteMessageBatchRequestEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/DeleteMessageBatchRequestEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/DeleteMessageBatchRequestEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/DeleteMessageBatchRequestEntry) 

# DeleteMessageBatchResultEntry
<a name="API_DeleteMessageBatchResultEntry"></a>

Encloses the `Id` of an entry in ` DeleteMessageBatch.` 

## Contents
<a name="API_DeleteMessageBatchResultEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-DeleteMessageBatchResultEntry-Id"></a>
Represents a successfully deleted message.  
Type: String  
Required: Yes

## See Also
<a name="API_DeleteMessageBatchResultEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/DeleteMessageBatchResultEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/DeleteMessageBatchResultEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/DeleteMessageBatchResultEntry) 

# ListMessageMoveTasksResultEntry
<a name="API_ListMessageMoveTasksResultEntry"></a>

Contains the details of a message movement task. 

## Contents
<a name="API_ListMessageMoveTasksResultEntry_Contents"></a>

 ** ApproximateNumberOfMessagesMoved **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-ApproximateNumberOfMessagesMoved"></a>
The approximate number of messages already moved to the destination queue.  
Type: Long  
Required: No

 ** ApproximateNumberOfMessagesToMove **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-ApproximateNumberOfMessagesToMove"></a>
The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.  
Type: Long  
Required: No

 ** DestinationArn **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-DestinationArn"></a>
The ARN of the destination queue if it has been specified in the `StartMessageMoveTask` request. If a `DestinationArn` has not been specified in the `StartMessageMoveTask` request, this field value will be NULL.  
Type: String  
Required: No

 ** FailureReason **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-FailureReason"></a>
The task failure reason (only included if the task status is FAILED).  
Type: String  
Required: No

 ** MaxNumberOfMessagesPerSecond **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-MaxNumberOfMessagesPerSecond"></a>
The number of messages to be moved per second (the message movement rate), if it has been specified in the `StartMessageMoveTask` request. If a `MaxNumberOfMessagesPerSecond` has not been specified in the `StartMessageMoveTask` request, this field value will be NULL.  
Type: Integer  
Required: No

 ** SourceArn **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-SourceArn"></a>
The ARN of the queue that contains the messages to be moved to another queue.  
Type: String  
Required: No

 ** StartedTimestamp **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-StartedTimestamp"></a>
The timestamp of starting the message movement task.  
Type: Long  
Required: No

 ** Status **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-Status"></a>
The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.  
Type: String  
Required: No

 ** TaskHandle **   <a name="SQS-Type-ListMessageMoveTasksResultEntry-TaskHandle"></a>
An identifier associated with a message movement task. When this field is returned in the response of the `ListMessageMoveTasks` action, it is only populated for tasks that are in RUNNING status.  
Type: String  
Required: No

## See Also
<a name="API_ListMessageMoveTasksResultEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/ListMessageMoveTasksResultEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/ListMessageMoveTasksResultEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/ListMessageMoveTasksResultEntry) 

# Message
<a name="API_Message"></a>

An Amazon SQS message.

## Contents
<a name="API_Message_Contents"></a>

 ** Attributes **   <a name="SQS-Type-Message-Attributes"></a>
A map of the attributes requested in ` ReceiveMessage ` to their respective values. Supported attributes:  
+  `ApproximateReceiveCount` 
+  `ApproximateFirstReceiveTimestamp` 
+  `MessageDeduplicationId` 
+  `MessageGroupId` 
+  `SenderId` 
+  `SentTimestamp` 
+  `SequenceNumber` 
 `ApproximateFirstReceiveTimestamp` and `SentTimestamp` are each returned as an integer representing the [epoch time](http://en.wikipedia.org/wiki/Unix_time) in milliseconds.  
Type: String to string map  
Valid Keys: `All | SenderId | SentTimestamp | ApproximateReceiveCount | ApproximateFirstReceiveTimestamp | SequenceNumber | MessageDeduplicationId | MessageGroupId | AWSTraceHeader | DeadLetterQueueSourceArn`   
Required: No

 ** Body **   <a name="SQS-Type-Message-Body"></a>
The message's contents (not URL-encoded).  
Type: String  
Required: No

 ** MD5OfBody **   <a name="SQS-Type-Message-MD5OfBody"></a>
An MD5 digest of the non-URL-encoded message body string.  
Type: String  
Required: No

 ** MD5OfMessageAttributes **   <a name="SQS-Type-Message-MD5OfMessageAttributes"></a>
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see [RFC1321](https://www.ietf.org/rfc/rfc1321.txt).  
Type: String  
Required: No

 ** MessageAttributes **   <a name="SQS-Type-Message-MessageAttributes"></a>
Each message attribute consists of a `Name`, `Type`, and `Value`. For more information, see [Amazon SQS message attributes](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) in the *Amazon SQS Developer Guide*.  
Type: String to [MessageAttributeValue](API_MessageAttributeValue.md) object map  
Required: No

 ** MessageId **   <a name="SQS-Type-Message-MessageId"></a>
A unique identifier for the message. A `MessageId`is considered unique across all AWS accounts for an extended period of time.  
Type: String  
Required: No

 ** ReceiptHandle **   <a name="SQS-Type-Message-ReceiptHandle"></a>
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.  
Type: String  
Required: No

## See Also
<a name="API_Message_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/Message) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/Message) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/Message) 

# MessageAttributeValue
<a name="API_MessageAttributeValue"></a>

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 (1 MiB or 1,048,576 bytes).

## Contents
<a name="API_MessageAttributeValue_Contents"></a>

 ** DataType **   <a name="SQS-Type-MessageAttributeValue-DataType"></a>
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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) in the *Amazon SQS Developer Guide*.  
Type: String  
Required: Yes

 ** BinaryListValues **   <a name="SQS-Type-MessageAttributeValue-BinaryListValues"></a>
Not implemented. Reserved for future use.  
Type: Array of Base64-encoded binary data objects  
Required: No

 ** BinaryValue **   <a name="SQS-Type-MessageAttributeValue-BinaryValue"></a>
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.  
Type: Base64-encoded binary data object  
Required: No

 ** StringListValues **   <a name="SQS-Type-MessageAttributeValue-StringListValues"></a>
Not implemented. Reserved for future use.  
Type: Array of strings  
Required: No

 ** StringValue **   <a name="SQS-Type-MessageAttributeValue-StringValue"></a>
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see [ASCII Printable Characters](http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).  
Type: String  
Required: No

## See Also
<a name="API_MessageAttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/MessageAttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/MessageAttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/MessageAttributeValue) 

# MessageSystemAttributeValue
<a name="API_MessageSystemAttributeValue"></a>

The user-specified message system 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.

## Contents
<a name="API_MessageSystemAttributeValue_Contents"></a>

 ** DataType **   <a name="SQS-Type-MessageSystemAttributeValue-DataType"></a>
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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) in the *Amazon SQS Developer Guide*.  
Type: String  
Required: Yes

 ** BinaryListValues **   <a name="SQS-Type-MessageSystemAttributeValue-BinaryListValues"></a>
Not implemented. Reserved for future use.  
Type: Array of Base64-encoded binary data objects  
Required: No

 ** BinaryValue **   <a name="SQS-Type-MessageSystemAttributeValue-BinaryValue"></a>
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.  
Type: Base64-encoded binary data object  
Required: No

 ** StringListValues **   <a name="SQS-Type-MessageSystemAttributeValue-StringListValues"></a>
Not implemented. Reserved for future use.  
Type: Array of strings  
Required: No

 ** StringValue **   <a name="SQS-Type-MessageSystemAttributeValue-StringValue"></a>
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see [ASCII Printable Characters](http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).  
Type: String  
Required: No

## See Also
<a name="API_MessageSystemAttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/MessageSystemAttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/MessageSystemAttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/MessageSystemAttributeValue) 

# SendMessageBatchRequestEntry
<a name="API_SendMessageBatchRequestEntry"></a>

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

## Contents
<a name="API_SendMessageBatchRequestEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-SendMessageBatchRequestEntry-Id"></a>
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 (\$1).
Type: String  
Required: Yes

 ** MessageBody **   <a name="SQS-Type-SendMessageBatchRequestEntry-MessageBody"></a>
The body of the message.  
Type: String  
Required: Yes

 ** DelaySeconds **   <a name="SQS-Type-SendMessageBatchRequestEntry-DelaySeconds"></a>
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.
Type: Integer  
Required: No

 ** MessageAttributes **   <a name="SQS-Type-SendMessageBatchRequestEntry-MessageAttributes"></a>
Each message attribute consists of a `Name`, `Type`, and `Value`. For more information, see [Amazon SQS message attributes](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) in the *Amazon SQS Developer Guide*.  
Type: String to [MessageAttributeValue](API_MessageAttributeValue.md) object map  
Required: No

 ** MessageDeduplicationId **   <a name="SQS-Type-SendMessageBatchRequestEntry-MessageDeduplicationId"></a>
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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide*.  
Type: String  
Required: No

 ** MessageGroupId **   <a name="SQS-Type-SendMessageBatchRequestEntry-MessageGroupId"></a>
 `MessageGroupId` is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues, `MessageGroupId` organizes messages into distinct groups. Messages within the same message group are always processed one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In standard queues, using `MessageGroupId` enables fair queues. It is used to identify the tenant a message belongs to, helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues, messages with the same `MessageGroupId` can be processed in parallel, maintaining the high throughput of standard queues.  
+  **FIFO queues:** `MessageGroupId` acts as 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.

  If you do not provide a `MessageGroupId` when sending a message to a FIFO queue, the action fails.

   `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the messages are sorted by time sent.
+  **Standard queues:**Use `MessageGroupId` in standard queues to enable fair queues. The `MessageGroupId` identifies the tenant a message belongs to. A tenant can be any entity that shares a queue with others, such as your customer, a client application, or a request type. When one tenant sends a disproportionately large volume of messages or has messages that require longer processing time, fair queues ensure other tenants' messages maintain low dwell time. This preserves quality of service for all tenants while maintaining the scalability and throughput of standard queues. We recommend that you include a `MessageGroupId` in all messages when using fair queues.
The length of `MessageGroupId` is 128 characters. Valid values: alphanumeric characters and punctuation `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.  
For best practices of using `MessageGroupId`, see [Using the MessageGroupId Property](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) in the *Amazon SQS Developer Guide*.  
Type: String  
Required: No

 ** MessageSystemAttributes **   <a name="SQS-Type-SendMessageBatchRequestEntry-MessageSystemAttributes"></a>
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 AWS X-Ray trace header string.
+ The size of a message system attribute doesn't count towards the total size of a message.
Type: String to [MessageSystemAttributeValue](API_MessageSystemAttributeValue.md) object map  
Valid Keys: `AWSTraceHeader`   
Required: No

## See Also
<a name="API_SendMessageBatchRequestEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/SendMessageBatchRequestEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/SendMessageBatchRequestEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/SendMessageBatchRequestEntry) 

# SendMessageBatchResultEntry
<a name="API_SendMessageBatchResultEntry"></a>

Encloses a `MessageId` for a successfully-enqueued message in a ` SendMessageBatch.` 

## Contents
<a name="API_SendMessageBatchResultEntry_Contents"></a>

 ** Id **   <a name="SQS-Type-SendMessageBatchResultEntry-Id"></a>
An identifier for the message in this batch.  
Type: String  
Required: Yes

 ** MD5OfMessageBody **   <a name="SQS-Type-SendMessageBatchResultEntry-MD5OfMessageBody"></a>
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see [RFC1321](https://www.ietf.org/rfc/rfc1321.txt).  
Type: String  
Required: Yes

 ** MessageId **   <a name="SQS-Type-SendMessageBatchResultEntry-MessageId"></a>
An identifier for the message.  
Type: String  
Required: Yes

 ** MD5OfMessageAttributes **   <a name="SQS-Type-SendMessageBatchResultEntry-MD5OfMessageAttributes"></a>
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see [RFC1321](https://www.ietf.org/rfc/rfc1321.txt).  
Type: String  
Required: No

 ** MD5OfMessageSystemAttributes **   <a name="SQS-Type-SendMessageBatchResultEntry-MD5OfMessageSystemAttributes"></a>
An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see [RFC1321](https://www.ietf.org/rfc/rfc1321.txt).  
Type: String  
Required: No

 ** SequenceNumber **   <a name="SQS-Type-SendMessageBatchResultEntry-SequenceNumber"></a>
This parameter applies only to FIFO (first-in-first-out) queues.  
The large, non-consecutive number that Amazon SQS assigns to each message.  
The length of `SequenceNumber` is 128 bits. As `SequenceNumber` continues to increase for a particular `MessageGroupId`.  
Type: String  
Required: No

## See Also
<a name="API_SendMessageBatchResultEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sqs-2012-11-05/SendMessageBatchResultEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sqs-2012-11-05/SendMessageBatchResultEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sqs-2012-11-05/SendMessageBatchResultEntry)