aws-sdk-workmail 1.0.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 +7 -0
- data/lib/aws-sdk-workmail.rb +47 -0
- data/lib/aws-sdk-workmail/client.rb +1245 -0
- data/lib/aws-sdk-workmail/client_api.rb +865 -0
- data/lib/aws-sdk-workmail/customizations.rb +0 -0
- data/lib/aws-sdk-workmail/errors.rb +14 -0
- data/lib/aws-sdk-workmail/resource.rb +23 -0
- data/lib/aws-sdk-workmail/types.rb +1506 -0
- metadata +82 -0
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkMail
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkMail
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1506 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkMail
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass AssociateDelegateToResourceRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# organization_id: "OrganizationId", # required
|
16
|
+
# resource_id: "ResourceId", # required
|
17
|
+
# entity_id: "WorkMailIdentifier", # required
|
18
|
+
# }
|
19
|
+
#
|
20
|
+
# @!attribute [rw] organization_id
|
21
|
+
# The organization under which the resource exists.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] resource_id
|
25
|
+
# The resource for which members are associated.
|
26
|
+
# @return [String]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] entity_id
|
29
|
+
# The member (user or group) to associate to the resource.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceRequest AWS API Documentation
|
33
|
+
#
|
34
|
+
class AssociateDelegateToResourceRequest < Struct.new(
|
35
|
+
:organization_id,
|
36
|
+
:resource_id,
|
37
|
+
:entity_id)
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceResponse AWS API Documentation
|
42
|
+
#
|
43
|
+
class AssociateDelegateToResourceResponse < Aws::EmptyStructure; end
|
44
|
+
|
45
|
+
# @note When making an API call, you may pass AssociateMemberToGroupRequest
|
46
|
+
# data as a hash:
|
47
|
+
#
|
48
|
+
# {
|
49
|
+
# organization_id: "OrganizationId", # required
|
50
|
+
# group_id: "WorkMailIdentifier", # required
|
51
|
+
# member_id: "WorkMailIdentifier", # required
|
52
|
+
# }
|
53
|
+
#
|
54
|
+
# @!attribute [rw] organization_id
|
55
|
+
# The organization under which the group exists.
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
# @!attribute [rw] group_id
|
59
|
+
# The group for which the member is associated.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] member_id
|
63
|
+
# The member to associate to the group.
|
64
|
+
# @return [String]
|
65
|
+
#
|
66
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupRequest AWS API Documentation
|
67
|
+
#
|
68
|
+
class AssociateMemberToGroupRequest < Struct.new(
|
69
|
+
:organization_id,
|
70
|
+
:group_id,
|
71
|
+
:member_id)
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupResponse AWS API Documentation
|
76
|
+
#
|
77
|
+
class AssociateMemberToGroupResponse < Aws::EmptyStructure; end
|
78
|
+
|
79
|
+
# At least one delegate must be associated to the resource to disable
|
80
|
+
# automatic replies from the resource.
|
81
|
+
#
|
82
|
+
# @note When making an API call, you may pass BookingOptions
|
83
|
+
# data as a hash:
|
84
|
+
#
|
85
|
+
# {
|
86
|
+
# auto_accept_requests: false,
|
87
|
+
# auto_decline_recurring_requests: false,
|
88
|
+
# auto_decline_conflicting_requests: false,
|
89
|
+
# }
|
90
|
+
#
|
91
|
+
# @!attribute [rw] auto_accept_requests
|
92
|
+
# The resource's ability to automatically reply to requests. If
|
93
|
+
# disabled, delegates must be associated to the resource.
|
94
|
+
# @return [Boolean]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] auto_decline_recurring_requests
|
97
|
+
# The resource's ability to automatically decline any recurring
|
98
|
+
# requests.
|
99
|
+
# @return [Boolean]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] auto_decline_conflicting_requests
|
102
|
+
# The resource's ability to automatically decline any conflicting
|
103
|
+
# requests.
|
104
|
+
# @return [Boolean]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/BookingOptions AWS API Documentation
|
107
|
+
#
|
108
|
+
class BookingOptions < Struct.new(
|
109
|
+
:auto_accept_requests,
|
110
|
+
:auto_decline_recurring_requests,
|
111
|
+
:auto_decline_conflicting_requests)
|
112
|
+
include Aws::Structure
|
113
|
+
end
|
114
|
+
|
115
|
+
# @note When making an API call, you may pass CreateAliasRequest
|
116
|
+
# data as a hash:
|
117
|
+
#
|
118
|
+
# {
|
119
|
+
# organization_id: "OrganizationId", # required
|
120
|
+
# entity_id: "WorkMailIdentifier", # required
|
121
|
+
# alias: "EmailAddress", # required
|
122
|
+
# }
|
123
|
+
#
|
124
|
+
# @!attribute [rw] organization_id
|
125
|
+
# The organization under which the member exists.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] entity_id
|
129
|
+
# The alias is added to this Amazon WorkMail entity.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] alias
|
133
|
+
# The alias to add to the user.
|
134
|
+
# @return [String]
|
135
|
+
#
|
136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasRequest AWS API Documentation
|
137
|
+
#
|
138
|
+
class CreateAliasRequest < Struct.new(
|
139
|
+
:organization_id,
|
140
|
+
:entity_id,
|
141
|
+
:alias)
|
142
|
+
include Aws::Structure
|
143
|
+
end
|
144
|
+
|
145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasResponse AWS API Documentation
|
146
|
+
#
|
147
|
+
class CreateAliasResponse < Aws::EmptyStructure; end
|
148
|
+
|
149
|
+
# @note When making an API call, you may pass CreateGroupRequest
|
150
|
+
# data as a hash:
|
151
|
+
#
|
152
|
+
# {
|
153
|
+
# organization_id: "OrganizationId", # required
|
154
|
+
# name: "GroupName", # required
|
155
|
+
# }
|
156
|
+
#
|
157
|
+
# @!attribute [rw] organization_id
|
158
|
+
# The organization under which the group is to be created.
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] name
|
162
|
+
# The name of the group.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupRequest AWS API Documentation
|
166
|
+
#
|
167
|
+
class CreateGroupRequest < Struct.new(
|
168
|
+
:organization_id,
|
169
|
+
:name)
|
170
|
+
include Aws::Structure
|
171
|
+
end
|
172
|
+
|
173
|
+
# @!attribute [rw] group_id
|
174
|
+
# The ID of the group.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupResponse AWS API Documentation
|
178
|
+
#
|
179
|
+
class CreateGroupResponse < Struct.new(
|
180
|
+
:group_id)
|
181
|
+
include Aws::Structure
|
182
|
+
end
|
183
|
+
|
184
|
+
# @note When making an API call, you may pass CreateResourceRequest
|
185
|
+
# data as a hash:
|
186
|
+
#
|
187
|
+
# {
|
188
|
+
# organization_id: "OrganizationId", # required
|
189
|
+
# name: "ResourceName", # required
|
190
|
+
# type: "ROOM", # required, accepts ROOM, EQUIPMENT
|
191
|
+
# }
|
192
|
+
#
|
193
|
+
# @!attribute [rw] organization_id
|
194
|
+
# The identifier associated with the organization for which the
|
195
|
+
# resource is created.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] name
|
199
|
+
# The name of the created resource.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] type
|
203
|
+
# The type of the created resource.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceRequest AWS API Documentation
|
207
|
+
#
|
208
|
+
class CreateResourceRequest < Struct.new(
|
209
|
+
:organization_id,
|
210
|
+
:name,
|
211
|
+
:type)
|
212
|
+
include Aws::Structure
|
213
|
+
end
|
214
|
+
|
215
|
+
# @!attribute [rw] resource_id
|
216
|
+
# The identifier of the created resource.
|
217
|
+
# @return [String]
|
218
|
+
#
|
219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceResponse AWS API Documentation
|
220
|
+
#
|
221
|
+
class CreateResourceResponse < Struct.new(
|
222
|
+
:resource_id)
|
223
|
+
include Aws::Structure
|
224
|
+
end
|
225
|
+
|
226
|
+
# @note When making an API call, you may pass CreateUserRequest
|
227
|
+
# data as a hash:
|
228
|
+
#
|
229
|
+
# {
|
230
|
+
# organization_id: "OrganizationId", # required
|
231
|
+
# name: "UserName", # required
|
232
|
+
# display_name: "String", # required
|
233
|
+
# password: "Password", # required
|
234
|
+
# }
|
235
|
+
#
|
236
|
+
# @!attribute [rw] organization_id
|
237
|
+
# The identifier of the organization for which the user is created.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] name
|
241
|
+
# The name for the user to be created.
|
242
|
+
# @return [String]
|
243
|
+
#
|
244
|
+
# @!attribute [rw] display_name
|
245
|
+
# The display name for the user to be created.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @!attribute [rw] password
|
249
|
+
# The password for the user to be created.
|
250
|
+
# @return [String]
|
251
|
+
#
|
252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserRequest AWS API Documentation
|
253
|
+
#
|
254
|
+
class CreateUserRequest < Struct.new(
|
255
|
+
:organization_id,
|
256
|
+
:name,
|
257
|
+
:display_name,
|
258
|
+
:password)
|
259
|
+
include Aws::Structure
|
260
|
+
end
|
261
|
+
|
262
|
+
# @!attribute [rw] user_id
|
263
|
+
# The information regarding the newly created user.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserResponse AWS API Documentation
|
267
|
+
#
|
268
|
+
class CreateUserResponse < Struct.new(
|
269
|
+
:user_id)
|
270
|
+
include Aws::Structure
|
271
|
+
end
|
272
|
+
|
273
|
+
# The name of the attribute, which is one of the values defined in the
|
274
|
+
# UserAttribute enumeration.
|
275
|
+
#
|
276
|
+
# @!attribute [rw] id
|
277
|
+
# The identifier for the user or group is associated as the
|
278
|
+
# resource's delegate.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] type
|
282
|
+
# The type of the delegate: user or group.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Delegate AWS API Documentation
|
286
|
+
#
|
287
|
+
class Delegate < Struct.new(
|
288
|
+
:id,
|
289
|
+
:type)
|
290
|
+
include Aws::Structure
|
291
|
+
end
|
292
|
+
|
293
|
+
# @note When making an API call, you may pass DeleteAliasRequest
|
294
|
+
# data as a hash:
|
295
|
+
#
|
296
|
+
# {
|
297
|
+
# organization_id: "OrganizationId", # required
|
298
|
+
# entity_id: "WorkMailIdentifier", # required
|
299
|
+
# alias: "EmailAddress", # required
|
300
|
+
# }
|
301
|
+
#
|
302
|
+
# @!attribute [rw] organization_id
|
303
|
+
# The identifier for the organization under which the user exists.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] entity_id
|
307
|
+
# The identifier for the Amazon WorkMail entity to have the aliases
|
308
|
+
# removed.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] alias
|
312
|
+
# The aliases to be removed from the user's set of aliases. Duplicate
|
313
|
+
# entries in the list are collapsed into single entries (the list is
|
314
|
+
# transformed into a set).
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasRequest AWS API Documentation
|
318
|
+
#
|
319
|
+
class DeleteAliasRequest < Struct.new(
|
320
|
+
:organization_id,
|
321
|
+
:entity_id,
|
322
|
+
:alias)
|
323
|
+
include Aws::Structure
|
324
|
+
end
|
325
|
+
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasResponse AWS API Documentation
|
327
|
+
#
|
328
|
+
class DeleteAliasResponse < Aws::EmptyStructure; end
|
329
|
+
|
330
|
+
# @note When making an API call, you may pass DeleteGroupRequest
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# organization_id: "OrganizationId", # required
|
335
|
+
# group_id: "WorkMailIdentifier", # required
|
336
|
+
# }
|
337
|
+
#
|
338
|
+
# @!attribute [rw] organization_id
|
339
|
+
# The organization that contains the group.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] group_id
|
343
|
+
# The identifier of the group to be deleted.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupRequest AWS API Documentation
|
347
|
+
#
|
348
|
+
class DeleteGroupRequest < Struct.new(
|
349
|
+
:organization_id,
|
350
|
+
:group_id)
|
351
|
+
include Aws::Structure
|
352
|
+
end
|
353
|
+
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupResponse AWS API Documentation
|
355
|
+
#
|
356
|
+
class DeleteGroupResponse < Aws::EmptyStructure; end
|
357
|
+
|
358
|
+
# @note When making an API call, you may pass DeleteResourceRequest
|
359
|
+
# data as a hash:
|
360
|
+
#
|
361
|
+
# {
|
362
|
+
# organization_id: "OrganizationId", # required
|
363
|
+
# resource_id: "ResourceId", # required
|
364
|
+
# }
|
365
|
+
#
|
366
|
+
# @!attribute [rw] organization_id
|
367
|
+
# The identifier associated with the organization for which the
|
368
|
+
# resource is deleted.
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] resource_id
|
372
|
+
# The identifier of the resource to be deleted.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceRequest AWS API Documentation
|
376
|
+
#
|
377
|
+
class DeleteResourceRequest < Struct.new(
|
378
|
+
:organization_id,
|
379
|
+
:resource_id)
|
380
|
+
include Aws::Structure
|
381
|
+
end
|
382
|
+
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceResponse AWS API Documentation
|
384
|
+
#
|
385
|
+
class DeleteResourceResponse < Aws::EmptyStructure; end
|
386
|
+
|
387
|
+
# @note When making an API call, you may pass DeleteUserRequest
|
388
|
+
# data as a hash:
|
389
|
+
#
|
390
|
+
# {
|
391
|
+
# organization_id: "OrganizationId", # required
|
392
|
+
# user_id: "WorkMailIdentifier", # required
|
393
|
+
# }
|
394
|
+
#
|
395
|
+
# @!attribute [rw] organization_id
|
396
|
+
# The organization that contains the user.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] user_id
|
400
|
+
# The identifier of the user to be deleted.
|
401
|
+
# @return [String]
|
402
|
+
#
|
403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserRequest AWS API Documentation
|
404
|
+
#
|
405
|
+
class DeleteUserRequest < Struct.new(
|
406
|
+
:organization_id,
|
407
|
+
:user_id)
|
408
|
+
include Aws::Structure
|
409
|
+
end
|
410
|
+
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserResponse AWS API Documentation
|
412
|
+
#
|
413
|
+
class DeleteUserResponse < Aws::EmptyStructure; end
|
414
|
+
|
415
|
+
# @note When making an API call, you may pass DeregisterFromWorkMailRequest
|
416
|
+
# data as a hash:
|
417
|
+
#
|
418
|
+
# {
|
419
|
+
# organization_id: "OrganizationId", # required
|
420
|
+
# entity_id: "WorkMailIdentifier", # required
|
421
|
+
# }
|
422
|
+
#
|
423
|
+
# @!attribute [rw] organization_id
|
424
|
+
# The identifier for the organization under which the Amazon WorkMail
|
425
|
+
# entity exists.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] entity_id
|
429
|
+
# The identifier for the entity to be updated.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailRequest AWS API Documentation
|
433
|
+
#
|
434
|
+
class DeregisterFromWorkMailRequest < Struct.new(
|
435
|
+
:organization_id,
|
436
|
+
:entity_id)
|
437
|
+
include Aws::Structure
|
438
|
+
end
|
439
|
+
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailResponse AWS API Documentation
|
441
|
+
#
|
442
|
+
class DeregisterFromWorkMailResponse < Aws::EmptyStructure; end
|
443
|
+
|
444
|
+
# @note When making an API call, you may pass DescribeGroupRequest
|
445
|
+
# data as a hash:
|
446
|
+
#
|
447
|
+
# {
|
448
|
+
# organization_id: "OrganizationId", # required
|
449
|
+
# group_id: "WorkMailIdentifier", # required
|
450
|
+
# }
|
451
|
+
#
|
452
|
+
# @!attribute [rw] organization_id
|
453
|
+
# The identifier for the organization under which the group exists.
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] group_id
|
457
|
+
# The identifier for the group to be described.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupRequest AWS API Documentation
|
461
|
+
#
|
462
|
+
class DescribeGroupRequest < Struct.new(
|
463
|
+
:organization_id,
|
464
|
+
:group_id)
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# @!attribute [rw] group_id
|
469
|
+
# The identifier of the described group.
|
470
|
+
# @return [String]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] name
|
473
|
+
# The name of the described group.
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @!attribute [rw] email
|
477
|
+
# The email of the described group.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @!attribute [rw] state
|
481
|
+
# The state of the user: enabled (registered to Amazon WorkMail) or
|
482
|
+
# disabled (deregistered or never registered to Amazon WorkMail).
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @!attribute [rw] enabled_date
|
486
|
+
# The date and time when a user was registered to Amazon WorkMail, in
|
487
|
+
# UNIX epoch time format.
|
488
|
+
# @return [Time]
|
489
|
+
#
|
490
|
+
# @!attribute [rw] disabled_date
|
491
|
+
# The date and time when a user was deregistered from Amazon WorkMail,
|
492
|
+
# in UNIX epoch time format.
|
493
|
+
# @return [Time]
|
494
|
+
#
|
495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupResponse AWS API Documentation
|
496
|
+
#
|
497
|
+
class DescribeGroupResponse < Struct.new(
|
498
|
+
:group_id,
|
499
|
+
:name,
|
500
|
+
:email,
|
501
|
+
:state,
|
502
|
+
:enabled_date,
|
503
|
+
:disabled_date)
|
504
|
+
include Aws::Structure
|
505
|
+
end
|
506
|
+
|
507
|
+
# @note When making an API call, you may pass DescribeOrganizationRequest
|
508
|
+
# data as a hash:
|
509
|
+
#
|
510
|
+
# {
|
511
|
+
# organization_id: "OrganizationId", # required
|
512
|
+
# }
|
513
|
+
#
|
514
|
+
# @!attribute [rw] organization_id
|
515
|
+
# The identifier for the organization to be described.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationRequest AWS API Documentation
|
519
|
+
#
|
520
|
+
class DescribeOrganizationRequest < Struct.new(
|
521
|
+
:organization_id)
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# @!attribute [rw] organization_id
|
526
|
+
# The identifier of an organization.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] alias
|
530
|
+
# The alias for an organization.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] state
|
534
|
+
# The state of an organization.
|
535
|
+
# @return [String]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] directory_id
|
538
|
+
# The identifier for the directory associated with an Amazon WorkMail
|
539
|
+
# organization.
|
540
|
+
# @return [String]
|
541
|
+
#
|
542
|
+
# @!attribute [rw] directory_type
|
543
|
+
# The type of directory associated with the Amazon WorkMail
|
544
|
+
# organization.
|
545
|
+
# @return [String]
|
546
|
+
#
|
547
|
+
# @!attribute [rw] default_mail_domain
|
548
|
+
# The default mail domain associated with the organization.
|
549
|
+
# @return [String]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] completed_date
|
552
|
+
# The date at which the organization became usable in the Amazon
|
553
|
+
# WorkMail context, in UNIX epoch time format.
|
554
|
+
# @return [Time]
|
555
|
+
#
|
556
|
+
# @!attribute [rw] error_message
|
557
|
+
# The (optional) error message indicating if unexpected behavior was
|
558
|
+
# encountered with regards to the organization.
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationResponse AWS API Documentation
|
562
|
+
#
|
563
|
+
class DescribeOrganizationResponse < Struct.new(
|
564
|
+
:organization_id,
|
565
|
+
:alias,
|
566
|
+
:state,
|
567
|
+
:directory_id,
|
568
|
+
:directory_type,
|
569
|
+
:default_mail_domain,
|
570
|
+
:completed_date,
|
571
|
+
:error_message)
|
572
|
+
include Aws::Structure
|
573
|
+
end
|
574
|
+
|
575
|
+
# @note When making an API call, you may pass DescribeResourceRequest
|
576
|
+
# data as a hash:
|
577
|
+
#
|
578
|
+
# {
|
579
|
+
# organization_id: "OrganizationId", # required
|
580
|
+
# resource_id: "ResourceId", # required
|
581
|
+
# }
|
582
|
+
#
|
583
|
+
# @!attribute [rw] organization_id
|
584
|
+
# The identifier associated with the organization for which the
|
585
|
+
# resource is described.
|
586
|
+
# @return [String]
|
587
|
+
#
|
588
|
+
# @!attribute [rw] resource_id
|
589
|
+
# The identifier of the resource to be described.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceRequest AWS API Documentation
|
593
|
+
#
|
594
|
+
class DescribeResourceRequest < Struct.new(
|
595
|
+
:organization_id,
|
596
|
+
:resource_id)
|
597
|
+
include Aws::Structure
|
598
|
+
end
|
599
|
+
|
600
|
+
# @!attribute [rw] resource_id
|
601
|
+
# The identifier of the described resource.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @!attribute [rw] email
|
605
|
+
# The email of the described resource.
|
606
|
+
# @return [String]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] name
|
609
|
+
# The name of the described resource.
|
610
|
+
# @return [String]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] type
|
613
|
+
# The type of the described resource.
|
614
|
+
# @return [String]
|
615
|
+
#
|
616
|
+
# @!attribute [rw] booking_options
|
617
|
+
# The booking options for the described resource.
|
618
|
+
# @return [Types::BookingOptions]
|
619
|
+
#
|
620
|
+
# @!attribute [rw] state
|
621
|
+
# The state of the resource: enabled (registered to Amazon WorkMail)
|
622
|
+
# or disabled (deregistered or never registered to Amazon WorkMail).
|
623
|
+
# @return [String]
|
624
|
+
#
|
625
|
+
# @!attribute [rw] enabled_date
|
626
|
+
# The date and time when a resource was registered to Amazon WorkMail,
|
627
|
+
# in UNIX epoch time format.
|
628
|
+
# @return [Time]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] disabled_date
|
631
|
+
# The date and time when a resource was registered from Amazon
|
632
|
+
# WorkMail, in UNIX epoch time format.
|
633
|
+
# @return [Time]
|
634
|
+
#
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceResponse AWS API Documentation
|
636
|
+
#
|
637
|
+
class DescribeResourceResponse < Struct.new(
|
638
|
+
:resource_id,
|
639
|
+
:email,
|
640
|
+
:name,
|
641
|
+
:type,
|
642
|
+
:booking_options,
|
643
|
+
:state,
|
644
|
+
:enabled_date,
|
645
|
+
:disabled_date)
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
648
|
+
|
649
|
+
# @note When making an API call, you may pass DescribeUserRequest
|
650
|
+
# data as a hash:
|
651
|
+
#
|
652
|
+
# {
|
653
|
+
# organization_id: "OrganizationId", # required
|
654
|
+
# user_id: "WorkMailIdentifier", # required
|
655
|
+
# }
|
656
|
+
#
|
657
|
+
# @!attribute [rw] organization_id
|
658
|
+
# The identifier for the organization under which the user exists.
|
659
|
+
# @return [String]
|
660
|
+
#
|
661
|
+
# @!attribute [rw] user_id
|
662
|
+
# The identifier for the user to be described.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserRequest AWS API Documentation
|
666
|
+
#
|
667
|
+
class DescribeUserRequest < Struct.new(
|
668
|
+
:organization_id,
|
669
|
+
:user_id)
|
670
|
+
include Aws::Structure
|
671
|
+
end
|
672
|
+
|
673
|
+
# @!attribute [rw] user_id
|
674
|
+
# The identifier for the described user.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @!attribute [rw] name
|
678
|
+
# The name for the user.
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] email
|
682
|
+
# The email of the user.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] display_name
|
686
|
+
# The display name of the user.
|
687
|
+
# @return [String]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] state
|
690
|
+
# The state of a user: enabled (registered to Amazon WorkMail) or
|
691
|
+
# disabled (deregistered or never registered to Amazon WorkMail).
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] user_role
|
695
|
+
# In certain cases other entities are modeled as users. If
|
696
|
+
# interoperability is enabled, resources are imported into Amazon
|
697
|
+
# WorkMail as users. Because different Amazon WorkMail organizations
|
698
|
+
# rely on different directory types, administrators can distinguish
|
699
|
+
# between a user that is not registered to Amazon WorkMail (is
|
700
|
+
# disabled and has a user role) and the administrative users of the
|
701
|
+
# directory. The values are USER, RESOURCE, and SYSTEM\_USER.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] enabled_date
|
705
|
+
# The date and time at which the user was enabled for Amazon WorkMail
|
706
|
+
# usage, in UNIX epoch time format.
|
707
|
+
# @return [Time]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] disabled_date
|
710
|
+
# The date and time at which the user was disabled for Amazon WorkMail
|
711
|
+
# usage, in UNIX epoch time format.
|
712
|
+
# @return [Time]
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserResponse AWS API Documentation
|
715
|
+
#
|
716
|
+
class DescribeUserResponse < Struct.new(
|
717
|
+
:user_id,
|
718
|
+
:name,
|
719
|
+
:email,
|
720
|
+
:display_name,
|
721
|
+
:state,
|
722
|
+
:user_role,
|
723
|
+
:enabled_date,
|
724
|
+
:disabled_date)
|
725
|
+
include Aws::Structure
|
726
|
+
end
|
727
|
+
|
728
|
+
# @note When making an API call, you may pass DisassociateDelegateFromResourceRequest
|
729
|
+
# data as a hash:
|
730
|
+
#
|
731
|
+
# {
|
732
|
+
# organization_id: "OrganizationId", # required
|
733
|
+
# resource_id: "ResourceId", # required
|
734
|
+
# entity_id: "WorkMailIdentifier", # required
|
735
|
+
# }
|
736
|
+
#
|
737
|
+
# @!attribute [rw] organization_id
|
738
|
+
# The identifier for the organization under which the resource exists.
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @!attribute [rw] resource_id
|
742
|
+
# The identifier of the resource from which delegates' set members
|
743
|
+
# are removed.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] entity_id
|
747
|
+
# The identifier for the member (user, group) to be removed from the
|
748
|
+
# resource's delegates.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceRequest AWS API Documentation
|
752
|
+
#
|
753
|
+
class DisassociateDelegateFromResourceRequest < Struct.new(
|
754
|
+
:organization_id,
|
755
|
+
:resource_id,
|
756
|
+
:entity_id)
|
757
|
+
include Aws::Structure
|
758
|
+
end
|
759
|
+
|
760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceResponse AWS API Documentation
|
761
|
+
#
|
762
|
+
class DisassociateDelegateFromResourceResponse < Aws::EmptyStructure; end
|
763
|
+
|
764
|
+
# @note When making an API call, you may pass DisassociateMemberFromGroupRequest
|
765
|
+
# data as a hash:
|
766
|
+
#
|
767
|
+
# {
|
768
|
+
# organization_id: "OrganizationId", # required
|
769
|
+
# group_id: "WorkMailIdentifier", # required
|
770
|
+
# member_id: "WorkMailIdentifier", # required
|
771
|
+
# }
|
772
|
+
#
|
773
|
+
# @!attribute [rw] organization_id
|
774
|
+
# The identifier for the organization under which the group exists.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] group_id
|
778
|
+
# The identifier for the group from which members are removed.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] member_id
|
782
|
+
# The identifier for the member to be removed to the group.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupRequest AWS API Documentation
|
786
|
+
#
|
787
|
+
class DisassociateMemberFromGroupRequest < Struct.new(
|
788
|
+
:organization_id,
|
789
|
+
:group_id,
|
790
|
+
:member_id)
|
791
|
+
include Aws::Structure
|
792
|
+
end
|
793
|
+
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupResponse AWS API Documentation
|
795
|
+
#
|
796
|
+
class DisassociateMemberFromGroupResponse < Aws::EmptyStructure; end
|
797
|
+
|
798
|
+
# The representation of an Amazon WorkMail group.
|
799
|
+
#
|
800
|
+
# @!attribute [rw] id
|
801
|
+
# The identifier of the group.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] email
|
805
|
+
# The email of the group.
|
806
|
+
# @return [String]
|
807
|
+
#
|
808
|
+
# @!attribute [rw] name
|
809
|
+
# The name of the group.
|
810
|
+
# @return [String]
|
811
|
+
#
|
812
|
+
# @!attribute [rw] state
|
813
|
+
# The state of the group, which can be ENABLED, DISABLED, or DELETED.
|
814
|
+
# @return [String]
|
815
|
+
#
|
816
|
+
# @!attribute [rw] enabled_date
|
817
|
+
# The date indicating when the group was enabled for Amazon WorkMail
|
818
|
+
# use.
|
819
|
+
# @return [Time]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] disabled_date
|
822
|
+
# The date indicating when the group was disabled from Amazon WorkMail
|
823
|
+
# use.
|
824
|
+
# @return [Time]
|
825
|
+
#
|
826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Group AWS API Documentation
|
827
|
+
#
|
828
|
+
class Group < Struct.new(
|
829
|
+
:id,
|
830
|
+
:email,
|
831
|
+
:name,
|
832
|
+
:state,
|
833
|
+
:enabled_date,
|
834
|
+
:disabled_date)
|
835
|
+
include Aws::Structure
|
836
|
+
end
|
837
|
+
|
838
|
+
# @note When making an API call, you may pass ListAliasesRequest
|
839
|
+
# data as a hash:
|
840
|
+
#
|
841
|
+
# {
|
842
|
+
# organization_id: "OrganizationId", # required
|
843
|
+
# entity_id: "WorkMailIdentifier", # required
|
844
|
+
# next_token: "NextToken",
|
845
|
+
# max_results: 1,
|
846
|
+
# }
|
847
|
+
#
|
848
|
+
# @!attribute [rw] organization_id
|
849
|
+
# The identifier for the organization under which the entity exists.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] entity_id
|
853
|
+
# The identifier for the entity for which to list the aliases.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] next_token
|
857
|
+
# The token to use to retrieve the next page of results. The first
|
858
|
+
# call does not contain any tokens.
|
859
|
+
# @return [String]
|
860
|
+
#
|
861
|
+
# @!attribute [rw] max_results
|
862
|
+
# The maximum number of results to return in a single call.
|
863
|
+
# @return [Integer]
|
864
|
+
#
|
865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesRequest AWS API Documentation
|
866
|
+
#
|
867
|
+
class ListAliasesRequest < Struct.new(
|
868
|
+
:organization_id,
|
869
|
+
:entity_id,
|
870
|
+
:next_token,
|
871
|
+
:max_results)
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# @!attribute [rw] aliases
|
876
|
+
# The entity's paginated aliases.
|
877
|
+
# @return [Array<String>]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] next_token
|
880
|
+
# The token to use to retrieve the next page of results. The value is
|
881
|
+
# "null" when there are no more results to return.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesResponse AWS API Documentation
|
885
|
+
#
|
886
|
+
class ListAliasesResponse < Struct.new(
|
887
|
+
:aliases,
|
888
|
+
:next_token)
|
889
|
+
include Aws::Structure
|
890
|
+
end
|
891
|
+
|
892
|
+
# @note When making an API call, you may pass ListGroupMembersRequest
|
893
|
+
# data as a hash:
|
894
|
+
#
|
895
|
+
# {
|
896
|
+
# organization_id: "OrganizationId", # required
|
897
|
+
# group_id: "WorkMailIdentifier", # required
|
898
|
+
# next_token: "NextToken",
|
899
|
+
# max_results: 1,
|
900
|
+
# }
|
901
|
+
#
|
902
|
+
# @!attribute [rw] organization_id
|
903
|
+
# The identifier for the organization under which the group exists.
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] group_id
|
907
|
+
# The identifier for the group to which the members are associated.
|
908
|
+
# @return [String]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] next_token
|
911
|
+
# The token to use to retrieve the next page of results. The first
|
912
|
+
# call does not contain any tokens.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] max_results
|
916
|
+
# The maximum number of results to return in a single call.
|
917
|
+
# @return [Integer]
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersRequest AWS API Documentation
|
920
|
+
#
|
921
|
+
class ListGroupMembersRequest < Struct.new(
|
922
|
+
:organization_id,
|
923
|
+
:group_id,
|
924
|
+
:next_token,
|
925
|
+
:max_results)
|
926
|
+
include Aws::Structure
|
927
|
+
end
|
928
|
+
|
929
|
+
# @!attribute [rw] members
|
930
|
+
# The members associated to the group.
|
931
|
+
# @return [Array<Types::Member>]
|
932
|
+
#
|
933
|
+
# @!attribute [rw] next_token
|
934
|
+
# The token to use to retrieve the next page of results. The first
|
935
|
+
# call does not contain any tokens.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersResponse AWS API Documentation
|
939
|
+
#
|
940
|
+
class ListGroupMembersResponse < Struct.new(
|
941
|
+
:members,
|
942
|
+
:next_token)
|
943
|
+
include Aws::Structure
|
944
|
+
end
|
945
|
+
|
946
|
+
# @note When making an API call, you may pass ListGroupsRequest
|
947
|
+
# data as a hash:
|
948
|
+
#
|
949
|
+
# {
|
950
|
+
# organization_id: "OrganizationId", # required
|
951
|
+
# next_token: "NextToken",
|
952
|
+
# max_results: 1,
|
953
|
+
# }
|
954
|
+
#
|
955
|
+
# @!attribute [rw] organization_id
|
956
|
+
# The identifier for the organization under which the groups exist.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] next_token
|
960
|
+
# The token to use to retrieve the next page of results. The first
|
961
|
+
# call does not contain any tokens.
|
962
|
+
# @return [String]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] max_results
|
965
|
+
# The maximum number of results to return in a single call.
|
966
|
+
# @return [Integer]
|
967
|
+
#
|
968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsRequest AWS API Documentation
|
969
|
+
#
|
970
|
+
class ListGroupsRequest < Struct.new(
|
971
|
+
:organization_id,
|
972
|
+
:next_token,
|
973
|
+
:max_results)
|
974
|
+
include Aws::Structure
|
975
|
+
end
|
976
|
+
|
977
|
+
# @!attribute [rw] groups
|
978
|
+
# The overview of groups for an organization.
|
979
|
+
# @return [Array<Types::Group>]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] next_token
|
982
|
+
# The token to use to retrieve the next page of results. The value is
|
983
|
+
# "null" when there are no more results to return.
|
984
|
+
# @return [String]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsResponse AWS API Documentation
|
987
|
+
#
|
988
|
+
class ListGroupsResponse < Struct.new(
|
989
|
+
:groups,
|
990
|
+
:next_token)
|
991
|
+
include Aws::Structure
|
992
|
+
end
|
993
|
+
|
994
|
+
# @note When making an API call, you may pass ListOrganizationsRequest
|
995
|
+
# data as a hash:
|
996
|
+
#
|
997
|
+
# {
|
998
|
+
# next_token: "NextToken",
|
999
|
+
# max_results: 1,
|
1000
|
+
# }
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] next_token
|
1003
|
+
# The token to use to retrieve the next page of results. The first
|
1004
|
+
# call does not contain any tokens.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] max_results
|
1008
|
+
# The maximum number of results to return in a single call.
|
1009
|
+
# @return [Integer]
|
1010
|
+
#
|
1011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsRequest AWS API Documentation
|
1012
|
+
#
|
1013
|
+
class ListOrganizationsRequest < Struct.new(
|
1014
|
+
:next_token,
|
1015
|
+
:max_results)
|
1016
|
+
include Aws::Structure
|
1017
|
+
end
|
1018
|
+
|
1019
|
+
# @!attribute [rw] organization_summaries
|
1020
|
+
# The overview of owned organizations presented as a list of
|
1021
|
+
# organization summaries.
|
1022
|
+
# @return [Array<Types::OrganizationSummary>]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] next_token
|
1025
|
+
# The token to use to retrieve the next page of results. The value is
|
1026
|
+
# "null" when there are no more results to return.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsResponse AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class ListOrganizationsResponse < Struct.new(
|
1032
|
+
:organization_summaries,
|
1033
|
+
:next_token)
|
1034
|
+
include Aws::Structure
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# @note When making an API call, you may pass ListResourceDelegatesRequest
|
1038
|
+
# data as a hash:
|
1039
|
+
#
|
1040
|
+
# {
|
1041
|
+
# organization_id: "OrganizationId", # required
|
1042
|
+
# resource_id: "WorkMailIdentifier", # required
|
1043
|
+
# next_token: "NextToken",
|
1044
|
+
# max_results: 1,
|
1045
|
+
# }
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] organization_id
|
1048
|
+
# The identifier for the organization that contains the resource for
|
1049
|
+
# which delegates are listed.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] resource_id
|
1053
|
+
# The identifier for the resource whose delegates are listed.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] next_token
|
1057
|
+
# The token used to paginate through the delegates associated with a
|
1058
|
+
# resource.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] max_results
|
1062
|
+
# The number of maximum results in a page.
|
1063
|
+
# @return [Integer]
|
1064
|
+
#
|
1065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesRequest AWS API Documentation
|
1066
|
+
#
|
1067
|
+
class ListResourceDelegatesRequest < Struct.new(
|
1068
|
+
:organization_id,
|
1069
|
+
:resource_id,
|
1070
|
+
:next_token,
|
1071
|
+
:max_results)
|
1072
|
+
include Aws::Structure
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
# @!attribute [rw] delegates
|
1076
|
+
# One page of the resource's delegates.
|
1077
|
+
# @return [Array<Types::Delegate>]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] next_token
|
1080
|
+
# The token used to paginate through the delegates associated with a
|
1081
|
+
# resource. While results are still available, it has an associated
|
1082
|
+
# value. When the last page is reached, the token is empty.
|
1083
|
+
# @return [String]
|
1084
|
+
#
|
1085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesResponse AWS API Documentation
|
1086
|
+
#
|
1087
|
+
class ListResourceDelegatesResponse < Struct.new(
|
1088
|
+
:delegates,
|
1089
|
+
:next_token)
|
1090
|
+
include Aws::Structure
|
1091
|
+
end
|
1092
|
+
|
1093
|
+
# @note When making an API call, you may pass ListResourcesRequest
|
1094
|
+
# data as a hash:
|
1095
|
+
#
|
1096
|
+
# {
|
1097
|
+
# organization_id: "OrganizationId", # required
|
1098
|
+
# next_token: "NextToken",
|
1099
|
+
# max_results: 1,
|
1100
|
+
# }
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] organization_id
|
1103
|
+
# The identifier for the organization under which the resources exist.
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @!attribute [rw] next_token
|
1107
|
+
# The token to use to retrieve the next page of results. The first
|
1108
|
+
# call does not contain any tokens.
|
1109
|
+
# @return [String]
|
1110
|
+
#
|
1111
|
+
# @!attribute [rw] max_results
|
1112
|
+
# The maximum number of results to return in a single call.
|
1113
|
+
# @return [Integer]
|
1114
|
+
#
|
1115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesRequest AWS API Documentation
|
1116
|
+
#
|
1117
|
+
class ListResourcesRequest < Struct.new(
|
1118
|
+
:organization_id,
|
1119
|
+
:next_token,
|
1120
|
+
:max_results)
|
1121
|
+
include Aws::Structure
|
1122
|
+
end
|
1123
|
+
|
1124
|
+
# @!attribute [rw] resources
|
1125
|
+
# One page of the organization's resource representation.
|
1126
|
+
# @return [Array<Types::Resource>]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] next_token
|
1129
|
+
# The token used to paginate through all the organization's
|
1130
|
+
# resources. While results are still available, it has an associated
|
1131
|
+
# value. When the last page is reached, the token is empty.
|
1132
|
+
# @return [String]
|
1133
|
+
#
|
1134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesResponse AWS API Documentation
|
1135
|
+
#
|
1136
|
+
class ListResourcesResponse < Struct.new(
|
1137
|
+
:resources,
|
1138
|
+
:next_token)
|
1139
|
+
include Aws::Structure
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
# @note When making an API call, you may pass ListUsersRequest
|
1143
|
+
# data as a hash:
|
1144
|
+
#
|
1145
|
+
# {
|
1146
|
+
# organization_id: "OrganizationId", # required
|
1147
|
+
# next_token: "NextToken",
|
1148
|
+
# max_results: 1,
|
1149
|
+
# }
|
1150
|
+
#
|
1151
|
+
# @!attribute [rw] organization_id
|
1152
|
+
# The identifier for the organization under which the users exist.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] next_token
|
1156
|
+
# TBD
|
1157
|
+
# @return [String]
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] max_results
|
1160
|
+
# The maximum number of results to return in a single call.
|
1161
|
+
# @return [Integer]
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersRequest AWS API Documentation
|
1164
|
+
#
|
1165
|
+
class ListUsersRequest < Struct.new(
|
1166
|
+
:organization_id,
|
1167
|
+
:next_token,
|
1168
|
+
:max_results)
|
1169
|
+
include Aws::Structure
|
1170
|
+
end
|
1171
|
+
|
1172
|
+
# @!attribute [rw] users
|
1173
|
+
# The overview of users for an organization.
|
1174
|
+
# @return [Array<Types::User>]
|
1175
|
+
#
|
1176
|
+
# @!attribute [rw] next_token
|
1177
|
+
# The token to use to retrieve the next page of results. This value is
|
1178
|
+
# `null` when there are no more results to return.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersResponse AWS API Documentation
|
1182
|
+
#
|
1183
|
+
class ListUsersResponse < Struct.new(
|
1184
|
+
:users,
|
1185
|
+
:next_token)
|
1186
|
+
include Aws::Structure
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# The representation of a group member (user or group).
|
1190
|
+
#
|
1191
|
+
# @!attribute [rw] id
|
1192
|
+
# The identifier of the member.
|
1193
|
+
# @return [String]
|
1194
|
+
#
|
1195
|
+
# @!attribute [rw] name
|
1196
|
+
# The name of the member.
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] type
|
1200
|
+
# A member can be a user or group.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] state
|
1204
|
+
# The state of the member, which can be ENABLED, DISABLED, or DELETED.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] enabled_date
|
1208
|
+
# The date indicating when the member was enabled for Amazon WorkMail
|
1209
|
+
# use.
|
1210
|
+
# @return [Time]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] disabled_date
|
1213
|
+
# The date indicating when the member was disabled from Amazon
|
1214
|
+
# WorkMail use.
|
1215
|
+
# @return [Time]
|
1216
|
+
#
|
1217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Member AWS API Documentation
|
1218
|
+
#
|
1219
|
+
class Member < Struct.new(
|
1220
|
+
:id,
|
1221
|
+
:name,
|
1222
|
+
:type,
|
1223
|
+
:state,
|
1224
|
+
:enabled_date,
|
1225
|
+
:disabled_date)
|
1226
|
+
include Aws::Structure
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
# The brief overview associated with an organization.
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] organization_id
|
1232
|
+
# The identifier associated with the organization.
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] alias
|
1236
|
+
# The alias associated with the organization.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] error_message
|
1240
|
+
# The error message associated with the organization. It is only
|
1241
|
+
# present if unexpected behavior has occurred with regards to the
|
1242
|
+
# organization. It provides insight or solutions regarding unexpected
|
1243
|
+
# behavior.
|
1244
|
+
# @return [String]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] state
|
1247
|
+
# The state associated with the organization.
|
1248
|
+
# @return [String]
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/OrganizationSummary AWS API Documentation
|
1251
|
+
#
|
1252
|
+
class OrganizationSummary < Struct.new(
|
1253
|
+
:organization_id,
|
1254
|
+
:alias,
|
1255
|
+
:error_message,
|
1256
|
+
:state)
|
1257
|
+
include Aws::Structure
|
1258
|
+
end
|
1259
|
+
|
1260
|
+
# @note When making an API call, you may pass RegisterToWorkMailRequest
|
1261
|
+
# data as a hash:
|
1262
|
+
#
|
1263
|
+
# {
|
1264
|
+
# organization_id: "OrganizationId", # required
|
1265
|
+
# entity_id: "WorkMailIdentifier", # required
|
1266
|
+
# email: "EmailAddress", # required
|
1267
|
+
# }
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] organization_id
|
1270
|
+
# The identifier for the organization under which the Amazon WorkMail
|
1271
|
+
# entity exists.
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] entity_id
|
1275
|
+
# The identifier for the entity to be updated.
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] email
|
1279
|
+
# The email for the entity to be updated.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailRequest AWS API Documentation
|
1283
|
+
#
|
1284
|
+
class RegisterToWorkMailRequest < Struct.new(
|
1285
|
+
:organization_id,
|
1286
|
+
:entity_id,
|
1287
|
+
:email)
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailResponse AWS API Documentation
|
1292
|
+
#
|
1293
|
+
class RegisterToWorkMailResponse < Aws::EmptyStructure; end
|
1294
|
+
|
1295
|
+
# @note When making an API call, you may pass ResetPasswordRequest
|
1296
|
+
# data as a hash:
|
1297
|
+
#
|
1298
|
+
# {
|
1299
|
+
# organization_id: "OrganizationId", # required
|
1300
|
+
# user_id: "WorkMailIdentifier", # required
|
1301
|
+
# password: "Password", # required
|
1302
|
+
# }
|
1303
|
+
#
|
1304
|
+
# @!attribute [rw] organization_id
|
1305
|
+
# The identifier of the organization that contains the user for which
|
1306
|
+
# the password is reset.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] user_id
|
1310
|
+
# The identifier of the user for whom the password is reset.
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] password
|
1314
|
+
# The new password for the user.
|
1315
|
+
# @return [String]
|
1316
|
+
#
|
1317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordRequest AWS API Documentation
|
1318
|
+
#
|
1319
|
+
class ResetPasswordRequest < Struct.new(
|
1320
|
+
:organization_id,
|
1321
|
+
:user_id,
|
1322
|
+
:password)
|
1323
|
+
include Aws::Structure
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordResponse AWS API Documentation
|
1327
|
+
#
|
1328
|
+
class ResetPasswordResponse < Aws::EmptyStructure; end
|
1329
|
+
|
1330
|
+
# The overview for a resource containing relevant data regarding it.
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] id
|
1333
|
+
# The identifier of the resource.
|
1334
|
+
# @return [String]
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] email
|
1337
|
+
# The email of the resource.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] name
|
1341
|
+
# The name of the resource.
|
1342
|
+
# @return [String]
|
1343
|
+
#
|
1344
|
+
# @!attribute [rw] type
|
1345
|
+
# The type of the resource: equipment or room.
|
1346
|
+
# @return [String]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] state
|
1349
|
+
# The state of the resource, which can be ENABLED, DISABLED, or
|
1350
|
+
# DELETED.
|
1351
|
+
# @return [String]
|
1352
|
+
#
|
1353
|
+
# @!attribute [rw] enabled_date
|
1354
|
+
# The date indicating when the resource was enabled for Amazon
|
1355
|
+
# WorkMail use.
|
1356
|
+
# @return [Time]
|
1357
|
+
#
|
1358
|
+
# @!attribute [rw] disabled_date
|
1359
|
+
# The date indicating when the resource was disabled from Amazon
|
1360
|
+
# WorkMail use.
|
1361
|
+
# @return [Time]
|
1362
|
+
#
|
1363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Resource AWS API Documentation
|
1364
|
+
#
|
1365
|
+
class Resource < Struct.new(
|
1366
|
+
:id,
|
1367
|
+
:email,
|
1368
|
+
:name,
|
1369
|
+
:type,
|
1370
|
+
:state,
|
1371
|
+
:enabled_date,
|
1372
|
+
:disabled_date)
|
1373
|
+
include Aws::Structure
|
1374
|
+
end
|
1375
|
+
|
1376
|
+
# @note When making an API call, you may pass UpdatePrimaryEmailAddressRequest
|
1377
|
+
# data as a hash:
|
1378
|
+
#
|
1379
|
+
# {
|
1380
|
+
# organization_id: "OrganizationId", # required
|
1381
|
+
# entity_id: "WorkMailIdentifier", # required
|
1382
|
+
# email: "EmailAddress", # required
|
1383
|
+
# }
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] organization_id
|
1386
|
+
# The organization that contains the entity to update.
|
1387
|
+
# @return [String]
|
1388
|
+
#
|
1389
|
+
# @!attribute [rw] entity_id
|
1390
|
+
# The entity to update (user, group, or resource).
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @!attribute [rw] email
|
1394
|
+
# The value of the email to be updated as primary.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressRequest AWS API Documentation
|
1398
|
+
#
|
1399
|
+
class UpdatePrimaryEmailAddressRequest < Struct.new(
|
1400
|
+
:organization_id,
|
1401
|
+
:entity_id,
|
1402
|
+
:email)
|
1403
|
+
include Aws::Structure
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressResponse AWS API Documentation
|
1407
|
+
#
|
1408
|
+
class UpdatePrimaryEmailAddressResponse < Aws::EmptyStructure; end
|
1409
|
+
|
1410
|
+
# @note When making an API call, you may pass UpdateResourceRequest
|
1411
|
+
# data as a hash:
|
1412
|
+
#
|
1413
|
+
# {
|
1414
|
+
# organization_id: "OrganizationId", # required
|
1415
|
+
# resource_id: "ResourceId", # required
|
1416
|
+
# name: "ResourceName",
|
1417
|
+
# booking_options: {
|
1418
|
+
# auto_accept_requests: false,
|
1419
|
+
# auto_decline_recurring_requests: false,
|
1420
|
+
# auto_decline_conflicting_requests: false,
|
1421
|
+
# },
|
1422
|
+
# }
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] organization_id
|
1425
|
+
# The identifier associated with the organization for which the
|
1426
|
+
# resource is updated.
|
1427
|
+
# @return [String]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] resource_id
|
1430
|
+
# The identifier of the resource to be updated.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] name
|
1434
|
+
# The name of the resource to be updated.
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] booking_options
|
1438
|
+
# The resource's booking options to be updated.
|
1439
|
+
# @return [Types::BookingOptions]
|
1440
|
+
#
|
1441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceRequest AWS API Documentation
|
1442
|
+
#
|
1443
|
+
class UpdateResourceRequest < Struct.new(
|
1444
|
+
:organization_id,
|
1445
|
+
:resource_id,
|
1446
|
+
:name,
|
1447
|
+
:booking_options)
|
1448
|
+
include Aws::Structure
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceResponse AWS API Documentation
|
1452
|
+
#
|
1453
|
+
class UpdateResourceResponse < Aws::EmptyStructure; end
|
1454
|
+
|
1455
|
+
# The representation of an Amazon WorkMail user.
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] id
|
1458
|
+
# The identifier of the user.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] email
|
1462
|
+
# The email of the user.
|
1463
|
+
# @return [String]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] name
|
1466
|
+
# The name of the user.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] display_name
|
1470
|
+
# The display name of the user.
|
1471
|
+
# @return [String]
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] state
|
1474
|
+
# The state of the user, which can be ENABLED, DISABLED, or DELETED.
|
1475
|
+
# @return [String]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] user_role
|
1478
|
+
# The role of the user.
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] enabled_date
|
1482
|
+
# The date indicating when the user was enabled for Amazon WorkMail
|
1483
|
+
# use.
|
1484
|
+
# @return [Time]
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] disabled_date
|
1487
|
+
# The date indicating when the user was disabled from Amazon WorkMail
|
1488
|
+
# use.
|
1489
|
+
# @return [Time]
|
1490
|
+
#
|
1491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/User AWS API Documentation
|
1492
|
+
#
|
1493
|
+
class User < Struct.new(
|
1494
|
+
:id,
|
1495
|
+
:email,
|
1496
|
+
:name,
|
1497
|
+
:display_name,
|
1498
|
+
:state,
|
1499
|
+
:user_role,
|
1500
|
+
:enabled_date,
|
1501
|
+
:disabled_date)
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
end
|
1506
|
+
end
|