aws-sdk-sns 1.21.0 → 1.22.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
2
  SHA1:
3
- metadata.gz: 541eb2adf00510177c2300c5afb1648418676703
4
- data.tar.gz: 73117df68dd3cbf7118e0b6da2d365f0f6f43d41
3
+ metadata.gz: d3cda4f26256f5a684b484c10846b10c0f146807
4
+ data.tar.gz: 91bc5c97692b9042de7b7cc4df1c280e57d2b3da
5
5
  SHA512:
6
- metadata.gz: 800b75598c1cef889268fd2e1076b4f479af38b209b03830c18f600a06c78c11f36c2f126d8c7f18c6ab38b6843a245188b5dd95888ae46384ef6b32fe59d8d4
7
- data.tar.gz: 3b202f06d57f96536c0c84ba6562e2af0b139e73fd9ca571ccac85bb257ed1c16aba482639ec3188bfb9c6c600c5d77f8e79dbeba43147ad23c0c37336067a44
6
+ metadata.gz: dd66c96287d95e5cae5db18d3e69b056e631191ee0a478889db45c14bdcbdb825a2ec252e781cd7e8ed8d791fb323fd83dd9a47d10926e700b581d3c2224618a
7
+ data.tar.gz: 20782a2cec0998f73a97196b1e8380a081e02e442455aee624bbe8ae5724e6b924c2eb3e9cb199011a47cc46bec4d36db7a156ce2d576000de0b4b47a5fa4740
@@ -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.21.0'
52
+ GEM_VERSION = '1.22.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
@@ -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.
@@ -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,26 @@ 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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -209,16 +260,16 @@ module Aws::SNS
209
260
  # requests through. Formatted like 'http://proxy.com:123'.
210
261
  #
211
262
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
263
+ # seconds to wait when opening a HTTP session before raising a
213
264
  # `Timeout::Error`.
214
265
  #
215
266
  # @option options [Integer] :http_read_timeout (60) The default
216
267
  # number of seconds to wait for response data. This value can
217
268
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
269
+ # per-request on the session yielded by {#session_for}.
219
270
  #
220
271
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
272
+ # seconds a connection is allowed to sit idle before it is
222
273
  # considered stale. Stale connections are closed and removed
223
274
  # from the pool before making a request.
224
275
  #
@@ -227,7 +278,7 @@ module Aws::SNS
227
278
  # request body. This option has no effect unless the request has
228
279
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
280
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
281
+ # request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
284
  # HTTP debug output will be sent to the `:logger`.
@@ -1966,7 +2017,7 @@ module Aws::SNS
1966
2017
  params: params,
1967
2018
  config: config)
1968
2019
  context[:gem_name] = 'aws-sdk-sns'
1969
- context[:gem_version] = '1.21.0'
2020
+ context[:gem_version] = '1.22.0'
1970
2021
  Seahorse::Client::Request.new(handlers, context)
1971
2022
  end
1972
2023
 
@@ -6,6 +6,51 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+
10
+ # When SNS returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::SNS::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all SNS errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::SNS::Errors::ServiceError
18
+ # # rescues all SNS API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {AuthorizationErrorException}
29
+ # * {ConcurrentAccessException}
30
+ # * {EndpointDisabledException}
31
+ # * {FilterPolicyLimitExceededException}
32
+ # * {InternalErrorException}
33
+ # * {InvalidParameterException}
34
+ # * {InvalidParameterValueException}
35
+ # * {InvalidSecurityException}
36
+ # * {KMSAccessDeniedException}
37
+ # * {KMSDisabledException}
38
+ # * {KMSInvalidStateException}
39
+ # * {KMSNotFoundException}
40
+ # * {KMSOptInRequired}
41
+ # * {KMSThrottlingException}
42
+ # * {NotFoundException}
43
+ # * {PlatformApplicationDisabledException}
44
+ # * {ResourceNotFoundException}
45
+ # * {StaleTagException}
46
+ # * {SubscriptionLimitExceededException}
47
+ # * {TagLimitExceededException}
48
+ # * {TagPolicyException}
49
+ # * {ThrottledException}
50
+ # * {TopicLimitExceededException}
51
+ #
52
+ # Additionally, error classes are dynamically generated for service errors based on the error code
53
+ # if they are not defined above.
9
54
  module Errors
10
55
 
11
56
  extend Aws::Errors::DynamicErrors
@@ -23,7 +68,6 @@ module Aws::SNS
23
68
  def message
24
69
  @message || @data[:message]
25
70
  end
26
-
27
71
  end
28
72
 
29
73
  class ConcurrentAccessException < ServiceError
@@ -39,7 +83,6 @@ module Aws::SNS
39
83
  def message
40
84
  @message || @data[:message]
41
85
  end
42
-
43
86
  end
44
87
 
45
88
  class EndpointDisabledException < ServiceError
@@ -55,7 +98,6 @@ module Aws::SNS
55
98
  def message
56
99
  @message || @data[:message]
57
100
  end
58
-
59
101
  end
60
102
 
61
103
  class FilterPolicyLimitExceededException < ServiceError
@@ -71,7 +113,6 @@ module Aws::SNS
71
113
  def message
72
114
  @message || @data[:message]
73
115
  end
74
-
75
116
  end
76
117
 
77
118
  class InternalErrorException < ServiceError
@@ -87,7 +128,6 @@ module Aws::SNS
87
128
  def message
88
129
  @message || @data[:message]
89
130
  end
90
-
91
131
  end
92
132
 
93
133
  class InvalidParameterException < ServiceError
@@ -103,7 +143,6 @@ module Aws::SNS
103
143
  def message
104
144
  @message || @data[:message]
105
145
  end
106
-
107
146
  end
108
147
 
109
148
  class InvalidParameterValueException < ServiceError
@@ -119,7 +158,6 @@ module Aws::SNS
119
158
  def message
120
159
  @message || @data[:message]
121
160
  end
122
-
123
161
  end
124
162
 
125
163
  class InvalidSecurityException < ServiceError
@@ -135,7 +173,6 @@ module Aws::SNS
135
173
  def message
136
174
  @message || @data[:message]
137
175
  end
138
-
139
176
  end
140
177
 
141
178
  class KMSAccessDeniedException < ServiceError
@@ -151,7 +188,6 @@ module Aws::SNS
151
188
  def message
152
189
  @message || @data[:message]
153
190
  end
154
-
155
191
  end
156
192
 
157
193
  class KMSDisabledException < ServiceError
@@ -167,7 +203,6 @@ module Aws::SNS
167
203
  def message
168
204
  @message || @data[:message]
169
205
  end
170
-
171
206
  end
172
207
 
173
208
  class KMSInvalidStateException < ServiceError
@@ -183,7 +218,6 @@ module Aws::SNS
183
218
  def message
184
219
  @message || @data[:message]
185
220
  end
186
-
187
221
  end
188
222
 
189
223
  class KMSNotFoundException < ServiceError
@@ -199,7 +233,6 @@ module Aws::SNS
199
233
  def message
200
234
  @message || @data[:message]
201
235
  end
202
-
203
236
  end
204
237
 
205
238
  class KMSOptInRequired < ServiceError
@@ -215,7 +248,6 @@ module Aws::SNS
215
248
  def message
216
249
  @message || @data[:message]
217
250
  end
218
-
219
251
  end
220
252
 
221
253
  class KMSThrottlingException < ServiceError
@@ -231,7 +263,6 @@ module Aws::SNS
231
263
  def message
232
264
  @message || @data[:message]
233
265
  end
234
-
235
266
  end
236
267
 
237
268
  class NotFoundException < ServiceError
@@ -247,7 +278,6 @@ module Aws::SNS
247
278
  def message
248
279
  @message || @data[:message]
249
280
  end
250
-
251
281
  end
252
282
 
253
283
  class PlatformApplicationDisabledException < ServiceError
@@ -263,7 +293,6 @@ module Aws::SNS
263
293
  def message
264
294
  @message || @data[:message]
265
295
  end
266
-
267
296
  end
268
297
 
269
298
  class ResourceNotFoundException < ServiceError
@@ -279,7 +308,6 @@ module Aws::SNS
279
308
  def message
280
309
  @message || @data[:message]
281
310
  end
282
-
283
311
  end
284
312
 
285
313
  class StaleTagException < ServiceError
@@ -295,7 +323,6 @@ module Aws::SNS
295
323
  def message
296
324
  @message || @data[:message]
297
325
  end
298
-
299
326
  end
300
327
 
301
328
  class SubscriptionLimitExceededException < ServiceError
@@ -311,7 +338,6 @@ module Aws::SNS
311
338
  def message
312
339
  @message || @data[:message]
313
340
  end
314
-
315
341
  end
316
342
 
317
343
  class TagLimitExceededException < ServiceError
@@ -327,7 +353,6 @@ module Aws::SNS
327
353
  def message
328
354
  @message || @data[:message]
329
355
  end
330
-
331
356
  end
332
357
 
333
358
  class TagPolicyException < ServiceError
@@ -343,7 +368,6 @@ module Aws::SNS
343
368
  def message
344
369
  @message || @data[:message]
345
370
  end
346
-
347
371
  end
348
372
 
349
373
  class ThrottledException < ServiceError
@@ -359,7 +383,6 @@ module Aws::SNS
359
383
  def message
360
384
  @message || @data[:message]
361
385
  end
362
-
363
386
  end
364
387
 
365
388
  class TopicLimitExceededException < ServiceError
@@ -375,7 +398,6 @@ module Aws::SNS
375
398
  def message
376
399
  @message || @data[:message]
377
400
  end
378
-
379
401
  end
380
402
 
381
403
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+
9
10
  class PlatformApplication
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
21
22
  @arn = extract_arn(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+
9
10
  class PlatformEndpoint
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
21
22
  @arn = extract_arn(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+ # This class provides a resource oriented interface for SNS.
10
+ # To create a resource object:
11
+ # resource = Aws::SNS::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::SNS::Client.new(region: 'us-west-2')
15
+ # resource = Aws::SNS::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+
9
10
  class Subscription
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
21
22
  @arn = extract_arn(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SNS
9
+
9
10
  class Topic
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
21
22
  @arn = extract_arn(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-sns
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.21.0
4
+ version: 1.22.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-22 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core