aws-sdk-chime 1.20.0 → 1.21.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: fdfce7bf5fb35ef93cc25a235bbc3ebe0bb0595c
4
- data.tar.gz: 370ce4f438b218a53a98a3e61b32b5280ed8b39c
3
+ metadata.gz: 92da1b534b563ca9306c9a90f6b788b82adfd5bb
4
+ data.tar.gz: 729c5f65d6af8513761c998681e4a1559ac315de
5
5
  SHA512:
6
- metadata.gz: ddeee1a18b3cd6b0e178019b4a9ce51c8cde1766dd6bc3900b42cbcc1fbb2ba82fe092a97ff7abfee2482cfd2663ce8c44cc4f6e4a8522e06707d8c278fe4403
7
- data.tar.gz: 90a98f95377c91441d1e4422565d9290bc4f9f4429779ef1185ac4fc12185c7c18e422c7b0daf702a44a392e9e4232b9f912caaaff7c3237ba33bb8b17212aa3
6
+ metadata.gz: e3dd034162d5fd12c3add3cbd3f2ef20ff6e04ef579aa9bc8b4295013a699b0a3396debe978347ec6f2c330c4821a6ff84646ba9219e975a5999408757011085
7
+ data.tar.gz: 7bdbec97765b0fe1b296d3331bbd125a56484c86e93de8b961ebfca393900e6fcc29655b6041f673965b94a7ff7d4fdbe4db31a4a7ff38b0292c3b7a4d29ee08
data/lib/aws-sdk-chime.rb CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-chime/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # chime = Aws::Chime::Client.new
28
+ # resp = chime.associate_phone_number_with_user(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Chime all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Chime 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::Chime::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Chime API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-chime/customizations'
42
45
  # @service
43
46
  module Aws::Chime
44
47
 
45
- GEM_VERSION = '1.20.0'
48
+ GEM_VERSION = '1.21.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(:chime)
31
31
 
32
32
  module Aws::Chime
33
+ # An API client for Chime. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Chime::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::Chime
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::Chime
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::Chime
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::Chime
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::Chime
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::Chime
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`.
@@ -4055,7 +4106,7 @@ module Aws::Chime
4055
4106
  params: params,
4056
4107
  config: config)
4057
4108
  context[:gem_name] = 'aws-sdk-chime'
4058
- context[:gem_version] = '1.20.0'
4109
+ context[:gem_version] = '1.21.0'
4059
4110
  Seahorse::Client::Request.new(handlers, context)
4060
4111
  end
4061
4112
 
@@ -6,6 +6,39 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Chime
9
+
10
+ # When Chime returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Chime::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Chime errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Chime::Errors::ServiceError
18
+ # # rescues all Chime 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
+ # * {AccessDeniedException}
29
+ # * {BadRequestException}
30
+ # * {ConflictException}
31
+ # * {ForbiddenException}
32
+ # * {NotFoundException}
33
+ # * {ResourceLimitExceededException}
34
+ # * {ServiceFailureException}
35
+ # * {ServiceUnavailableException}
36
+ # * {ThrottledClientException}
37
+ # * {UnauthorizedClientException}
38
+ # * {UnprocessableEntityException}
39
+ #
40
+ # Additionally, error classes are dynamically generated for service errors based on the error code
41
+ # if they are not defined above.
9
42
  module Errors
10
43
 
11
44
  extend Aws::Errors::DynamicErrors
@@ -28,7 +61,6 @@ module Aws::Chime
28
61
  def message
29
62
  @message || @data[:message]
30
63
  end
31
-
32
64
  end
33
65
 
34
66
  class BadRequestException < ServiceError
@@ -49,7 +81,6 @@ module Aws::Chime
49
81
  def message
50
82
  @message || @data[:message]
51
83
  end
52
-
53
84
  end
54
85
 
55
86
  class ConflictException < ServiceError
@@ -70,7 +101,6 @@ module Aws::Chime
70
101
  def message
71
102
  @message || @data[:message]
72
103
  end
73
-
74
104
  end
75
105
 
76
106
  class ForbiddenException < ServiceError
@@ -91,7 +121,6 @@ module Aws::Chime
91
121
  def message
92
122
  @message || @data[:message]
93
123
  end
94
-
95
124
  end
96
125
 
97
126
  class NotFoundException < ServiceError
@@ -112,7 +141,6 @@ module Aws::Chime
112
141
  def message
113
142
  @message || @data[:message]
114
143
  end
115
-
116
144
  end
117
145
 
118
146
  class ResourceLimitExceededException < ServiceError
@@ -133,7 +161,6 @@ module Aws::Chime
133
161
  def message
134
162
  @message || @data[:message]
135
163
  end
136
-
137
164
  end
138
165
 
139
166
  class ServiceFailureException < ServiceError
@@ -154,7 +181,6 @@ module Aws::Chime
154
181
  def message
155
182
  @message || @data[:message]
156
183
  end
157
-
158
184
  end
159
185
 
160
186
  class ServiceUnavailableException < ServiceError
@@ -175,7 +201,6 @@ module Aws::Chime
175
201
  def message
176
202
  @message || @data[:message]
177
203
  end
178
-
179
204
  end
180
205
 
181
206
  class ThrottledClientException < ServiceError
@@ -196,7 +221,6 @@ module Aws::Chime
196
221
  def message
197
222
  @message || @data[:message]
198
223
  end
199
-
200
224
  end
201
225
 
202
226
  class UnauthorizedClientException < ServiceError
@@ -217,7 +241,6 @@ module Aws::Chime
217
241
  def message
218
242
  @message || @data[:message]
219
243
  end
220
-
221
244
  end
222
245
 
223
246
  class UnprocessableEntityException < ServiceError
@@ -238,7 +261,6 @@ module Aws::Chime
238
261
  def message
239
262
  @message || @data[:message]
240
263
  end
241
-
242
264
  end
243
265
 
244
266
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Chime
9
+ # This class provides a resource oriented interface for Chime.
10
+ # To create a resource object:
11
+ # resource = Aws::Chime::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::Chime::Client.new(region: 'us-west-2')
15
+ # resource = Aws::Chime::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-chime
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.20.0
4
+ version: 1.21.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-02-18 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