aws-sdk-sns 1.20.0 → 1.25.1

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