aws-sdk-alexaforbusiness 1.33.0 → 1.34.0

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
2
  SHA1:
3
- metadata.gz: 9439eaa85190997b66079493f391ecd382980468
4
- data.tar.gz: fb6f1de73811b9e533d0b04b693d31c773849a5e
3
+ metadata.gz: e23a96983210d0e2ee08cbd009bd1321ae8f5685
4
+ data.tar.gz: f217c7700248578bf747c45bc2576341b85791a2
5
5
  SHA512:
6
- metadata.gz: 97a0e6a57b005511bba34fe54a107cb1b679c88c0aba084e9258e413ee3c6fbe0f9110269e81e853548e6ae8e6ad6e790ebc840fed93c99c10e4b7c0f594b943
7
- data.tar.gz: 4fa6f52536de58e4226bfaed5891427a282beb036d0e2e5eef690a39163e0c04ce2149c12baa98671c5d6324e3f5f209f04a212075a26bf6227e222f0cb59e3d
6
+ metadata.gz: 29d02e7480d0a96c3b57904610b2219b5e3f1b522cd7bca1c88fbd853629f53479dc770acdef79eb87a8e6c1ee6bbc99acf54bd12e74d9aa495dcc1589c9accc
7
+ data.tar.gz: 4207f59e94a1f6045a9dd0adac6da7e7ed760121243b34b52820c074787b29a0d6222a7501690e85091a101eebbc858ad5efeb148a192126b0408f3298981a88
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-alexaforbusiness/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # alexa_for_business = Aws::AlexaForBusiness::Client.new
28
+ # resp = alexa_for_business.approve_skill(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Alexa For Business all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Alexa For Business 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::AlexaForBusiness::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Alexa For Business API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-alexaforbusiness/customizations'
42
45
  # @service
43
46
  module Aws::AlexaForBusiness
44
47
 
45
- GEM_VERSION = '1.33.0'
48
+ GEM_VERSION = '1.34.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:alexaforbusiness)
31
31
 
32
32
  module Aws::AlexaForBusiness
33
+ # An API client for AlexaForBusiness. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::AlexaForBusiness::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::AlexaForBusiness
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::AlexaForBusiness
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::AlexaForBusiness
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::AlexaForBusiness
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
  #
@@ -219,16 +270,16 @@ module Aws::AlexaForBusiness
219
270
  # requests through. Formatted like 'http://proxy.com:123'.
220
271
  #
221
272
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
273
+ # seconds to wait when opening a HTTP session before raising a
223
274
  # `Timeout::Error`.
224
275
  #
225
276
  # @option options [Integer] :http_read_timeout (60) The default
226
277
  # number of seconds to wait for response data. This value can
227
278
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
279
+ # per-request on the session yielded by {#session_for}.
229
280
  #
230
281
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
282
+ # seconds a connection is allowed to sit idle before it is
232
283
  # considered stale. Stale connections are closed and removed
233
284
  # from the pool before making a request.
234
285
  #
@@ -237,7 +288,7 @@ module Aws::AlexaForBusiness
237
288
  # request body. This option has no effect unless the request has
238
289
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
290
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
291
+ # request on the session yielded by {#session_for}.
241
292
  #
242
293
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
294
  # HTTP debug output will be sent to the `:logger`.
@@ -4019,7 +4070,7 @@ module Aws::AlexaForBusiness
4019
4070
  params: params,
4020
4071
  config: config)
4021
4072
  context[:gem_name] = 'aws-sdk-alexaforbusiness'
4022
- context[:gem_version] = '1.33.0'
4073
+ context[:gem_version] = '1.34.0'
4023
4074
  Seahorse::Client::Request.new(handlers, context)
4024
4075
  end
4025
4076
 
@@ -6,6 +6,43 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AlexaForBusiness
9
+
10
+ # When AlexaForBusiness returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::AlexaForBusiness::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all AlexaForBusiness errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::AlexaForBusiness::Errors::ServiceError
18
+ # # rescues all AlexaForBusiness 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
+ # * {AlreadyExistsException}
29
+ # * {ConcurrentModificationException}
30
+ # * {DeviceNotRegisteredException}
31
+ # * {InvalidCertificateAuthorityException}
32
+ # * {InvalidDeviceException}
33
+ # * {InvalidSecretsManagerResourceException}
34
+ # * {InvalidServiceLinkedRoleStateException}
35
+ # * {InvalidUserStatusException}
36
+ # * {LimitExceededException}
37
+ # * {NameInUseException}
38
+ # * {NotFoundException}
39
+ # * {ResourceAssociatedException}
40
+ # * {ResourceInUseException}
41
+ # * {SkillNotLinkedException}
42
+ # * {UnauthorizedException}
43
+ #
44
+ # Additionally, error classes are dynamically generated for service errors based on the error code
45
+ # if they are not defined above.
9
46
  module Errors
10
47
 
11
48
  extend Aws::Errors::DynamicErrors
@@ -23,7 +60,6 @@ module Aws::AlexaForBusiness
23
60
  def message
24
61
  @message || @data[:message]
25
62
  end
26
-
27
63
  end
28
64
 
29
65
  class ConcurrentModificationException < ServiceError
@@ -39,7 +75,6 @@ module Aws::AlexaForBusiness
39
75
  def message
40
76
  @message || @data[:message]
41
77
  end
42
-
43
78
  end
44
79
 
45
80
  class DeviceNotRegisteredException < ServiceError
@@ -55,7 +90,6 @@ module Aws::AlexaForBusiness
55
90
  def message
56
91
  @message || @data[:message]
57
92
  end
58
-
59
93
  end
60
94
 
61
95
  class InvalidCertificateAuthorityException < ServiceError
@@ -71,7 +105,6 @@ module Aws::AlexaForBusiness
71
105
  def message
72
106
  @message || @data[:message]
73
107
  end
74
-
75
108
  end
76
109
 
77
110
  class InvalidDeviceException < ServiceError
@@ -87,7 +120,6 @@ module Aws::AlexaForBusiness
87
120
  def message
88
121
  @message || @data[:message]
89
122
  end
90
-
91
123
  end
92
124
 
93
125
  class InvalidSecretsManagerResourceException < ServiceError
@@ -103,7 +135,6 @@ module Aws::AlexaForBusiness
103
135
  def message
104
136
  @message || @data[:message]
105
137
  end
106
-
107
138
  end
108
139
 
109
140
  class InvalidServiceLinkedRoleStateException < ServiceError
@@ -119,7 +150,6 @@ module Aws::AlexaForBusiness
119
150
  def message
120
151
  @message || @data[:message]
121
152
  end
122
-
123
153
  end
124
154
 
125
155
  class InvalidUserStatusException < ServiceError
@@ -135,7 +165,6 @@ module Aws::AlexaForBusiness
135
165
  def message
136
166
  @message || @data[:message]
137
167
  end
138
-
139
168
  end
140
169
 
141
170
  class LimitExceededException < ServiceError
@@ -151,7 +180,6 @@ module Aws::AlexaForBusiness
151
180
  def message
152
181
  @message || @data[:message]
153
182
  end
154
-
155
183
  end
156
184
 
157
185
  class NameInUseException < ServiceError
@@ -167,7 +195,6 @@ module Aws::AlexaForBusiness
167
195
  def message
168
196
  @message || @data[:message]
169
197
  end
170
-
171
198
  end
172
199
 
173
200
  class NotFoundException < ServiceError
@@ -183,7 +210,6 @@ module Aws::AlexaForBusiness
183
210
  def message
184
211
  @message || @data[:message]
185
212
  end
186
-
187
213
  end
188
214
 
189
215
  class ResourceAssociatedException < ServiceError
@@ -199,7 +225,6 @@ module Aws::AlexaForBusiness
199
225
  def message
200
226
  @message || @data[:message]
201
227
  end
202
-
203
228
  end
204
229
 
205
230
  class ResourceInUseException < ServiceError
@@ -220,7 +245,6 @@ module Aws::AlexaForBusiness
220
245
  def client_request_token
221
246
  @data[:client_request_token]
222
247
  end
223
-
224
248
  end
225
249
 
226
250
  class SkillNotLinkedException < ServiceError
@@ -236,7 +260,6 @@ module Aws::AlexaForBusiness
236
260
  def message
237
261
  @message || @data[:message]
238
262
  end
239
-
240
263
  end
241
264
 
242
265
  class UnauthorizedException < ServiceError
@@ -252,7 +275,6 @@ module Aws::AlexaForBusiness
252
275
  def message
253
276
  @message || @data[:message]
254
277
  end
255
-
256
278
  end
257
279
 
258
280
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AlexaForBusiness
9
+ # This class provides a resource oriented interface for AlexaForBusiness.
10
+ # To create a resource object:
11
+ # resource = Aws::AlexaForBusiness::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::AlexaForBusiness::Client.new(region: 'us-west-2')
15
+ # resource = Aws::AlexaForBusiness::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-alexaforbusiness
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.33.0
4
+ version: 1.34.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: 2020-01-20 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