aws-sdk-workmail 1.21.0 → 1.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workmail.rb +7 -4
- data/lib/aws-sdk-workmail/client.rb +61 -10
- data/lib/aws-sdk-workmail/errors.rb +41 -19
- data/lib/aws-sdk-workmail/resource.rb +7 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d1b6fee2823bb80d44e66d79644c07ca2f458684
|
4
|
+
data.tar.gz: bb23998cae974e30d04c4316eb327c2c36c24a4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a1547998119557b14d08bf767e4c2a004510f3c6eb3f20aef16642d0a1a5934ea678300bb38a3516a9c6b7658891dc1cf9f678398a64845fae77e032713c324
|
7
|
+
data.tar.gz: 64b084ccc6f53d455cacc4af8dbf8878a5edf50819036b615ab7536ee4cc52dac1d73b1426d28e701b8605e35ef1f6bdd5d8c59e15d4aeabfbc282c4b2c099ea
|
data/lib/aws-sdk-workmail.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-workmail/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# work_mail = Aws::WorkMail::Client.new
|
28
|
+
# resp = work_mail.associate_delegate_to_resource(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon WorkMail
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon WorkMail 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::WorkMail::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon WorkMail API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-workmail/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::WorkMail
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.22.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(:workmail)
|
31
31
|
|
32
32
|
module Aws::WorkMail
|
33
|
+
# An API client for WorkMail. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::WorkMail::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::WorkMail
|
|
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::WorkMail
|
|
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::WorkMail
|
|
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.
|
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::WorkMail
|
|
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
|
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)
|
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::WorkMail
|
|
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
|
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
|
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
|
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::WorkMail
|
|
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
|
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`.
|
@@ -1810,7 +1861,7 @@ module Aws::WorkMail
|
|
1810
1861
|
params: params,
|
1811
1862
|
config: config)
|
1812
1863
|
context[:gem_name] = 'aws-sdk-workmail'
|
1813
|
-
context[:gem_version] = '1.
|
1864
|
+
context[:gem_version] = '1.22.0'
|
1814
1865
|
Seahorse::Client::Request.new(handlers, context)
|
1815
1866
|
end
|
1816
1867
|
|
@@ -6,6 +6,47 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::WorkMail
|
9
|
+
|
10
|
+
# When WorkMail returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::WorkMail::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all WorkMail errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::WorkMail::Errors::ServiceError
|
18
|
+
# # rescues all WorkMail 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
|
+
# * {DirectoryServiceAuthenticationFailedException}
|
29
|
+
# * {DirectoryUnavailableException}
|
30
|
+
# * {EmailAddressInUseException}
|
31
|
+
# * {EntityAlreadyRegisteredException}
|
32
|
+
# * {EntityNotFoundException}
|
33
|
+
# * {EntityStateException}
|
34
|
+
# * {InvalidConfigurationException}
|
35
|
+
# * {InvalidParameterException}
|
36
|
+
# * {InvalidPasswordException}
|
37
|
+
# * {LimitExceededException}
|
38
|
+
# * {MailDomainNotFoundException}
|
39
|
+
# * {MailDomainStateException}
|
40
|
+
# * {NameAvailabilityException}
|
41
|
+
# * {OrganizationNotFoundException}
|
42
|
+
# * {OrganizationStateException}
|
43
|
+
# * {ReservedNameException}
|
44
|
+
# * {ResourceNotFoundException}
|
45
|
+
# * {TooManyTagsException}
|
46
|
+
# * {UnsupportedOperationException}
|
47
|
+
#
|
48
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
49
|
+
# if they are not defined above.
|
9
50
|
module Errors
|
10
51
|
|
11
52
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +64,6 @@ module Aws::WorkMail
|
|
23
64
|
def message
|
24
65
|
@message || @data[:message]
|
25
66
|
end
|
26
|
-
|
27
67
|
end
|
28
68
|
|
29
69
|
class DirectoryUnavailableException < ServiceError
|
@@ -39,7 +79,6 @@ module Aws::WorkMail
|
|
39
79
|
def message
|
40
80
|
@message || @data[:message]
|
41
81
|
end
|
42
|
-
|
43
82
|
end
|
44
83
|
|
45
84
|
class EmailAddressInUseException < ServiceError
|
@@ -55,7 +94,6 @@ module Aws::WorkMail
|
|
55
94
|
def message
|
56
95
|
@message || @data[:message]
|
57
96
|
end
|
58
|
-
|
59
97
|
end
|
60
98
|
|
61
99
|
class EntityAlreadyRegisteredException < ServiceError
|
@@ -71,7 +109,6 @@ module Aws::WorkMail
|
|
71
109
|
def message
|
72
110
|
@message || @data[:message]
|
73
111
|
end
|
74
|
-
|
75
112
|
end
|
76
113
|
|
77
114
|
class EntityNotFoundException < ServiceError
|
@@ -87,7 +124,6 @@ module Aws::WorkMail
|
|
87
124
|
def message
|
88
125
|
@message || @data[:message]
|
89
126
|
end
|
90
|
-
|
91
127
|
end
|
92
128
|
|
93
129
|
class EntityStateException < ServiceError
|
@@ -103,7 +139,6 @@ module Aws::WorkMail
|
|
103
139
|
def message
|
104
140
|
@message || @data[:message]
|
105
141
|
end
|
106
|
-
|
107
142
|
end
|
108
143
|
|
109
144
|
class InvalidConfigurationException < ServiceError
|
@@ -119,7 +154,6 @@ module Aws::WorkMail
|
|
119
154
|
def message
|
120
155
|
@message || @data[:message]
|
121
156
|
end
|
122
|
-
|
123
157
|
end
|
124
158
|
|
125
159
|
class InvalidParameterException < ServiceError
|
@@ -135,7 +169,6 @@ module Aws::WorkMail
|
|
135
169
|
def message
|
136
170
|
@message || @data[:message]
|
137
171
|
end
|
138
|
-
|
139
172
|
end
|
140
173
|
|
141
174
|
class InvalidPasswordException < ServiceError
|
@@ -151,7 +184,6 @@ module Aws::WorkMail
|
|
151
184
|
def message
|
152
185
|
@message || @data[:message]
|
153
186
|
end
|
154
|
-
|
155
187
|
end
|
156
188
|
|
157
189
|
class LimitExceededException < ServiceError
|
@@ -167,7 +199,6 @@ module Aws::WorkMail
|
|
167
199
|
def message
|
168
200
|
@message || @data[:message]
|
169
201
|
end
|
170
|
-
|
171
202
|
end
|
172
203
|
|
173
204
|
class MailDomainNotFoundException < ServiceError
|
@@ -183,7 +214,6 @@ module Aws::WorkMail
|
|
183
214
|
def message
|
184
215
|
@message || @data[:message]
|
185
216
|
end
|
186
|
-
|
187
217
|
end
|
188
218
|
|
189
219
|
class MailDomainStateException < ServiceError
|
@@ -199,7 +229,6 @@ module Aws::WorkMail
|
|
199
229
|
def message
|
200
230
|
@message || @data[:message]
|
201
231
|
end
|
202
|
-
|
203
232
|
end
|
204
233
|
|
205
234
|
class NameAvailabilityException < ServiceError
|
@@ -215,7 +244,6 @@ module Aws::WorkMail
|
|
215
244
|
def message
|
216
245
|
@message || @data[:message]
|
217
246
|
end
|
218
|
-
|
219
247
|
end
|
220
248
|
|
221
249
|
class OrganizationNotFoundException < ServiceError
|
@@ -231,7 +259,6 @@ module Aws::WorkMail
|
|
231
259
|
def message
|
232
260
|
@message || @data[:message]
|
233
261
|
end
|
234
|
-
|
235
262
|
end
|
236
263
|
|
237
264
|
class OrganizationStateException < ServiceError
|
@@ -247,7 +274,6 @@ module Aws::WorkMail
|
|
247
274
|
def message
|
248
275
|
@message || @data[:message]
|
249
276
|
end
|
250
|
-
|
251
277
|
end
|
252
278
|
|
253
279
|
class ReservedNameException < ServiceError
|
@@ -263,7 +289,6 @@ module Aws::WorkMail
|
|
263
289
|
def message
|
264
290
|
@message || @data[:message]
|
265
291
|
end
|
266
|
-
|
267
292
|
end
|
268
293
|
|
269
294
|
class ResourceNotFoundException < ServiceError
|
@@ -279,7 +304,6 @@ module Aws::WorkMail
|
|
279
304
|
def message
|
280
305
|
@message || @data[:message]
|
281
306
|
end
|
282
|
-
|
283
307
|
end
|
284
308
|
|
285
309
|
class TooManyTagsException < ServiceError
|
@@ -295,7 +319,6 @@ module Aws::WorkMail
|
|
295
319
|
def message
|
296
320
|
@message || @data[:message]
|
297
321
|
end
|
298
|
-
|
299
322
|
end
|
300
323
|
|
301
324
|
class UnsupportedOperationException < ServiceError
|
@@ -311,7 +334,6 @@ module Aws::WorkMail
|
|
311
334
|
def message
|
312
335
|
@message || @data[:message]
|
313
336
|
end
|
314
|
-
|
315
337
|
end
|
316
338
|
|
317
339
|
end
|
@@ -6,6 +6,13 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::WorkMail
|
9
|
+
# This class provides a resource oriented interface for WorkMail.
|
10
|
+
# To create a resource object:
|
11
|
+
# resource = Aws::WorkMail::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::WorkMail::Client.new(region: 'us-west-2')
|
15
|
+
# resource = Aws::WorkMail::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-workmail
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
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: 2020-
|
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
|