Documentation updates for Amazon SQS fair queues feature.

Author: aws-sdk-dotnet-automation

generator/ServiceModels/sqs/sqs-2012-11-05.api.json

@@ -2,8 +2,7 @@
   "version":"2.0",
   "metadata":{
     "apiVersion":"2012-11-05",
-    "awsQueryCompatible":{
-    },
+    "awsQueryCompatible":{},
     "endpointPrefix":"sqs",
     "jsonVersion":"1.0",
     "protocol":"json",
@@ -725,8 +724,7 @@
     },
     "InvalidIdFormat":{
       "type":"structure",
-      "members":{
-      },
+      "members":{},
       "deprecated":true,
       "deprecatedMessage":"exception has been included in ReceiptHandleIsInvalid",
       "exception":true
@@ -930,8 +928,7 @@
     },
     "MessageNotInflight":{
       "type":"structure",
-      "members":{
-      },
+      "members":{},
       "exception":true
     },
     "MessageSystemAttributeList":{

generator/ServiceModels/sqs/sqs-2012-11-05.docs.json

@@ -1,5 +1,4 @@
 {
   "version": "1.0",
-  "examples": {
-  }
+  "examples": {}
 }

generator/ServiceModels/sqs/sqs-2012-11-05.examples.json

@@ -45,7 +45,7 @@ namespace Amazon.SQS.Model
     /// standard queue into a FIFO queue. You must either create a new FIFO queue for your
     /// application or delete your existing standard queue and recreate it as a FIFO queue.
     /// For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving">Moving
-    /// From a Standard Queue to a FIFO Queue</a> in the <i>Amazon SQS Developer Guide</i>.
+    /// From a standard queue to a FIFO queue</a> in the <i>Amazon SQS Developer Guide</i>.
     /// 
     /// </para>
     ///  </note> </li> <li> 

generator/ServiceModels/sqs/sqs-2012-11-05.normal.json

@@ -181,8 +181,7 @@ public ReceiveMessageRequest(string queueUrl)
         ///  </li> <li> 
         /// <para>
         ///  <c>MessageGroupId</c> – Returns the value provided by the producer that calls the
-        /// <c> <a>SendMessage</a> </c> action. Messages with the same <c>MessageGroupId</c> are
-        /// returned in sequence.
+        /// <c> <a>SendMessage</a> </c> action. 
         /// </para>
         ///  </li> <li> 
         /// <para>
@@ -328,8 +327,7 @@ internal bool IsSetMessageAttributeNames()
         ///  </li> <li> 
         /// <para>
         ///  <c>MessageGroupId</c> – Returns the value provided by the producer that calls the
-        /// <c> <a>SendMessage</a> </c> action. Messages with the same <c>MessageGroupId</c> are
-        /// returned in sequence.
+        /// <c> <a>SendMessage</a> </c> action.
         /// </para>
         ///  </li> <li> 
         /// <para>
@@ -424,8 +422,8 @@ internal bool IsSetQueueUrl()
         /// <para>
         /// While messages with a particular <c>MessageGroupId</c> are invisible, no more messages
         /// belonging to the same <c>MessageGroupId</c> are returned until the visibility timeout
-        /// expires. You can still receive messages with another <c>MessageGroupId</c> as long
-        /// as it is also visible.
+        /// expires. You can still receive messages with another <c>MessageGroupId</c> from your
+        /// FIFO queue as long as they are visible.
         /// </para>
         ///  </li> <li> 
         /// <para>

sdk/src/Services/SQS/Generated/Model/CreateQueueRequest.cs

@@ -64,9 +64,9 @@ namespace Amazon.SQS.Model
     ///  
     /// <para>
     /// Amazon SQS does not throw an exception or completely reject the message if it contains
-    /// invalid characters. Instead, it replaces those invalid characters with <c>U+FFFD</c>
-    /// before storing the message in the queue, as long as the message body contains at least
-    /// one valid character.
+    /// invalid characters. Instead, it replaces those invalid characters with U+FFFD before
+    /// storing the message in the queue, as long as the message body contains at least one
+    /// valid character.
     /// </para>
     ///  </important> 
     /// <para>

sdk/src/Services/SQS/Generated/Model/ReceiveMessageRequest.cs

@@ -246,27 +246,47 @@ internal bool IsSetMessageDeduplicationId()
         /// <summary>
         /// Gets and sets the property MessageGroupId. 
         /// <para>
-        /// This parameter applies only to FIFO (first-in-first-out) queues.
+        ///  <c>MessageGroupId</c> is an attribute used in Amazon SQS FIFO (First-In-First-Out)
+        /// and standard queues. In FIFO queues, <c>MessageGroupId</c> 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 <c>MessageGroupId</c> 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 <c>MessageGroupId</c> can be processed in parallel, maintaining
+        /// the high throughput of standard queues.
+        /// </para>
+        ///  <ul> <li> 
+        /// <para>
+        ///  <b>FIFO queues:</b> <c>MessageGroupId</c> 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 <c>MessageGroupId</c> 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.
         /// </para>
         ///  
         /// <para>
-        /// 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 <c>MessageGroupId</c> 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 <c>MessageGroupId</c> when sending a message to a FIFO queue,
+        /// the action fails.
         /// </para>
-        ///  <ul> <li> 
+        ///  
         /// <para>
-        /// You must associate a non-empty <c>MessageGroupId</c> with a message. If you don't
-        /// provide a <c>MessageGroupId</c>, the action fails.
+        ///  <c>ReceiveMessage</c> might return messages with multiple <c>MessageGroupId</c> values.
+        /// For each <c>MessageGroupId</c>, the messages are sorted by time sent.
         /// </para>
         ///  </li> <li> 
         /// <para>
-        ///  <c>ReceiveMessage</c> might return messages with multiple <c>MessageGroupId</c> values.
-        /// For each <c>MessageGroupId</c>, the messages are sorted by time sent. The caller can't
-        /// specify a <c>MessageGroupId</c>.
+        ///  <b>Standard queues:</b>Use <c>MessageGroupId</c> in standard queues to enable fair
+        /// queues. The <c>MessageGroupId</c> 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 <c>MessageGroupId</c> in all messages when using fair
+        /// queues.
         /// </para>
         ///  </li> </ul> 
         /// <para>
@@ -278,12 +298,6 @@ internal bool IsSetMessageDeduplicationId()
         /// For best practices of using <c>MessageGroupId</c>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using
         /// the MessageGroupId Property</a> in the <i>Amazon SQS Developer Guide</i>.
         /// </para>
-        ///  <important> 
-        /// <para>
-        ///  <c>MessageGroupId</c> is required for FIFO queues. You can't use it for Standard
-        /// queues.
-        /// </para>
-        ///  </important>
         /// </summary>
         public string MessageGroupId
         {

sdk/src/Services/SQS/Generated/Model/SendMessageBatchRequest.cs

@@ -47,9 +47,9 @@ namespace Amazon.SQS.Model
     ///  
     /// <para>
     /// Amazon SQS does not throw an exception or completely reject the message if it contains
-    /// invalid characters. Instead, it replaces those invalid characters with <c>U+FFFD</c>
-    /// before storing the message in the queue, as long as the message body contains at least
-    /// one valid character.
+    /// invalid characters. Instead, it replaces those invalid characters with U+FFFD before
+    /// storing the message in the queue, as long as the message body contains at least one
+    /// valid character.
     /// </para>
     ///  </important>
     /// </summary>
@@ -72,7 +72,7 @@ public SendMessageRequest() { }
         /// Instantiates SendMessageRequest with the parameterized properties
         /// </summary>
         /// <param name="queueUrl">The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive.</param>
-        /// <param name="messageBody">The message to send. The minimum size is one character. The maximum size is 256 KiB. <important> A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.  <c>#x9</c> | <c>#xA</c> | <c>#xD</c> | <c>#x20</c> to <c>#xD7FF</c> | <c>#xE000</c> to <c>#xFFFD</c> | <c>#x10000</c> to <c>#x10FFFF</c>  Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with <c>U+FFFD</c> before storing the message in the queue, as long as the message body contains at least one valid character. </important></param>
+        /// <param name="messageBody">The message to send. The minimum size is one character. The maximum size is 256 KiB. <important> A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.  <c>#x9</c> | <c>#xA</c> | <c>#xD</c> | <c>#x20</c> to <c>#xD7FF</c> | <c>#xE000</c> to <c>#xFFFD</c> | <c>#x10000</c> to <c>#x10FFFF</c>  Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character. </important></param>
         public SendMessageRequest(string queueUrl, string messageBody)
         {
             _queueUrl = queueUrl;
@@ -145,9 +145,9 @@ internal bool IsSetMessageAttributes()
         ///  
         /// <para>
         /// Amazon SQS does not throw an exception or completely reject the message if it contains
-        /// invalid characters. Instead, it replaces those invalid characters with <c>U+FFFD</c>
-        /// before storing the message in the queue, as long as the message body contains at least
-        /// one valid character.
+        /// invalid characters. Instead, it replaces those invalid characters with U+FFFD before
+        /// storing the message in the queue, as long as the message body contains at least one
+        /// valid character.
         /// </para>
         ///  </important>
         /// </summary>
@@ -257,44 +257,58 @@ internal bool IsSetMessageDeduplicationId()
         /// <summary>
         /// Gets and sets the property MessageGroupId. 
         /// <para>
-        /// This parameter applies only to FIFO (first-in-first-out) queues.
+        ///  <c>MessageGroupId</c> is an attribute used in Amazon SQS FIFO (First-In-First-Out)
+        /// and standard queues. In FIFO queues, <c>MessageGroupId</c> 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 <c>MessageGroupId</c> 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 <c>MessageGroupId</c> can be processed in parallel, maintaining
+        /// the high throughput of standard queues.
+        /// </para>
+        ///  <ul> <li> 
+        /// <para>
+        ///  <b>FIFO queues:</b> <c>MessageGroupId</c> 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 <c>MessageGroupId</c> 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.
         /// </para>
         ///  
         /// <para>
-        /// 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 <c>MessageGroupId</c> 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 <c>MessageGroupId</c> when sending a message to a FIFO queue,
+        /// the action fails.
         /// </para>
-        ///  <ul> <li> 
+        ///  
         /// <para>
-        /// You must associate a non-empty <c>MessageGroupId</c> with a message. If you don't
-        /// provide a <c>MessageGroupId</c>, the action fails.
+        ///  <c>ReceiveMessage</c> might return messages with multiple <c>MessageGroupId</c> values.
+        /// For each <c>MessageGroupId</c>, the messages are sorted by time sent.
         /// </para>
         ///  </li> <li> 
         /// <para>
-        ///  <c>ReceiveMessage</c> might return messages with multiple <c>MessageGroupId</c> values.
-        /// For each <c>MessageGroupId</c>, the messages are sorted by time sent. The caller can't
-        /// specify a <c>MessageGroupId</c>.
+        ///  <b>Standard queues:</b>Use <c>MessageGroupId</c> in standard queues to enable fair
+        /// queues. The <c>MessageGroupId</c> 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 <c>MessageGroupId</c> in all messages when using fair
+        /// queues.
         /// </para>
         ///  </li> </ul> 
         /// <para>
-        /// The maximum length of <c>MessageGroupId</c> is 128 characters. Valid values: alphanumeric
+        /// The length of <c>MessageGroupId</c> is 128 characters. Valid values: alphanumeric
         /// characters and punctuation <c>(!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~)</c>.
         /// </para>
         ///  
         /// <para>
         /// For best practices of using <c>MessageGroupId</c>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using
         /// the MessageGroupId Property</a> in the <i>Amazon SQS Developer Guide</i>.
         /// </para>
-        ///  <important> 
-        /// <para>
-        ///  <c>MessageGroupId</c> is required for FIFO queues. You can't use it for Standard
-        /// queues.
-        /// </para>
-        ///  </important>
         /// </summary>
         public string MessageGroupId
         {