aws-sdk-polly 1.27.0 → 1.28.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: 32c30edfdeb3297f71b96f0968636fe1a34a493f
4
- data.tar.gz: 46c414a66d55c68d91647861061f836d1c26a5ee
3
+ metadata.gz: 42425e0486ed20a0632681cbfe0460a489904de6
4
+ data.tar.gz: 1d9355addc8a8da1d2d97cb59e01c919343982c6
5
5
  SHA512:
6
- metadata.gz: 101b2b5afe81f585fc4ed51a872f3a0e276791dd1918e360fbf1b4b5d67ef0842f9a866753f0173501e480e020a20e743bf9932c4b0f0e2c5aee5e8ff39f477b
7
- data.tar.gz: 8ac51c3f430bbc37ba7dcb16bba681e9a718fabb4894964b1eadbfc2605db75c7667da5affa8cde43b30e41466cfd2a2598748ac3fb6400c24a806b3216054c8
6
+ metadata.gz: 3e491acc74e2a5adeb91d6a464e6b48fb0cbcba268dca383f4ef3f53a9270d0d2721bc1c362074df108e14c4795a60de791070a4ee4851ef92c428fe2d027c05
7
+ data.tar.gz: 6be8abdde91fb009eb97557155cbb33c7990f3b3eba1b033a9ae51e8dcb2668cf147527b80d95d9ecd1aca7a3df44a47a55948b3ebfab6f9c1aa59e9e7de4a72
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-polly/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # polly = Aws::Polly::Client.new
28
+ # resp = polly.delete_lexicon(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Polly all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Polly are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Polly::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Polly API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-polly/customizations'
42
45
  # @service
43
46
  module Aws::Polly
44
47
 
45
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.28.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:polly)
31
31
 
32
32
  module Aws::Polly
33
+ # An API client for Polly. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Polly::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::Polly
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::Polly
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::Polly
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::Polly
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::Polly
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::Polly
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`.
@@ -985,7 +1036,7 @@ module Aws::Polly
985
1036
  params: params,
986
1037
  config: config)
987
1038
  context[:gem_name] = 'aws-sdk-polly'
988
- context[:gem_version] = '1.27.0'
1039
+ context[:gem_version] = '1.28.0'
989
1040
  Seahorse::Client::Request.new(handlers, context)
990
1041
  end
991
1042
 
@@ -6,6 +6,49 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Polly
9
+
10
+ # When Polly returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Polly::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Polly errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Polly::Errors::ServiceError
18
+ # # rescues all Polly 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
+ # * {EngineNotSupportedException}
29
+ # * {InvalidLexiconException}
30
+ # * {InvalidNextTokenException}
31
+ # * {InvalidS3BucketException}
32
+ # * {InvalidS3KeyException}
33
+ # * {InvalidSampleRateException}
34
+ # * {InvalidSnsTopicArnException}
35
+ # * {InvalidSsmlException}
36
+ # * {InvalidTaskIdException}
37
+ # * {LanguageNotSupportedException}
38
+ # * {LexiconNotFoundException}
39
+ # * {LexiconSizeExceededException}
40
+ # * {MarksNotSupportedForFormatException}
41
+ # * {MaxLexemeLengthExceededException}
42
+ # * {MaxLexiconsNumberExceededException}
43
+ # * {ServiceFailureException}
44
+ # * {SsmlMarksNotSupportedForTextTypeException}
45
+ # * {SynthesisTaskNotFoundException}
46
+ # * {TextLengthExceededException}
47
+ # * {UnsupportedPlsAlphabetException}
48
+ # * {UnsupportedPlsLanguageException}
49
+ #
50
+ # Additionally, error classes are dynamically generated for service errors based on the error code
51
+ # if they are not defined above.
9
52
  module Errors
10
53
 
11
54
  extend Aws::Errors::DynamicErrors
@@ -23,7 +66,6 @@ module Aws::Polly
23
66
  def message
24
67
  @message || @data[:message]
25
68
  end
26
-
27
69
  end
28
70
 
29
71
  class InvalidLexiconException < ServiceError
@@ -39,7 +81,6 @@ module Aws::Polly
39
81
  def message
40
82
  @message || @data[:message]
41
83
  end
42
-
43
84
  end
44
85
 
45
86
  class InvalidNextTokenException < ServiceError
@@ -55,7 +96,6 @@ module Aws::Polly
55
96
  def message
56
97
  @message || @data[:message]
57
98
  end
58
-
59
99
  end
60
100
 
61
101
  class InvalidS3BucketException < ServiceError
@@ -71,7 +111,6 @@ module Aws::Polly
71
111
  def message
72
112
  @message || @data[:message]
73
113
  end
74
-
75
114
  end
76
115
 
77
116
  class InvalidS3KeyException < ServiceError
@@ -87,7 +126,6 @@ module Aws::Polly
87
126
  def message
88
127
  @message || @data[:message]
89
128
  end
90
-
91
129
  end
92
130
 
93
131
  class InvalidSampleRateException < ServiceError
@@ -103,7 +141,6 @@ module Aws::Polly
103
141
  def message
104
142
  @message || @data[:message]
105
143
  end
106
-
107
144
  end
108
145
 
109
146
  class InvalidSnsTopicArnException < ServiceError
@@ -119,7 +156,6 @@ module Aws::Polly
119
156
  def message
120
157
  @message || @data[:message]
121
158
  end
122
-
123
159
  end
124
160
 
125
161
  class InvalidSsmlException < ServiceError
@@ -135,7 +171,6 @@ module Aws::Polly
135
171
  def message
136
172
  @message || @data[:message]
137
173
  end
138
-
139
174
  end
140
175
 
141
176
  class InvalidTaskIdException < ServiceError
@@ -151,7 +186,6 @@ module Aws::Polly
151
186
  def message
152
187
  @message || @data[:message]
153
188
  end
154
-
155
189
  end
156
190
 
157
191
  class LanguageNotSupportedException < ServiceError
@@ -167,7 +201,6 @@ module Aws::Polly
167
201
  def message
168
202
  @message || @data[:message]
169
203
  end
170
-
171
204
  end
172
205
 
173
206
  class LexiconNotFoundException < ServiceError
@@ -183,7 +216,6 @@ module Aws::Polly
183
216
  def message
184
217
  @message || @data[:message]
185
218
  end
186
-
187
219
  end
188
220
 
189
221
  class LexiconSizeExceededException < ServiceError
@@ -199,7 +231,6 @@ module Aws::Polly
199
231
  def message
200
232
  @message || @data[:message]
201
233
  end
202
-
203
234
  end
204
235
 
205
236
  class MarksNotSupportedForFormatException < ServiceError
@@ -215,7 +246,6 @@ module Aws::Polly
215
246
  def message
216
247
  @message || @data[:message]
217
248
  end
218
-
219
249
  end
220
250
 
221
251
  class MaxLexemeLengthExceededException < ServiceError
@@ -231,7 +261,6 @@ module Aws::Polly
231
261
  def message
232
262
  @message || @data[:message]
233
263
  end
234
-
235
264
  end
236
265
 
237
266
  class MaxLexiconsNumberExceededException < ServiceError
@@ -247,7 +276,6 @@ module Aws::Polly
247
276
  def message
248
277
  @message || @data[:message]
249
278
  end
250
-
251
279
  end
252
280
 
253
281
  class ServiceFailureException < ServiceError
@@ -263,7 +291,6 @@ module Aws::Polly
263
291
  def message
264
292
  @message || @data[:message]
265
293
  end
266
-
267
294
  end
268
295
 
269
296
  class SsmlMarksNotSupportedForTextTypeException < ServiceError
@@ -279,7 +306,6 @@ module Aws::Polly
279
306
  def message
280
307
  @message || @data[:message]
281
308
  end
282
-
283
309
  end
284
310
 
285
311
  class SynthesisTaskNotFoundException < ServiceError
@@ -295,7 +321,6 @@ module Aws::Polly
295
321
  def message
296
322
  @message || @data[:message]
297
323
  end
298
-
299
324
  end
300
325
 
301
326
  class TextLengthExceededException < ServiceError
@@ -311,7 +336,6 @@ module Aws::Polly
311
336
  def message
312
337
  @message || @data[:message]
313
338
  end
314
-
315
339
  end
316
340
 
317
341
  class UnsupportedPlsAlphabetException < ServiceError
@@ -327,7 +351,6 @@ module Aws::Polly
327
351
  def message
328
352
  @message || @data[:message]
329
353
  end
330
-
331
354
  end
332
355
 
333
356
  class UnsupportedPlsLanguageException < ServiceError
@@ -343,7 +366,6 @@ module Aws::Polly
343
366
  def message
344
367
  @message || @data[:message]
345
368
  end
346
-
347
369
  end
348
370
 
349
371
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Polly
9
+ # This class provides a resource oriented interface for Polly.
10
+ # To create a resource object:
11
+ # resource = Aws::Polly::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::Polly::Client.new(region: 'us-west-2')
15
+ # resource = Aws::Polly::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-polly
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.27.0
4
+ version: 1.28.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-10-23 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