Skip to content

Commit a229d05

Browse files
Update generated code (#1927)
update generated code
1 parent 4afea04 commit a229d05

File tree

9 files changed

+116
-49
lines changed

9 files changed

+116
-49
lines changed

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"variables": {
3-
"${LATEST}": "3.351.12"
3+
"${LATEST}": "3.352.0"
44
},
55
"endpoints": "https://raw.githubusercontent.com/aws/aws-sdk-php/${LATEST}/src/data/endpoints.json",
66
"services": {

src/Service/Sns/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
## 1.10.0
1014

1115
### Added

src/Service/Sns/src/Exception/FilterPolicyLimitExceededException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
/**
88
* Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter
9-
* polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
9+
* polices, submit an Amazon SNS Limit Increase case in the Amazon Web ServicesSupport Center.
1010
*/
1111
final class FilterPolicyLimitExceededException extends ClientException
1212
{

src/Service/Sns/src/Exception/TooManyEntriesInBatchRequestException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use AsyncAws\Core\Exception\Http\ClientException;
66

77
/**
8-
* The batch request contains more entries than permissible.
8+
* The batch request contains more entries than permissible (more than 10).
99
*/
1010
final class TooManyEntriesInBatchRequestException extends ClientException
1111
{

src/Service/Sns/src/Input/CreateTopicInput.php

Lines changed: 70 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,84 @@ final class CreateTopicInput extends Input
3535
*
3636
* - `DeliveryPolicy` – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
3737
* - `DisplayName` – The display name to use for a topic with SMS subscriptions.
38-
* - `FifoTopic` – Set to true to create a FIFO topic.
3938
* - `Policy` – The policy that defines who can access your topic. By default, only the topic owner can publish or
4039
* subscribe to the topic.
41-
* - `SignatureVersion` – The signature version corresponds to the hashing algorithm used while creating the signature
42-
* of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By
43-
* default, `SignatureVersion` is set to `1`.
4440
* - `TracingConfig` – Tracing mode of an Amazon SNS topic. By default `TracingConfig` is set to `PassThrough`, and
4541
* the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set
4642
* to `Active`, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing
4743
* header is true. This is only supported on standard topics.
44+
* - HTTP
4845
*
49-
* The following attribute applies only to server-side encryption [^1]:
46+
* - `HTTPSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is
47+
* subscribed to an HTTP endpoint.
48+
* - `HTTPSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic
49+
* that is subscribed to an HTTP endpoint.
50+
* - `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is
51+
* subscribed to an HTTP endpoint.
52+
*
53+
* - Amazon Data Firehose
54+
*
55+
* - `FirehoseSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is
56+
* subscribed to an Amazon Data Firehose endpoint.
57+
* - `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS
58+
* topic that is subscribed to an Amazon Data Firehose endpoint.
59+
* - `FirehoseFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is
60+
* subscribed to an Amazon Data Firehose endpoint.
61+
*
62+
* - Lambda
63+
*
64+
* - `LambdaSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is
65+
* subscribed to an Lambda endpoint.
66+
* - `LambdaSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS
67+
* topic that is subscribed to an Lambda endpoint.
68+
* - `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is
69+
* subscribed to an Lambda endpoint.
70+
*
71+
* - Platform application endpoint
72+
*
73+
* - `ApplicationSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that
74+
* is subscribed to a platform application endpoint.
75+
* - `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon
76+
* SNS topic that is subscribed to an platform application endpoint.
77+
* - `ApplicationFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is
78+
* subscribed to an platform application endpoint.
79+
*
80+
* > In addition to being able to configure topic attributes for message delivery status of notification messages sent
81+
* > to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of
82+
* > push notification messages sent to push notification services.
83+
* >
84+
* > For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status [^1].
85+
*
86+
* - Amazon SQS
87+
*
88+
* - `SQSSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is
89+
* subscribed to an Amazon SQS endpoint.
90+
* - `SQSSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic
91+
* that is subscribed to an Amazon SQS endpoint.
92+
* - `SQSFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is
93+
* subscribed to an Amazon SQS endpoint.
94+
*
95+
*
96+
* > The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give
97+
* > Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate
98+
* > attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you
99+
* > configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate
100+
* > CloudWatch Logs.
101+
*
102+
* The following attribute applies only to server-side encryption [^2]:
50103
*
51104
* - `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom
52-
* CMK. For more information, see Key Terms [^2]. For more examples, see KeyId [^3] in the *Key Management Service API
105+
* CMK. For more information, see Key Terms [^3]. For more examples, see KeyId [^4] in the *Key Management Service API
53106
* Reference*.
54107
*
55-
* The following attributes apply only to FIFO topics [^4]:
108+
* The following attributes apply only to FIFO topics [^5]:
56109
*
57110
* - `ArchivePolicy` – The policy that sets the retention period for messages stored in the message archive of an
58111
* Amazon SNS FIFO topic.
59112
* - `ContentBasedDeduplication` – Enables content-based deduplication for FIFO topics.
60113
*
61114
* - By default, `ContentBasedDeduplication` is set to `false`. If you create a FIFO topic and this attribute is
62-
* `false`, you must specify a value for the `MessageDeduplicationId` parameter for the Publish [^5] action.
115+
* `false`, you must specify a value for the `MessageDeduplicationId` parameter for the Publish [^6] action.
63116
* - When you set `ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the
64117
* `MessageDeduplicationId` using the body of the message (but not the attributes of the message).
65118
*
@@ -75,14 +128,15 @@ final class CreateTopicInput extends Input
75128
* comes first.
76129
* - `MessageGroup` – The scope of deduplication is within each individual message group, which enables higher
77130
* throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see
78-
* Amazon SNS service quotas [^6] in the Amazon Web Services General Reference.
79-
*
80-
* [^1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
81-
* [^2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
82-
* [^3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
83-
* [^4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
84-
* [^5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
85-
* [^6]: https://docs.aws.amazon.com/general/latest/gr/sns.html
131+
* Amazon SNS service quotas [^7] in the Amazon Web Services General Reference.
132+
*
133+
* [^1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
134+
* [^2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
135+
* [^3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
136+
* [^4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
137+
* [^5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
138+
* [^6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
139+
* [^7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
86140
*
87141
* @var array<string, string>|null
88142
*/

src/Service/Sns/src/Input/PublishInput.php

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,18 @@ final class PublishInput extends Input
148148
private $messageDeduplicationId;
149149

150150
/**
151-
* This parameter applies only to FIFO (first-in-first-out) topics. The `MessageGroupId` can contain up to 128
152-
* alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.
151+
* The `MessageGroupId` can contain up to 128 alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation
152+
* `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.
153153
*
154-
* The `MessageGroupId` is a tag that specifies that a message belongs to a specific message group. Messages that belong
155-
* to the same message group are processed in a FIFO manner (however, messages in different message groups might be
156-
* processed out of order). Every message must include a `MessageGroupId`.
154+
* For FIFO topics: The `MessageGroupId` is a tag that specifies that a message belongs to a specific message group.
155+
* Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message
156+
* groups might be processed out of order). Every message must include a `MessageGroupId`.
157+
*
158+
* For standard topics: The `MessageGroupId` is optional and is forwarded only to Amazon SQS standard subscriptions to
159+
* activate fair queues [^1]. The `MessageGroupId` is not used for, or sent to, any other endpoint types. When provided,
160+
* the same validation rules apply as for FIFO topics.
161+
*
162+
* [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
157163
*
158164
* @var string|null
159165
*/

src/Service/Sns/src/Input/SubscribeInput.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ final class SubscribeInput extends Input
3232
* - `sqs` – delivery of JSON-encoded message to an Amazon SQS queue
3333
* - `application` – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
3434
* - `lambda` – delivery of JSON-encoded message to an Lambda function
35-
* - `firehose` – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
35+
* - `firehose` – delivery of JSON-encoded message to an Amazon Data Firehose delivery stream.
3636
*
3737
* @required
3838
*
@@ -51,7 +51,7 @@ final class SubscribeInput extends Input
5151
* - For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS queue.
5252
* - For the `application` protocol, the endpoint is the EndpointArn of a mobile app and device.
5353
* - For the `lambda` protocol, the endpoint is the ARN of an Lambda function.
54-
* - For the `firehose` protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
54+
* - For the `firehose` protocol, the endpoint is the ARN of an Amazon Data Firehose delivery stream.
5555
*
5656
* @var string|null
5757
*/

src/Service/Sns/src/SnsClient.php

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -364,28 +364,35 @@ public function publish($input): PublishResponse
364364
}
365365

366366
/**
367-
* Publishes up to ten messages to the specified topic. This is a batch version of `Publish`. For FIFO topics, multiple
368-
* messages within a single batch are published in the order they are sent, and messages are deduplicated within the
369-
* batch and across batches for 5 minutes.
367+
* Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the `Publish` API.
368+
* If you try to send more than 10 messages in a single batch request, you will receive a `TooManyEntriesInBatchRequest`
369+
* exception.
370+
*
371+
* For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are
372+
* deduplicated within the batch and across batches for five minutes.
370373
*
371374
* The result of publishing each message is reported individually in the response. Because the batch request can result
372375
* in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns
373-
* an HTTP status code of `200`.
376+
* an HTTP status code of 200.
374377
*
375378
* The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of
376379
* all of the batched messages) are both 256 KB (262,144 bytes).
377380
*
381+
* ! The `PublishBatch` API can send up to 10 messages at a time. If you attempt to send more than 10 messages in one
382+
* ! request, you will encounter a `TooManyEntriesInBatchRequest` exception. In such cases, split your messages into
383+
* ! multiple requests, each containing no more than 10 messages.
384+
*
378385
* Some actions take lists of parameters. These lists are specified using the `param.n` notation. Values of `n` are
379-
* integers starting from 1. For example, a parameter list with two elements looks like this:
386+
* integers starting from **1**. For example, a parameter list with two elements looks like this:
380387
*
381-
* &AttributeName.1=first
388+
* `&AttributeName.1=first`
382389
*
383-
* &AttributeName.2=second
390+
* `&AttributeName.2=second`
384391
*
385392
* If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to
386393
* the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
387394
*
388-
* When a `messageId` is returned, the batch message is saved and Amazon SNS immediately delivers the message to
395+
* When a `messageId` is returned, the batch message is saved, and Amazon SNS immediately delivers the message to
389396
* subscribers.
390397
*
391398
* @see https://docs.aws.amazon.com/sns/latest/api/API_PublishBatch.html
@@ -502,9 +509,6 @@ public function subscribe($input): SubscribeResponse
502509
* delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the `Unsubscribe`
503510
* request was unintended.
504511
*
505-
* > Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the
506-
* > owner of the topic can unsubscribe using the required Amazon Web Services signature.
507-
*
508512
* This action is throttled at 100 transactions per second (TPS).
509513
*
510514
* @see https://docs.aws.amazon.com/sns/latest/api/API_Unsubscribe.html

src/Service/Sns/src/ValueObject/PublishBatchRequestEntry.php

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ final class PublishBatchRequestEntry
4343
* - be a syntactically valid JSON object; and
4444
* - contain at least a top-level JSON key of "default" with a value that is a string.
4545
*
46-
* You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g.
47-
* http).
46+
* You can define other top-level keys that define the message you want to send to a specific transport protocol (for
47+
* example, http).
4848
*
4949
* @var string|null
5050
*/
@@ -103,23 +103,22 @@ final class PublishBatchRequestEntry
103103
private $messageDeduplicationId;
104104

105105
/**
106-
* This parameter applies only to FIFO (first-in-first-out) topics.
107-
*
108-
* The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message
109-
* group are processed in a FIFO manner (however, messages in different message groups might be processed out of order).
110-
* To interleave multiple ordered streams within a single topic, use `MessageGroupId` values (for example, session data
111-
* for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is
112-
* processed in a FIFO fashion.
106+
* FIFO topics: The tag that specifies that a message belongs to a specific message group. Messages that belong to the
107+
* same message group are processed in a FIFO manner (however, messages in different message groups might be processed
108+
* out of order). To interleave multiple ordered streams within a single topic, use `MessageGroupId` values (for
109+
* example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the
110+
* session data of each user is processed in a FIFO fashion. You must associate a non-empty `MessageGroupId` with a
111+
* message. If you do not provide a `MessageGroupId`, the action fails.
113112
*
114-
* You must associate a non-empty `MessageGroupId` with a message. If you don't provide a `MessageGroupId`, the action
115-
* fails.
113+
* Standard topics: The `MessageGroupId` is optional and is forwarded only to Amazon SQS standard subscriptions to
114+
* activate fair queues [^1]. The `MessageGroupId` is not used for, or sent to, any other endpoint types.
116115
*
117116
* The length of `MessageGroupId` is 128 characters.
118117
*
119118
* `MessageGroupId` can contain alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation
120119
* `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`.
121120
*
122-
* ! `MessageGroupId` is required for FIFO topics. You can't use it for standard topics.
121+
* [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
123122
*
124123
* @var string|null
125124
*/

0 commit comments

Comments
 (0)