Skip to content

Commit deb638d

Browse files
Update generated code (#1924)
update generated code
1 parent beeefc0 commit deb638d

File tree

5 files changed

+55
-32
lines changed

5 files changed

+55
-32
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
- AWS api-change: Rework regions configuration
88

9+
### Changed
10+
11+
- AWS enhancement: Documentation updates.
12+
913
## 2.6.0
1014

1115
### Added

src/Input/ReceiveMessageRequest.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ final class ReceiveMessageRequest extends Input
4747
* - `SqsManagedSseEnabled` – Enables server-side queue encryption using SQS owned encryption keys. Only one
4848
* server-side encryption option is supported per queue (for example, SSE-KMS [^3] or SSE-SQS [^4]).
4949
* - `MessageDeduplicationId` – Returns the value provided by the producer that calls the `SendMessage` action.
50-
* - `MessageGroupId` – Returns the value provided by the producer that calls the `SendMessage` action. Messages with
51-
* the same `MessageGroupId` are returned in sequence.
50+
* - `MessageGroupId` – Returns the value provided by the producer that calls the `SendMessage` action.
5251
* - `SequenceNumber` – Returns the value provided by Amazon SQS.
5352
*
5453
* [^1]: http://en.wikipedia.org/wiki/Unix_time
@@ -157,7 +156,7 @@ final class ReceiveMessageRequest extends Input
157156
*
158157
* - While messages with a particular `MessageGroupId` are invisible, no more messages belonging to the same
159158
* `MessageGroupId` are returned until the visibility timeout expires. You can still receive messages with another
160-
* `MessageGroupId` as long as it is also visible.
159+
* `MessageGroupId` from your FIFO queue as long as they are visible.
161160
* - If a caller of `ReceiveMessage` can't track the `ReceiveRequestAttemptId`, no retries work until the original
162161
* visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
163162
*

src/Input/SendMessageRequest.php

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ final class SendMessageRequest extends Input
3232
* ! `#x9` | `#xA` | `#xD` | `#x20` to `#xD7FF` | `#xE000` to `#xFFFD` | `#x10000` to `#x10FFFF`
3333
* !
3434
* ! Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead,
35-
* ! it replaces those invalid characters with `U+FFFD` before storing the message in the queue, as long as the message
35+
* ! it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message
3636
* ! body contains at least one valid character.
3737
*
3838
* [^1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -123,27 +123,37 @@ final class SendMessageRequest extends Input
123123
private $messageDeduplicationId;
124124

125125
/**
126-
* This parameter applies only to FIFO (first-in-first-out) queues.
126+
* `MessageGroupId` is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues,
127+
* `MessageGroupId` organizes messages into distinct groups. Messages within the same message group are always processed
128+
* one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In
129+
* standard queues, using `MessageGroupId` enables fair queues. It is used to identify the tenant a message belongs to,
130+
* helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues,
131+
* messages with the same `MessageGroupId` can be processed in parallel, maintaining the high throughput of standard
132+
* queues.
133+
*
134+
* - **FIFO queues:**`MessageGroupId` acts as the tag that specifies that a message belongs to a specific message group.
135+
* Messages that belong to the same message group are processed in a FIFO manner (however, messages in different
136+
* message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use
137+
* `MessageGroupId` values (for example, session data for multiple users). In this scenario, multiple consumers can
138+
* process the queue, but the session data of each user is processed in a FIFO fashion.
127139
*
128-
* The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message
129-
* group are processed in a FIFO manner (however, messages in different message groups might be processed out of order).
130-
* To interleave multiple ordered streams within a single queue, use `MessageGroupId` values (for example, session data
131-
* for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is
132-
* processed in a FIFO fashion.
140+
* If you do not provide a `MessageGroupId` when sending a message to a FIFO queue, the action fails.
133141
*
134-
* - You must associate a non-empty `MessageGroupId` with a message. If you don't provide a `MessageGroupId`, the action
135-
* fails.
136-
* - `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the
137-
* messages are sorted by time sent. The caller can't specify a `MessageGroupId`.
142+
* `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the
143+
* messages are sorted by time sent.
144+
* - **Standard queues:**Use `MessageGroupId` in standard queues to enable fair queues. The `MessageGroupId` identifies
145+
* the tenant a message belongs to. A tenant can be any entity that shares a queue with others, such as your customer,
146+
* a client application, or a request type. When one tenant sends a disproportionately large volume of messages or has
147+
* messages that require longer processing time, fair queues ensure other tenants' messages maintain low dwell time.
148+
* This preserves quality of service for all tenants while maintaining the scalability and throughput of standard
149+
* queues. We recommend that you include a `MessageGroupId` in all messages when using fair queues.
138150
*
139-
* The maximum length of `MessageGroupId` is 128 characters. Valid values: alphanumeric characters and punctuation
151+
* The length of `MessageGroupId` is 128 characters. Valid values: alphanumeric characters and punctuation
140152
* `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.
141153
*
142154
* For best practices of using `MessageGroupId`, see Using the MessageGroupId Property [^1] in the *Amazon SQS Developer
143155
* Guide*.
144156
*
145-
* ! `MessageGroupId` is required for FIFO queues. You can't use it for Standard queues.
146-
*
147157
* [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
148158
*
149159
* @var string|null

src/SqsClient.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ public function changeMessageVisibilityBatch($input): ChangeMessageVisibilityBat
257257
*
258258
* > You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO
259259
* > queue. You must either create a new FIFO queue for your application or delete your existing standard queue and
260-
* > recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue [^1] in the
260+
* > recreate it as a FIFO queue. For more information, see Moving From a standard queue to a FIFO queue [^1] in the
261261
* > *Amazon SQS Developer Guide*.
262262
*
263263
* - If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
@@ -745,7 +745,7 @@ public function receiveMessage($input): ReceiveMessageResult
745745
* ! `#x9` | `#xA` | `#xD` | `#x20` to `#xD7FF` | `#xE000` to `#xFFFD` | `#x10000` to `#x10FFFF`
746746
* !
747747
* ! Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead,
748-
* ! it replaces those invalid characters with `U+FFFD` before storing the message in the queue, as long as the message
748+
* ! it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message
749749
* ! body contains at least one valid character.
750750
*
751751
* [^1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -818,7 +818,7 @@ public function sendMessage($input): SendMessageResult
818818
* ! `#x9` | `#xA` | `#xD` | `#x20` to `#xD7FF` | `#xE000` to `#xFFFD` | `#x10000` to `#x10FFFF`
819819
* !
820820
* ! Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead,
821-
* ! it replaces those invalid characters with `U+FFFD` before storing the message in the queue, as long as the message
821+
* ! it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message
822822
* ! body contains at least one valid character.
823823
*
824824
* If you don't specify the `DelaySeconds` parameter for an entry, Amazon SQS uses the default value for the queue.

src/ValueObject/SendMessageBatchRequestEntry.php

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,27 +109,37 @@ final class SendMessageBatchRequestEntry
109109
private $messageDeduplicationId;
110110

111111
/**
112-
* This parameter applies only to FIFO (first-in-first-out) queues.
112+
* `MessageGroupId` is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues,
113+
* `MessageGroupId` organizes messages into distinct groups. Messages within the same message group are always processed
114+
* one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In
115+
* standard queues, using `MessageGroupId` enables fair queues. It is used to identify the tenant a message belongs to,
116+
* helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues,
117+
* messages with the same `MessageGroupId` can be processed in parallel, maintaining the high throughput of standard
118+
* queues.
119+
*
120+
* - **FIFO queues:**`MessageGroupId` acts as the tag that specifies that a message belongs to a specific message group.
121+
* Messages that belong to the same message group are processed in a FIFO manner (however, messages in different
122+
* message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use
123+
* `MessageGroupId` values (for example, session data for multiple users). In this scenario, multiple consumers can
124+
* process the queue, but the session data of each user is processed in a FIFO fashion.
113125
*
114-
* The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message
115-
* group are processed in a FIFO manner (however, messages in different message groups might be processed out of order).
116-
* To interleave multiple ordered streams within a single queue, use `MessageGroupId` values (for example, session data
117-
* for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is
118-
* processed in a FIFO fashion.
126+
* If you do not provide a `MessageGroupId` when sending a message to a FIFO queue, the action fails.
119127
*
120-
* - You must associate a non-empty `MessageGroupId` with a message. If you don't provide a `MessageGroupId`, the action
121-
* fails.
122-
* - `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the
123-
* messages are sorted by time sent. The caller can't specify a `MessageGroupId`.
128+
* `ReceiveMessage` might return messages with multiple `MessageGroupId` values. For each `MessageGroupId`, the
129+
* messages are sorted by time sent.
130+
* - **Standard queues:**Use `MessageGroupId` in standard queues to enable fair queues. The `MessageGroupId` identifies
131+
* the tenant a message belongs to. A tenant can be any entity that shares a queue with others, such as your customer,
132+
* a client application, or a request type. When one tenant sends a disproportionately large volume of messages or has
133+
* messages that require longer processing time, fair queues ensure other tenants' messages maintain low dwell time.
134+
* This preserves quality of service for all tenants while maintaining the scalability and throughput of standard
135+
* queues. We recommend that you include a `MessageGroupId` in all messages when using fair queues.
124136
*
125137
* The length of `MessageGroupId` is 128 characters. Valid values: alphanumeric characters and punctuation
126138
* `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.
127139
*
128140
* For best practices of using `MessageGroupId`, see Using the MessageGroupId Property [^1] in the *Amazon SQS Developer
129141
* Guide*.
130142
*
131-
* ! `MessageGroupId` is required for FIFO queues. You can't use it for Standard queues.
132-
*
133143
* [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
134144
*
135145
* @var string|null

0 commit comments

Comments
 (0)