aws-sdk-sns 1.19.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 5ae8a241c7827e91349db30712ef288306b2f0c0
4
- data.tar.gz: bb512a9193dbd1e98e379c0355ce2904073fe8f7
2
+ SHA256:
3
+ metadata.gz: 2c10fcf0aede9daa7ffc180be99eaf42df30d9e84eafd433d7086fe0df20ee55
4
+ data.tar.gz: 559f957645a9f665aaae3b0086178988660ae7b888ba6ff9d13c2f9032d75d5b
5
5
  SHA512:
6
- metadata.gz: 9582f5eef312e7feb602b740898d6ef10eb9d600e3728a605d4fabe6c203ce6ba20a5c843b1e0d3eb8c095956990fa9986d8aaf8d1b97e75cc4a4be53c17d770
7
- data.tar.gz: e39026bfb6245fdd0d718835388ce86fd172d7bd6f0d50a9a5303d1f80061b7c9e14e51684f798b12fc156b5ae3584832cbb0e7eb47205b5caafe953c3642ad6
6
+ metadata.gz: 239b22483640c1010548455dbc3f75b40b9e7437d78037e02e268a4a57fb6715b5101e927566a3f4332c8b03599041b2fe1553e82e6704c47c5965f0658d4945
7
+ data.tar.gz: 3be3aeb8100bf20c094895732d5b4745b50d44c74f882779faf04733e624394eb9a45beb33d89e41df3c212aabf32ac12ee688473e6d8692c81d33419db43da4
@@ -28,17 +28,20 @@ require_relative 'aws-sdk-sns/customizations'
28
28
  # methods each accept a hash of request parameters and return a response
29
29
  # structure.
30
30
  #
31
+ # sns = Aws::SNS::Client.new
32
+ # resp = sns.add_permission(params)
33
+ #
31
34
  # See {Client} for more information.
32
35
  #
33
36
  # # Errors
34
37
  #
35
- # Errors returned from Amazon Simple Notification Service all
36
- # extend {Errors::ServiceError}.
38
+ # Errors returned from Amazon Simple Notification Service are defined in the
39
+ # {Errors} module and all extend {Errors::ServiceError}.
37
40
  #
38
41
  # begin
39
42
  # # do stuff
40
43
  # rescue Aws::SNS::Errors::ServiceError
41
- # # rescues all service API errors
44
+ # # rescues all Amazon Simple Notification Service API errors
42
45
  # end
43
46
  #
44
47
  # See {Errors} for more information.
@@ -46,6 +49,6 @@ require_relative 'aws-sdk-sns/customizations'
46
49
  # @service
47
50
  module Aws::SNS
48
51
 
49
- GEM_VERSION = '1.19.0'
52
+ GEM_VERSION = '1.24.0'
50
53
 
51
54
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:sns)
31
31
 
32
32
  module Aws::SNS
33
+ # An API client for SNS. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::SNS::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::SNS
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::SNS
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::SNS
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::SNS
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::SNS
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::SNS
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::SNS
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::SNS
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::SNS
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -271,7 +325,7 @@ module Aws::SNS
271
325
  # @option params [required, Array<String>] :action_name
272
326
  # The action you want to allow for the specified principal(s).
273
327
  #
274
- # Valid values: any Amazon SNS action name.
328
+ # Valid values: Any Amazon SNS action name, for example `Publish`.
275
329
  #
276
330
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
277
331
  #
@@ -376,7 +430,7 @@ module Aws::SNS
376
430
  # PlatformCredential attributes when using the
377
431
  # `CreatePlatformApplication` action. The PlatformPrincipal is received
378
432
  # from the notification service. For APNS/APNS\_SANDBOX,
379
- # PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal
433
+ # PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal
380
434
  # is not applicable. For ADM, PlatformPrincipal is "client id". The
381
435
  # PlatformCredential is also received from the notification service. For
382
436
  # WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
@@ -384,30 +438,12 @@ module Aws::SNS
384
438
  # is "API key".
385
439
  #
386
440
  # For APNS/APNS\_SANDBOX, PlatformCredential is "private key". For
387
- # GCM, PlatformCredential is "API key". For ADM, PlatformCredential is
441
+ # FCM, PlatformCredential is "API key". For ADM, PlatformCredential is
388
442
  # "client secret". For WNS, PlatformCredential is "secret key". For
389
443
  # MPNS, PlatformCredential is "private key". For Baidu,
390
444
  # PlatformCredential is "secret key". The PlatformApplicationArn that
391
445
  # is returned when using `CreatePlatformApplication` is then used as an
392
- # attribute for the `CreatePlatformEndpoint` action. For more
393
- # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
394
- # more information about obtaining the PlatformPrincipal and
395
- # PlatformCredential for each of the supported push notification
396
- # services, see [Getting Started with Apple Push Notification
397
- # Service][2], [Getting Started with Amazon Device Messaging][3],
398
- # [Getting Started with Baidu Cloud Push][4], [Getting Started with
399
- # Google Cloud Messaging for Android][5], [Getting Started with
400
- # MPNS][6], or [Getting Started with WNS][7].
401
- #
402
- #
403
- #
404
- # [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
405
- # [2]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html
406
- # [3]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html
407
- # [4]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html
408
- # [5]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html
409
- # [6]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html
410
- # [7]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html
446
+ # attribute for the `CreatePlatformEndpoint` action.
411
447
  #
412
448
  # @option params [required, String] :name
413
449
  # Application names must be made up of only uppercase and lowercase
@@ -416,8 +452,8 @@ module Aws::SNS
416
452
  #
417
453
  # @option params [required, String] :platform
418
454
  # The following platforms are supported: ADM (Amazon Device Messaging),
419
- # APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
420
- # Cloud Messaging).
455
+ # APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
456
+ # (Firebase Cloud Messaging).
421
457
  #
422
458
  # @option params [required, Hash<String,String>] :attributes
423
459
  # For a list of attributes, see [SetPlatformApplicationAttributes][1]
@@ -454,7 +490,7 @@ module Aws::SNS
454
490
  end
455
491
 
456
492
  # Creates an endpoint for a device and mobile app on one of the
457
- # supported push notification services, such as GCM and APNS.
493
+ # supported push notification services, such as FCM and APNS.
458
494
  # `CreatePlatformEndpoint` requires the PlatformApplicationArn that is
459
495
  # returned from `CreatePlatformApplication`. The EndpointArn that is
460
496
  # returned when using `CreatePlatformEndpoint` can then be used by the
@@ -484,7 +520,7 @@ module Aws::SNS
484
520
  # device. The specific name for Token will vary, depending on which
485
521
  # notification service is being used. For example, when using APNS as
486
522
  # the notification service, you need the device token. Alternatively,
487
- # when using GCM or ADM, the device token equivalent is called the
523
+ # when using FCM or ADM, the device token equivalent is called the
488
524
  # registration ID.
489
525
  #
490
526
  # @option params [String] :custom_user_data
@@ -576,6 +612,11 @@ module Aws::SNS
576
612
  # @option params [Array<Types::Tag>] :tags
577
613
  # The list of tags to add to a new topic.
578
614
  #
615
+ # <note markdown="1"> To be able to tag a topic on creation, you must have the
616
+ # `sns:CreateTopic` and `sns:TagResource` permissions.
617
+ #
618
+ # </note>
619
+ #
579
620
  # @return [Types::CreateTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
580
621
  #
581
622
  # * {Types::CreateTopicResponse#topic_arn #topic_arn} => String
@@ -640,7 +681,7 @@ module Aws::SNS
640
681
  end
641
682
 
642
683
  # Deletes a platform application object for one of the supported push
643
- # notification services, such as APNS and GCM. For more information, see
684
+ # notification services, such as APNS and FCM. For more information, see
644
685
  # [Using Amazon SNS Mobile Push Notifications][1].
645
686
  #
646
687
  #
@@ -693,7 +734,7 @@ module Aws::SNS
693
734
  end
694
735
 
695
736
  # Retrieves the endpoint attributes for a device on one of the supported
696
- # push notification services, such as GCM and APNS. For more
737
+ # push notification services, such as FCM and APNS. For more
697
738
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
698
739
  #
699
740
  #
@@ -728,7 +769,7 @@ module Aws::SNS
728
769
  end
729
770
 
730
771
  # Retrieves the attributes of the platform application object for the
731
- # supported push notification services, such as APNS and GCM. For more
772
+ # supported push notification services, such as APNS and FCM. For more
732
773
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
733
774
  #
734
775
  #
@@ -863,7 +904,7 @@ module Aws::SNS
863
904
  end
864
905
 
865
906
  # Lists the endpoints and endpoint attributes for devices in a supported
866
- # push notification service, such as GCM and APNS. The results for
907
+ # push notification service, such as FCM and APNS. The results for
867
908
  # `ListEndpointsByPlatformApplication` are paginated and return a
868
909
  # limited list of endpoints, up to 100. If additional records are
869
910
  # available after the first page results, then a NextToken string will
@@ -893,6 +934,8 @@ module Aws::SNS
893
934
  # * {Types::ListEndpointsByPlatformApplicationResponse#endpoints #endpoints} => Array&lt;Types::Endpoint&gt;
894
935
  # * {Types::ListEndpointsByPlatformApplicationResponse#next_token #next_token} => String
895
936
  #
937
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
938
+ #
896
939
  # @example Request syntax with placeholder values
897
940
  #
898
941
  # resp = client.list_endpoints_by_platform_application({
@@ -960,7 +1003,7 @@ module Aws::SNS
960
1003
  end
961
1004
 
962
1005
  # Lists the platform application objects for the supported push
963
- # notification services, such as APNS and GCM. The results for
1006
+ # notification services, such as APNS and FCM. The results for
964
1007
  # `ListPlatformApplications` are paginated and return a limited list of
965
1008
  # applications, up to 100. If additional records are available after the
966
1009
  # first page results, then a NextToken string will be returned. To
@@ -985,6 +1028,8 @@ module Aws::SNS
985
1028
  # * {Types::ListPlatformApplicationsResponse#platform_applications #platform_applications} => Array&lt;Types::PlatformApplication&gt;
986
1029
  # * {Types::ListPlatformApplicationsResponse#next_token #next_token} => String
987
1030
  #
1031
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1032
+ #
988
1033
  # @example Request syntax with placeholder values
989
1034
  #
990
1035
  # resp = client.list_platform_applications({
@@ -1023,6 +1068,8 @@ module Aws::SNS
1023
1068
  # * {Types::ListSubscriptionsResponse#subscriptions #subscriptions} => Array&lt;Types::Subscription&gt;
1024
1069
  # * {Types::ListSubscriptionsResponse#next_token #next_token} => String
1025
1070
  #
1071
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1072
+ #
1026
1073
  # @example Request syntax with placeholder values
1027
1074
  #
1028
1075
  # resp = client.list_subscriptions({
@@ -1067,6 +1114,8 @@ module Aws::SNS
1067
1114
  # * {Types::ListSubscriptionsByTopicResponse#subscriptions #subscriptions} => Array&lt;Types::Subscription&gt;
1068
1115
  # * {Types::ListSubscriptionsByTopicResponse#next_token #next_token} => String
1069
1116
  #
1117
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1118
+ #
1070
1119
  # @example Request syntax with placeholder values
1071
1120
  #
1072
1121
  # resp = client.list_subscriptions_by_topic({
@@ -1144,6 +1193,8 @@ module Aws::SNS
1144
1193
  # * {Types::ListTopicsResponse#topics #topics} => Array&lt;Types::Topic&gt;
1145
1194
  # * {Types::ListTopicsResponse#next_token #next_token} => String
1146
1195
  #
1196
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1197
+ #
1147
1198
  # @example Request syntax with placeholder values
1148
1199
  #
1149
1200
  # resp = client.list_topics({
@@ -1234,10 +1285,6 @@ module Aws::SNS
1234
1285
  # @option params [required, String] :message
1235
1286
  # The message you want to send.
1236
1287
  #
1237
- # The `Message` parameter is always a string. If you set
1238
- # `MessageStructure` to `json`, you must string-encode the `Message`
1239
- # parameter.
1240
- #
1241
1288
  # If you are publishing to a topic and you want to send the same message
1242
1289
  # to all transport protocols, include the text of the message as a
1243
1290
  # String value. If you want to send different messages for each
@@ -1315,17 +1362,8 @@ module Aws::SNS
1315
1362
  # You can define other top-level keys that define the message you want
1316
1363
  # to send to a specific transport protocol (e.g., "http").
1317
1364
  #
1318
- # For information about sending different messages for each protocol
1319
- # using the AWS Management Console, go to [Create Different Messages for
1320
- # Each Protocol][1] in the *Amazon Simple Notification Service Getting
1321
- # Started Guide*.
1322
- #
1323
1365
  # Valid value: `json`
1324
1366
  #
1325
- #
1326
- #
1327
- # [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
1328
- #
1329
1367
  # @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
1330
1368
  # Message attributes for Publish action.
1331
1369
  #
@@ -1391,7 +1429,7 @@ module Aws::SNS
1391
1429
  end
1392
1430
 
1393
1431
  # Sets the attributes for an endpoint for a device on one of the
1394
- # supported push notification services, such as GCM and APNS. For more
1432
+ # supported push notification services, such as FCM and APNS. For more
1395
1433
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
1396
1434
  #
1397
1435
  #
@@ -1440,7 +1478,7 @@ module Aws::SNS
1440
1478
  end
1441
1479
 
1442
1480
  # Sets the attributes of the platform application object for the
1443
- # supported push notification services, such as APNS and GCM. For more
1481
+ # supported push notification services, such as APNS and FCM. For more
1444
1482
  # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
1445
1483
  # information on configuring attributes for message delivery status, see
1446
1484
  # [Using Amazon SNS Application Attributes for Message Delivery
@@ -1460,12 +1498,12 @@ module Aws::SNS
1460
1498
  #
1461
1499
  # * `PlatformCredential` – The credential received from the notification
1462
1500
  # service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
1463
- # For GCM, PlatformCredential is "API key". For ADM,
1501
+ # For FCM, PlatformCredential is "API key". For ADM,
1464
1502
  # PlatformCredential is "client secret".
1465
1503
  #
1466
1504
  # * `PlatformPrincipal` – The principal received from the notification
1467
1505
  # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
1468
- # certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
1506
+ # certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
1469
1507
  # PlatformPrincipal is "client id".
1470
1508
  #
1471
1509
  # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
@@ -1649,6 +1687,13 @@ module Aws::SNS
1649
1687
  # for the endpoints to process JSON formatting, which is otherwise
1650
1688
  # created for Amazon SNS metadata.
1651
1689
  #
1690
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1691
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
1692
+ # delivered due to client errors (for example, when the subscribed
1693
+ # endpoint is unreachable) or server errors (for example, when the
1694
+ # service that powers the subscribed endpoint becomes unavailable) are
1695
+ # held in the dead-letter queue for further analysis or reprocessing.
1696
+ #
1652
1697
  # @option params [String] :attribute_value
1653
1698
  # The new value for the attribute in JSON format.
1654
1699
  #
@@ -1757,7 +1802,7 @@ module Aws::SNS
1757
1802
  # * `application` – delivery of JSON-encoded message to an EndpointArn
1758
1803
  # for a mobile app and device.
1759
1804
  #
1760
- # * `lambda` – delivery of JSON-encoded message to an AWS Lambda
1805
+ # * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
1761
1806
  # function.
1762
1807
  #
1763
1808
  # @option params [String] :endpoint
@@ -1765,10 +1810,10 @@ module Aws::SNS
1765
1810
  # protocol:
1766
1811
  #
1767
1812
  # * For the `http` protocol, the endpoint is an URL beginning with
1768
- # "https://"
1813
+ # `http://`
1769
1814
  #
1770
1815
  # * For the `https` protocol, the endpoint is a URL beginning with
1771
- # "https://"
1816
+ # `https://`
1772
1817
  #
1773
1818
  # * For the `email` protocol, the endpoint is an email address
1774
1819
  #
@@ -1783,8 +1828,8 @@ module Aws::SNS
1783
1828
  # * For the `application` protocol, the endpoint is the EndpointArn of a
1784
1829
  # mobile app and device.
1785
1830
  #
1786
- # * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
1787
- # function.
1831
+ # * For the `lambda` protocol, the endpoint is the ARN of an Amazon
1832
+ # Lambda function.
1788
1833
  #
1789
1834
  # @option params [Hash<String,String>] :attributes
1790
1835
  # A map of attributes with their corresponding values.
@@ -1804,18 +1849,27 @@ module Aws::SNS
1804
1849
  # for the endpoints to process JSON formatting, which is otherwise
1805
1850
  # created for Amazon SNS metadata.
1806
1851
  #
1852
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1853
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
1854
+ # delivered due to client errors (for example, when the subscribed
1855
+ # endpoint is unreachable) or server errors (for example, when the
1856
+ # service that powers the subscribed endpoint becomes unavailable) are
1857
+ # held in the dead-letter queue for further analysis or reprocessing.
1858
+ #
1807
1859
  # @option params [Boolean] :return_subscription_arn
1808
1860
  # Sets whether the response from the `Subscribe` request includes the
1809
1861
  # subscription ARN, even if the subscription is not yet confirmed.
1810
1862
  #
1811
- # If you set this parameter to `false`, the response includes the ARN
1812
- # for confirmed subscriptions, but it includes an ARN value of "pending
1813
- # subscription" for subscriptions that are not yet confirmed. A
1814
- # subscription becomes confirmed when the subscriber calls the
1815
- # `ConfirmSubscription` action with a confirmation token.
1863
+ # * If you have the subscription ARN returned, the response includes the
1864
+ # ARN in all cases, even if the subscription is not yet confirmed.
1865
+ #
1866
+ # * If you don't have the subscription ARN returned, in addition to the
1867
+ # ARN for confirmed subscriptions, the response also includes the
1868
+ # `pending subscription` ARN value for subscriptions that aren't yet
1869
+ # confirmed. A subscription becomes confirmed when the subscriber
1870
+ # calls the `ConfirmSubscription` action with a confirmation token.
1816
1871
  #
1817
- # If you set this parameter to `true`, the response includes the ARN in
1818
- # all cases, even if the subscription is not yet confirmed.
1872
+ # If you set this parameter to `true`, .
1819
1873
  #
1820
1874
  # The default value is `false`.
1821
1875
  #
@@ -1863,18 +1917,14 @@ module Aws::SNS
1863
1917
  # * A new tag with a key identical to that of an existing tag overwrites
1864
1918
  # the existing tag.
1865
1919
  #
1866
- # * Tagging actions are limited to 10 TPS per AWS account. If your
1867
- # application requires a higher throughput, file a [technical support
1868
- # request][2].
1869
- #
1870
- # For a full list of tag restrictions, see [Limits Related to Topics][3]
1871
- # in the *Amazon SNS Developer Guide*.
1920
+ # * Tagging actions are limited to 10 TPS per AWS account, per AWS
1921
+ # region. If your application requires a higher throughput, file a
1922
+ # [technical support request][2].
1872
1923
  #
1873
1924
  #
1874
1925
  #
1875
1926
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html
1876
1927
  # [2]: https://console.aws.amazon.com/support/home#/case/create?issueType=technical
1877
- # [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-limits.html#limits-topics
1878
1928
  #
1879
1929
  # @option params [required, String] :resource_arn
1880
1930
  # The ARN of the topic to which to add tags.
@@ -1980,7 +2030,7 @@ module Aws::SNS
1980
2030
  params: params,
1981
2031
  config: config)
1982
2032
  context[:gem_name] = 'aws-sdk-sns'
1983
- context[:gem_version] = '1.19.0'
2033
+ context[:gem_version] = '1.24.0'
1984
2034
  Seahorse::Client::Request.new(handlers, context)
1985
2035
  end
1986
2036