aws-sdk-workmail 1.10.0 → 1.11.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 +1 -1
- data/lib/aws-sdk-workmail/client.rb +83 -70
- data/lib/aws-sdk-workmail/client_api.rb +1 -0
- data/lib/aws-sdk-workmail/types.rb +73 -71
- 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: 0a6b83ed17cbdf17534c271ae0dbaf5100f2c623
|
4
|
+
data.tar.gz: 89782a2851f026da627f517ed6ba127c13b6e65d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e8fd9f22ca8a67ffddf075c6055178a16a3661c1d4326fb3934232c7a0f0f765e8d56dc873dcf72b2fe63f91659001b58aa127bdeb450ed3c075c4efc1478d3c
|
7
|
+
data.tar.gz: 02a507b5f055bbc5fcc929c76fcfa60aaaf2996cef664190ce8f701bef02cb75dcc51a0c1225ef141dac9a2f7d6252118e657d6c76c3f949bfe2dd2e05adb105
|
data/lib/aws-sdk-workmail.rb
CHANGED
@@ -215,13 +215,13 @@ module Aws::WorkMail
|
|
215
215
|
|
216
216
|
# @!group API Operations
|
217
217
|
|
218
|
-
# Adds a member to the resource's set of delegates.
|
218
|
+
# Adds a member (user or group) to the resource's set of delegates.
|
219
219
|
#
|
220
220
|
# @option params [required, String] :organization_id
|
221
221
|
# The organization under which the resource exists.
|
222
222
|
#
|
223
223
|
# @option params [required, String] :resource_id
|
224
|
-
# The resource for which members are associated.
|
224
|
+
# The resource for which members (users or groups) are associated.
|
225
225
|
#
|
226
226
|
# @option params [required, String] :entity_id
|
227
227
|
# The member (user or group) to associate to the resource.
|
@@ -245,16 +245,16 @@ module Aws::WorkMail
|
|
245
245
|
req.send_request(options)
|
246
246
|
end
|
247
247
|
|
248
|
-
# Adds a member to the group's set.
|
248
|
+
# Adds a member (user or group) to the group's set.
|
249
249
|
#
|
250
250
|
# @option params [required, String] :organization_id
|
251
251
|
# The organization under which the group exists.
|
252
252
|
#
|
253
253
|
# @option params [required, String] :group_id
|
254
|
-
# The group
|
254
|
+
# The group to which the member (user or group) is associated.
|
255
255
|
#
|
256
256
|
# @option params [required, String] :member_id
|
257
|
-
# The member to associate to the group.
|
257
|
+
# The member (user or group) to associate to the group.
|
258
258
|
#
|
259
259
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
260
260
|
#
|
@@ -275,16 +275,17 @@ module Aws::WorkMail
|
|
275
275
|
req.send_request(options)
|
276
276
|
end
|
277
277
|
|
278
|
-
# Adds an alias to the set of a given member of Amazon
|
278
|
+
# Adds an alias to the set of a given member (user or group) of Amazon
|
279
|
+
# WorkMail.
|
279
280
|
#
|
280
281
|
# @option params [required, String] :organization_id
|
281
|
-
# The organization under which the member exists.
|
282
|
+
# The organization under which the member (user or group) exists.
|
282
283
|
#
|
283
284
|
# @option params [required, String] :entity_id
|
284
|
-
# The
|
285
|
+
# The member (user or group) to which this alias is added.
|
285
286
|
#
|
286
287
|
# @option params [required, String] :alias
|
287
|
-
# The alias to add to the
|
288
|
+
# The alias to add to the member set.
|
288
289
|
#
|
289
290
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
290
291
|
#
|
@@ -338,18 +339,18 @@ module Aws::WorkMail
|
|
338
339
|
req.send_request(options)
|
339
340
|
end
|
340
341
|
|
341
|
-
# Creates a new Amazon WorkMail resource.
|
342
|
-
# equipment and room.
|
342
|
+
# Creates a new Amazon WorkMail resource.
|
343
343
|
#
|
344
344
|
# @option params [required, String] :organization_id
|
345
345
|
# The identifier associated with the organization for which the resource
|
346
346
|
# is created.
|
347
347
|
#
|
348
348
|
# @option params [required, String] :name
|
349
|
-
# The name of the
|
349
|
+
# The name of the new resource.
|
350
350
|
#
|
351
351
|
# @option params [required, String] :type
|
352
|
-
# The type of the
|
352
|
+
# The type of the new resource. The available types are `equipment` and
|
353
|
+
# `room`.
|
353
354
|
#
|
354
355
|
# @return [Types::CreateResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
355
356
|
#
|
@@ -383,13 +384,14 @@ module Aws::WorkMail
|
|
383
384
|
# The identifier of the organization for which the user is created.
|
384
385
|
#
|
385
386
|
# @option params [required, String] :name
|
386
|
-
# The name for the user
|
387
|
+
# The name for the new user. Simple AD or AD Connector user names have a
|
388
|
+
# maximum length of 20. All others have a maximum length of 64.
|
387
389
|
#
|
388
390
|
# @option params [required, String] :display_name
|
389
|
-
# The display name for the user
|
391
|
+
# The display name for the new user.
|
390
392
|
#
|
391
393
|
# @option params [required, String] :password
|
392
|
-
# The password for the user
|
394
|
+
# The password for the new user.
|
393
395
|
#
|
394
396
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
395
397
|
#
|
@@ -417,14 +419,15 @@ module Aws::WorkMail
|
|
417
419
|
req.send_request(options)
|
418
420
|
end
|
419
421
|
|
420
|
-
# Remove
|
422
|
+
# Remove one or more specified aliases from a set of aliases for a given
|
423
|
+
# user.
|
421
424
|
#
|
422
425
|
# @option params [required, String] :organization_id
|
423
426
|
# The identifier for the organization under which the user exists.
|
424
427
|
#
|
425
428
|
# @option params [required, String] :entity_id
|
426
|
-
# The identifier for the
|
427
|
-
# removed.
|
429
|
+
# The identifier for the member (user or group) from which to have the
|
430
|
+
# aliases removed.
|
428
431
|
#
|
429
432
|
# @option params [required, String] :alias
|
430
433
|
# The aliases to be removed from the user's set of aliases. Duplicate
|
@@ -476,18 +479,17 @@ module Aws::WorkMail
|
|
476
479
|
req.send_request(options)
|
477
480
|
end
|
478
481
|
|
479
|
-
# Deletes permissions granted to a user or group.
|
482
|
+
# Deletes permissions granted to a member (user or group).
|
480
483
|
#
|
481
484
|
# @option params [required, String] :organization_id
|
482
|
-
# The identifier of the organization under which the
|
485
|
+
# The identifier of the organization under which the member (user or
|
483
486
|
# group) exists.
|
484
487
|
#
|
485
488
|
# @option params [required, String] :entity_id
|
486
|
-
# The identifier of the
|
487
|
-
# mailbox permissions.
|
489
|
+
# The identifier of the member (user or group)that owns the mailbox.
|
488
490
|
#
|
489
491
|
# @option params [required, String] :grantee_id
|
490
|
-
# The identifier of the
|
492
|
+
# The identifier of the member (user or group) for which to delete
|
491
493
|
# granted permissions.
|
492
494
|
#
|
493
495
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -512,8 +514,8 @@ module Aws::WorkMail
|
|
512
514
|
# Deletes the specified resource.
|
513
515
|
#
|
514
516
|
# @option params [required, String] :organization_id
|
515
|
-
# The identifier associated with the organization
|
516
|
-
# is deleted.
|
517
|
+
# The identifier associated with the organization from which the
|
518
|
+
# resource is deleted.
|
517
519
|
#
|
518
520
|
# @option params [required, String] :resource_id
|
519
521
|
# The identifier of the resource to be deleted.
|
@@ -536,12 +538,15 @@ module Aws::WorkMail
|
|
536
538
|
req.send_request(options)
|
537
539
|
end
|
538
540
|
|
539
|
-
# Deletes a user from Amazon WorkMail and all subsequent systems.
|
540
|
-
#
|
541
|
-
#
|
541
|
+
# Deletes a user from Amazon WorkMail and all subsequent systems. Before
|
542
|
+
# you can delete a user, the user state must be `DISABLED`. Use the
|
543
|
+
# DescribeUser action to confirm the user state.
|
544
|
+
#
|
545
|
+
# Deleting a user is permanent and cannot be undone. WorkMail archives
|
546
|
+
# user mailboxes for 30 days before they are permanently removed.
|
542
547
|
#
|
543
548
|
# @option params [required, String] :organization_id
|
544
|
-
# The organization that contains the user.
|
549
|
+
# The organization that contains the user to be deleted.
|
545
550
|
#
|
546
551
|
# @option params [required, String] :user_id
|
547
552
|
# The identifier of the user to be deleted.
|
@@ -566,15 +571,15 @@ module Aws::WorkMail
|
|
566
571
|
|
567
572
|
# Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
568
573
|
# This action disassociates the mailbox and schedules it for clean-up.
|
569
|
-
#
|
570
|
-
#
|
574
|
+
# WorkMail keeps mailboxes for 30 days before they are permanently
|
575
|
+
# removed. The functionality in the console is *Disable*.
|
571
576
|
#
|
572
577
|
# @option params [required, String] :organization_id
|
573
578
|
# The identifier for the organization under which the Amazon WorkMail
|
574
579
|
# entity exists.
|
575
580
|
#
|
576
581
|
# @option params [required, String] :entity_id
|
577
|
-
# The identifier for the
|
582
|
+
# The identifier for the member (user or group) to be updated.
|
578
583
|
#
|
579
584
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
580
585
|
#
|
@@ -881,13 +886,15 @@ module Aws::WorkMail
|
|
881
886
|
req.send_request(options)
|
882
887
|
end
|
883
888
|
|
884
|
-
# Returns an overview of the members of a group.
|
889
|
+
# Returns an overview of the members of a group. Users and groups can be
|
890
|
+
# members of a group.
|
885
891
|
#
|
886
892
|
# @option params [required, String] :organization_id
|
887
893
|
# The identifier for the organization under which the group exists.
|
888
894
|
#
|
889
895
|
# @option params [required, String] :group_id
|
890
|
-
# The identifier for the group to which the members
|
896
|
+
# The identifier for the group to which the members (users or groups)
|
897
|
+
# are associated.
|
891
898
|
#
|
892
899
|
# @option params [String] :next_token
|
893
900
|
# The token to use to retrieve the next page of results. The first call
|
@@ -975,15 +982,16 @@ module Aws::WorkMail
|
|
975
982
|
req.send_request(options)
|
976
983
|
end
|
977
984
|
|
978
|
-
# Lists the mailbox permissions associated with a
|
985
|
+
# Lists the mailbox permissions associated with a user, group, or
|
986
|
+
# resource mailbox.
|
979
987
|
#
|
980
988
|
# @option params [required, String] :organization_id
|
981
|
-
# The identifier of the organization under which the
|
982
|
-
#
|
989
|
+
# The identifier of the organization under which the user, group, or
|
990
|
+
# resource exists.
|
983
991
|
#
|
984
992
|
# @option params [required, String] :entity_id
|
985
|
-
# The identifier of the
|
986
|
-
# permissions.
|
993
|
+
# The identifier of the user, group, or resource for which to list
|
994
|
+
# mailbox permissions.
|
987
995
|
#
|
988
996
|
# @option params [String] :next_token
|
989
997
|
# The token to use to retrieve the next page of results. The first call
|
@@ -1162,7 +1170,8 @@ module Aws::WorkMail
|
|
1162
1170
|
# The identifier for the organization under which the users exist.
|
1163
1171
|
#
|
1164
1172
|
# @option params [String] :next_token
|
1165
|
-
#
|
1173
|
+
# The token to use to retrieve the next page of results. The first call
|
1174
|
+
# does not contain any tokens.
|
1166
1175
|
#
|
1167
1176
|
# @option params [Integer] :max_results
|
1168
1177
|
# The maximum number of results to return in a single call.
|
@@ -1202,19 +1211,19 @@ module Aws::WorkMail
|
|
1202
1211
|
req.send_request(options)
|
1203
1212
|
end
|
1204
1213
|
|
1205
|
-
# Sets permissions for a user or
|
1206
|
-
# permissions
|
1214
|
+
# Sets permissions for a user, group, or resource. This replaces any
|
1215
|
+
# pre-existing permissions.
|
1207
1216
|
#
|
1208
1217
|
# @option params [required, String] :organization_id
|
1209
|
-
# The identifier of the organization under which the
|
1210
|
-
#
|
1218
|
+
# The identifier of the organization under which the user, group, or
|
1219
|
+
# resource exists.
|
1211
1220
|
#
|
1212
1221
|
# @option params [required, String] :entity_id
|
1213
|
-
# The identifier of the
|
1222
|
+
# The identifier of the user, group, or resource for which to update
|
1214
1223
|
# mailbox permissions.
|
1215
1224
|
#
|
1216
1225
|
# @option params [required, String] :grantee_id
|
1217
|
-
# The identifier of the
|
1226
|
+
# The identifier of the user, group, or resource to which to grant the
|
1218
1227
|
# permissions.
|
1219
1228
|
#
|
1220
1229
|
# @option params [required, Array<String>] :permission_values
|
@@ -1246,28 +1255,31 @@ module Aws::WorkMail
|
|
1246
1255
|
req.send_request(options)
|
1247
1256
|
end
|
1248
1257
|
|
1249
|
-
# Registers an existing and disabled user, group, or resource
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
# if the
|
1253
|
-
# of costs. For more information, see
|
1254
|
-
# console functionality for this operation
|
1255
|
-
#
|
1256
|
-
# from your directory. For more information, see DeregisterFromWorkMail.
|
1258
|
+
# Registers an existing and disabled user, group, or resource for Amazon
|
1259
|
+
# WorkMail use by associating a mailbox and calendaring capabilities. It
|
1260
|
+
# performs no change if the user, group, or resource is enabled and
|
1261
|
+
# fails if the user, group, or resource is deleted. This operation
|
1262
|
+
# results in the accumulation of costs. For more information, see
|
1263
|
+
# [Pricing][1]. The equivalent console functionality for this operation
|
1264
|
+
# is *Enable*.
|
1257
1265
|
#
|
1266
|
+
# Users can either be created by calling the CreateUser API operation or
|
1267
|
+
# they can be synchronized from your directory. For more information,
|
1268
|
+
# see DeregisterFromWorkMail.
|
1258
1269
|
#
|
1259
1270
|
#
|
1260
|
-
#
|
1271
|
+
#
|
1272
|
+
# [1]: https://aws.amazon.com//workmail/pricing
|
1261
1273
|
#
|
1262
1274
|
# @option params [required, String] :organization_id
|
1263
|
-
# The identifier for the organization under which the
|
1264
|
-
#
|
1275
|
+
# The identifier for the organization under which the user, group, or
|
1276
|
+
# resource exists.
|
1265
1277
|
#
|
1266
1278
|
# @option params [required, String] :entity_id
|
1267
|
-
# The identifier for the
|
1279
|
+
# The identifier for the user, group, or resource to be updated.
|
1268
1280
|
#
|
1269
1281
|
# @option params [required, String] :email
|
1270
|
-
# The email for the
|
1282
|
+
# The email for the user, group, or resource to be updated.
|
1271
1283
|
#
|
1272
1284
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1273
1285
|
#
|
@@ -1319,16 +1331,16 @@ module Aws::WorkMail
|
|
1319
1331
|
req.send_request(options)
|
1320
1332
|
end
|
1321
1333
|
|
1322
|
-
# Updates the primary email for
|
1323
|
-
# into the list of aliases (or swapped between an
|
1324
|
-
# current primary email) and the email provided
|
1325
|
-
# as the primary.
|
1334
|
+
# Updates the primary email for a user, group, or resource. The current
|
1335
|
+
# email is moved into the list of aliases (or swapped between an
|
1336
|
+
# existing alias and the current primary email), and the email provided
|
1337
|
+
# in the input is promoted as the primary.
|
1326
1338
|
#
|
1327
1339
|
# @option params [required, String] :organization_id
|
1328
|
-
# The organization that contains the
|
1340
|
+
# The organization that contains the user, group, or resource to update.
|
1329
1341
|
#
|
1330
1342
|
# @option params [required, String] :entity_id
|
1331
|
-
# The
|
1343
|
+
# The user, group, or resource to update.
|
1332
1344
|
#
|
1333
1345
|
# @option params [required, String] :email
|
1334
1346
|
# The value of the email to be updated as primary.
|
@@ -1352,9 +1364,10 @@ module Aws::WorkMail
|
|
1352
1364
|
req.send_request(options)
|
1353
1365
|
end
|
1354
1366
|
|
1355
|
-
# Updates data for the resource.
|
1356
|
-
#
|
1357
|
-
# should be the one expected when performing another
|
1367
|
+
# Updates data for the resource. To have the latest information, it must
|
1368
|
+
# be preceded by a DescribeResource call. The dataset in the request
|
1369
|
+
# should be the one expected when performing another `DescribeResource`
|
1370
|
+
# call.
|
1358
1371
|
#
|
1359
1372
|
# @option params [required, String] :organization_id
|
1360
1373
|
# The identifier associated with the organization for which the resource
|
@@ -1406,7 +1419,7 @@ module Aws::WorkMail
|
|
1406
1419
|
params: params,
|
1407
1420
|
config: config)
|
1408
1421
|
context[:gem_name] = 'aws-sdk-workmail'
|
1409
|
-
context[:gem_version] = '1.
|
1422
|
+
context[:gem_version] = '1.11.0'
|
1410
1423
|
Seahorse::Client::Request.new(handlers, context)
|
1411
1424
|
end
|
1412
1425
|
|
@@ -473,6 +473,7 @@ module Aws::WorkMail
|
|
473
473
|
"jsonVersion" => "1.1",
|
474
474
|
"protocol" => "json",
|
475
475
|
"serviceFullName" => "Amazon WorkMail",
|
476
|
+
"serviceId" => "WorkMail",
|
476
477
|
"signatureVersion" => "v4",
|
477
478
|
"targetPrefix" => "WorkMailService",
|
478
479
|
"uid" => "workmail-2017-10-01",
|
@@ -22,7 +22,7 @@ module Aws::WorkMail
|
|
22
22
|
# @return [String]
|
23
23
|
#
|
24
24
|
# @!attribute [rw] resource_id
|
25
|
-
# The resource for which members are associated.
|
25
|
+
# The resource for which members (users or groups) are associated.
|
26
26
|
# @return [String]
|
27
27
|
#
|
28
28
|
# @!attribute [rw] entity_id
|
@@ -56,11 +56,11 @@ module Aws::WorkMail
|
|
56
56
|
# @return [String]
|
57
57
|
#
|
58
58
|
# @!attribute [rw] group_id
|
59
|
-
# The group
|
59
|
+
# The group to which the member (user or group) is associated.
|
60
60
|
# @return [String]
|
61
61
|
#
|
62
62
|
# @!attribute [rw] member_id
|
63
|
-
# The member to associate to the group.
|
63
|
+
# The member (user or group) to associate to the group.
|
64
64
|
# @return [String]
|
65
65
|
#
|
66
66
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupRequest AWS API Documentation
|
@@ -122,15 +122,15 @@ module Aws::WorkMail
|
|
122
122
|
# }
|
123
123
|
#
|
124
124
|
# @!attribute [rw] organization_id
|
125
|
-
# The organization under which the member exists.
|
125
|
+
# The organization under which the member (user or group) exists.
|
126
126
|
# @return [String]
|
127
127
|
#
|
128
128
|
# @!attribute [rw] entity_id
|
129
|
-
# The
|
129
|
+
# The member (user or group) to which this alias is added.
|
130
130
|
# @return [String]
|
131
131
|
#
|
132
132
|
# @!attribute [rw] alias
|
133
|
-
# The alias to add to the
|
133
|
+
# The alias to add to the member set.
|
134
134
|
# @return [String]
|
135
135
|
#
|
136
136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasRequest AWS API Documentation
|
@@ -171,7 +171,7 @@ module Aws::WorkMail
|
|
171
171
|
end
|
172
172
|
|
173
173
|
# @!attribute [rw] group_id
|
174
|
-
# The
|
174
|
+
# The identifier of the group.
|
175
175
|
# @return [String]
|
176
176
|
#
|
177
177
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupResponse AWS API Documentation
|
@@ -196,11 +196,12 @@ module Aws::WorkMail
|
|
196
196
|
# @return [String]
|
197
197
|
#
|
198
198
|
# @!attribute [rw] name
|
199
|
-
# The name of the
|
199
|
+
# The name of the new resource.
|
200
200
|
# @return [String]
|
201
201
|
#
|
202
202
|
# @!attribute [rw] type
|
203
|
-
# The type of the
|
203
|
+
# The type of the new resource. The available types are `equipment`
|
204
|
+
# and `room`.
|
204
205
|
# @return [String]
|
205
206
|
#
|
206
207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceRequest AWS API Documentation
|
@@ -213,7 +214,7 @@ module Aws::WorkMail
|
|
213
214
|
end
|
214
215
|
|
215
216
|
# @!attribute [rw] resource_id
|
216
|
-
# The identifier of the
|
217
|
+
# The identifier of the new resource.
|
217
218
|
# @return [String]
|
218
219
|
#
|
219
220
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceResponse AWS API Documentation
|
@@ -238,15 +239,16 @@ module Aws::WorkMail
|
|
238
239
|
# @return [String]
|
239
240
|
#
|
240
241
|
# @!attribute [rw] name
|
241
|
-
# The name for the user
|
242
|
+
# The name for the new user. Simple AD or AD Connector user names have
|
243
|
+
# a maximum length of 20. All others have a maximum length of 64.
|
242
244
|
# @return [String]
|
243
245
|
#
|
244
246
|
# @!attribute [rw] display_name
|
245
|
-
# The display name for the user
|
247
|
+
# The display name for the new user.
|
246
248
|
# @return [String]
|
247
249
|
#
|
248
250
|
# @!attribute [rw] password
|
249
|
-
# The password for the user
|
251
|
+
# The password for the new user.
|
250
252
|
# @return [String]
|
251
253
|
#
|
252
254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserRequest AWS API Documentation
|
@@ -260,7 +262,7 @@ module Aws::WorkMail
|
|
260
262
|
end
|
261
263
|
|
262
264
|
# @!attribute [rw] user_id
|
263
|
-
# The
|
265
|
+
# The identifier for the new user.
|
264
266
|
# @return [String]
|
265
267
|
#
|
266
268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserResponse AWS API Documentation
|
@@ -274,8 +276,8 @@ module Aws::WorkMail
|
|
274
276
|
# UserAttribute enumeration.
|
275
277
|
#
|
276
278
|
# @!attribute [rw] id
|
277
|
-
# The identifier for the user or group
|
278
|
-
#
|
279
|
+
# The identifier for the user or group associated as the resource's
|
280
|
+
# delegate.
|
279
281
|
# @return [String]
|
280
282
|
#
|
281
283
|
# @!attribute [rw] type
|
@@ -304,8 +306,8 @@ module Aws::WorkMail
|
|
304
306
|
# @return [String]
|
305
307
|
#
|
306
308
|
# @!attribute [rw] entity_id
|
307
|
-
# The identifier for the
|
308
|
-
# removed.
|
309
|
+
# The identifier for the member (user or group) from which to have the
|
310
|
+
# aliases removed.
|
309
311
|
# @return [String]
|
310
312
|
#
|
311
313
|
# @!attribute [rw] alias
|
@@ -365,17 +367,16 @@ module Aws::WorkMail
|
|
365
367
|
# }
|
366
368
|
#
|
367
369
|
# @!attribute [rw] organization_id
|
368
|
-
# The identifier of the organization under which the
|
370
|
+
# The identifier of the organization under which the member (user or
|
369
371
|
# group) exists.
|
370
372
|
# @return [String]
|
371
373
|
#
|
372
374
|
# @!attribute [rw] entity_id
|
373
|
-
# The identifier of the
|
374
|
-
# mailbox permissions.
|
375
|
+
# The identifier of the member (user or group)that owns the mailbox.
|
375
376
|
# @return [String]
|
376
377
|
#
|
377
378
|
# @!attribute [rw] grantee_id
|
378
|
-
# The identifier of the
|
379
|
+
# The identifier of the member (user or group) for which to delete
|
379
380
|
# granted permissions.
|
380
381
|
# @return [String]
|
381
382
|
#
|
@@ -401,7 +402,7 @@ module Aws::WorkMail
|
|
401
402
|
# }
|
402
403
|
#
|
403
404
|
# @!attribute [rw] organization_id
|
404
|
-
# The identifier associated with the organization
|
405
|
+
# The identifier associated with the organization from which the
|
405
406
|
# resource is deleted.
|
406
407
|
# @return [String]
|
407
408
|
#
|
@@ -430,7 +431,7 @@ module Aws::WorkMail
|
|
430
431
|
# }
|
431
432
|
#
|
432
433
|
# @!attribute [rw] organization_id
|
433
|
-
# The organization that contains the user.
|
434
|
+
# The organization that contains the user to be deleted.
|
434
435
|
# @return [String]
|
435
436
|
#
|
436
437
|
# @!attribute [rw] user_id
|
@@ -463,7 +464,7 @@ module Aws::WorkMail
|
|
463
464
|
# @return [String]
|
464
465
|
#
|
465
466
|
# @!attribute [rw] entity_id
|
466
|
-
# The identifier for the
|
467
|
+
# The identifier for the member (user or group) to be updated.
|
467
468
|
# @return [String]
|
468
469
|
#
|
469
470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailRequest AWS API Documentation
|
@@ -516,17 +517,17 @@ module Aws::WorkMail
|
|
516
517
|
#
|
517
518
|
# @!attribute [rw] state
|
518
519
|
# The state of the user: enabled (registered to Amazon WorkMail) or
|
519
|
-
# disabled (deregistered or never registered to
|
520
|
+
# disabled (deregistered or never registered to WorkMail).
|
520
521
|
# @return [String]
|
521
522
|
#
|
522
523
|
# @!attribute [rw] enabled_date
|
523
|
-
# The date and time when a user was registered to
|
524
|
-
#
|
524
|
+
# The date and time when a user was registered to WorkMail, in UNIX
|
525
|
+
# epoch time format.
|
525
526
|
# @return [Time]
|
526
527
|
#
|
527
528
|
# @!attribute [rw] disabled_date
|
528
|
-
# The date and time when a user was deregistered from
|
529
|
-
#
|
529
|
+
# The date and time when a user was deregistered from WorkMail, in
|
530
|
+
# UNIX epoch time format.
|
530
531
|
# @return [Time]
|
531
532
|
#
|
532
533
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupResponse AWS API Documentation
|
@@ -577,8 +578,7 @@ module Aws::WorkMail
|
|
577
578
|
# @return [String]
|
578
579
|
#
|
579
580
|
# @!attribute [rw] directory_type
|
580
|
-
# The type of directory associated with the
|
581
|
-
# organization.
|
581
|
+
# The type of directory associated with the WorkMail organization.
|
582
582
|
# @return [String]
|
583
583
|
#
|
584
584
|
# @!attribute [rw] default_mail_domain
|
@@ -586,12 +586,12 @@ module Aws::WorkMail
|
|
586
586
|
# @return [String]
|
587
587
|
#
|
588
588
|
# @!attribute [rw] completed_date
|
589
|
-
# The date at which the organization became usable in the
|
590
|
-
#
|
589
|
+
# The date at which the organization became usable in the WorkMail
|
590
|
+
# context, in UNIX epoch time format.
|
591
591
|
# @return [Time]
|
592
592
|
#
|
593
593
|
# @!attribute [rw] error_message
|
594
|
-
#
|
594
|
+
# (Optional) The error message indicating if unexpected behavior was
|
595
595
|
# encountered with regards to the organization.
|
596
596
|
# @return [String]
|
597
597
|
#
|
@@ -656,17 +656,17 @@ module Aws::WorkMail
|
|
656
656
|
#
|
657
657
|
# @!attribute [rw] state
|
658
658
|
# The state of the resource: enabled (registered to Amazon WorkMail)
|
659
|
-
# or disabled (deregistered or never registered to
|
659
|
+
# or disabled (deregistered or never registered to WorkMail).
|
660
660
|
# @return [String]
|
661
661
|
#
|
662
662
|
# @!attribute [rw] enabled_date
|
663
|
-
# The date and time when a resource was
|
664
|
-
#
|
663
|
+
# The date and time when a resource was enabled for WorkMail, in UNIX
|
664
|
+
# epoch time format.
|
665
665
|
# @return [Time]
|
666
666
|
#
|
667
667
|
# @!attribute [rw] disabled_date
|
668
|
-
# The date and time when a resource was
|
669
|
-
#
|
668
|
+
# The date and time when a resource was disabled from WorkMail, in
|
669
|
+
# UNIX epoch time format.
|
670
670
|
# @return [Time]
|
671
671
|
#
|
672
672
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceResponse AWS API Documentation
|
@@ -725,17 +725,17 @@ module Aws::WorkMail
|
|
725
725
|
#
|
726
726
|
# @!attribute [rw] state
|
727
727
|
# The state of a user: enabled (registered to Amazon WorkMail) or
|
728
|
-
# disabled (deregistered or never registered to
|
728
|
+
# disabled (deregistered or never registered to WorkMail).
|
729
729
|
# @return [String]
|
730
730
|
#
|
731
731
|
# @!attribute [rw] user_role
|
732
|
-
# In certain cases other entities are modeled as users. If
|
732
|
+
# In certain cases, other entities are modeled as users. If
|
733
733
|
# interoperability is enabled, resources are imported into Amazon
|
734
|
-
# WorkMail as users. Because different
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
734
|
+
# WorkMail as users. Because different WorkMail organizations rely on
|
735
|
+
# different directory types, administrators can distinguish between an
|
736
|
+
# unregistered user (account is disabled and has a user role) and the
|
737
|
+
# directory administrators. The values are USER, RESOURCE, and
|
738
|
+
# SYSTEM\_USER.
|
739
739
|
# @return [String]
|
740
740
|
#
|
741
741
|
# @!attribute [rw] enabled_date
|
@@ -941,7 +941,8 @@ module Aws::WorkMail
|
|
941
941
|
# @return [String]
|
942
942
|
#
|
943
943
|
# @!attribute [rw] group_id
|
944
|
-
# The identifier for the group to which the members
|
944
|
+
# The identifier for the group to which the members (users or groups)
|
945
|
+
# are associated.
|
945
946
|
# @return [String]
|
946
947
|
#
|
947
948
|
# @!attribute [rw] next_token
|
@@ -1039,12 +1040,12 @@ module Aws::WorkMail
|
|
1039
1040
|
# }
|
1040
1041
|
#
|
1041
1042
|
# @!attribute [rw] organization_id
|
1042
|
-
# The identifier of the organization under which the
|
1043
|
-
#
|
1043
|
+
# The identifier of the organization under which the user, group, or
|
1044
|
+
# resource exists.
|
1044
1045
|
# @return [String]
|
1045
1046
|
#
|
1046
1047
|
# @!attribute [rw] entity_id
|
1047
|
-
# The identifier of the
|
1048
|
+
# The identifier of the user, group, or resource for which to list
|
1048
1049
|
# mailbox permissions.
|
1049
1050
|
# @return [String]
|
1050
1051
|
#
|
@@ -1068,7 +1069,7 @@ module Aws::WorkMail
|
|
1068
1069
|
end
|
1069
1070
|
|
1070
1071
|
# @!attribute [rw] permissions
|
1071
|
-
# One page of the
|
1072
|
+
# One page of the user, group, or resource mailbox permissions.
|
1072
1073
|
# @return [Array<Types::Permission>]
|
1073
1074
|
#
|
1074
1075
|
# @!attribute [rw] next_token
|
@@ -1246,7 +1247,8 @@ module Aws::WorkMail
|
|
1246
1247
|
# @return [String]
|
1247
1248
|
#
|
1248
1249
|
# @!attribute [rw] next_token
|
1249
|
-
#
|
1250
|
+
# The token to use to retrieve the next page of results. The first
|
1251
|
+
# call does not contain any tokens.
|
1250
1252
|
# @return [String]
|
1251
1253
|
#
|
1252
1254
|
# @!attribute [rw] max_results
|
@@ -1279,7 +1281,7 @@ module Aws::WorkMail
|
|
1279
1281
|
include Aws::Structure
|
1280
1282
|
end
|
1281
1283
|
|
1282
|
-
# The representation of a
|
1284
|
+
# The representation of a user or group.
|
1283
1285
|
#
|
1284
1286
|
# @!attribute [rw] id
|
1285
1287
|
# The identifier of the member.
|
@@ -1319,7 +1321,7 @@ module Aws::WorkMail
|
|
1319
1321
|
include Aws::Structure
|
1320
1322
|
end
|
1321
1323
|
|
1322
|
-
# The
|
1324
|
+
# The representation of an organization.
|
1323
1325
|
#
|
1324
1326
|
# @!attribute [rw] organization_id
|
1325
1327
|
# The identifier associated with the organization.
|
@@ -1350,17 +1352,16 @@ module Aws::WorkMail
|
|
1350
1352
|
include Aws::Structure
|
1351
1353
|
end
|
1352
1354
|
|
1353
|
-
# Permission granted to
|
1354
|
-
# aspect of another
|
1355
|
+
# Permission granted to a user, group, or resource to access a certain
|
1356
|
+
# aspect of another user, group, or resource mailbox.
|
1355
1357
|
#
|
1356
1358
|
# @!attribute [rw] grantee_id
|
1357
|
-
# The identifier of the
|
1359
|
+
# The identifier of the user, group, or resource to which the
|
1358
1360
|
# permissions are granted.
|
1359
1361
|
# @return [String]
|
1360
1362
|
#
|
1361
1363
|
# @!attribute [rw] grantee_type
|
1362
|
-
# The type of
|
1363
|
-
# GranteeId.
|
1364
|
+
# The type of user, group, or resource referred to in GranteeId.
|
1364
1365
|
# @return [String]
|
1365
1366
|
#
|
1366
1367
|
# @!attribute [rw] permission_values
|
@@ -1393,17 +1394,17 @@ module Aws::WorkMail
|
|
1393
1394
|
# }
|
1394
1395
|
#
|
1395
1396
|
# @!attribute [rw] organization_id
|
1396
|
-
# The identifier of the organization under which the
|
1397
|
-
#
|
1397
|
+
# The identifier of the organization under which the user, group, or
|
1398
|
+
# resource exists.
|
1398
1399
|
# @return [String]
|
1399
1400
|
#
|
1400
1401
|
# @!attribute [rw] entity_id
|
1401
|
-
# The identifier of the
|
1402
|
+
# The identifier of the user, group, or resource for which to update
|
1402
1403
|
# mailbox permissions.
|
1403
1404
|
# @return [String]
|
1404
1405
|
#
|
1405
1406
|
# @!attribute [rw] grantee_id
|
1406
|
-
# The identifier of the
|
1407
|
+
# The identifier of the user, group, or resource to which to grant the
|
1407
1408
|
# permissions.
|
1408
1409
|
# @return [String]
|
1409
1410
|
#
|
@@ -1441,16 +1442,16 @@ module Aws::WorkMail
|
|
1441
1442
|
# }
|
1442
1443
|
#
|
1443
1444
|
# @!attribute [rw] organization_id
|
1444
|
-
# The identifier for the organization under which the
|
1445
|
-
#
|
1445
|
+
# The identifier for the organization under which the user, group, or
|
1446
|
+
# resource exists.
|
1446
1447
|
# @return [String]
|
1447
1448
|
#
|
1448
1449
|
# @!attribute [rw] entity_id
|
1449
|
-
# The identifier for the
|
1450
|
+
# The identifier for the user, group, or resource to be updated.
|
1450
1451
|
# @return [String]
|
1451
1452
|
#
|
1452
1453
|
# @!attribute [rw] email
|
1453
|
-
# The email for the
|
1454
|
+
# The email for the user, group, or resource to be updated.
|
1454
1455
|
# @return [String]
|
1455
1456
|
#
|
1456
1457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailRequest AWS API Documentation
|
@@ -1501,7 +1502,7 @@ module Aws::WorkMail
|
|
1501
1502
|
#
|
1502
1503
|
class ResetPasswordResponse < Aws::EmptyStructure; end
|
1503
1504
|
|
1504
|
-
# The
|
1505
|
+
# The representation of a resource.
|
1505
1506
|
#
|
1506
1507
|
# @!attribute [rw] id
|
1507
1508
|
# The identifier of the resource.
|
@@ -1557,11 +1558,12 @@ module Aws::WorkMail
|
|
1557
1558
|
# }
|
1558
1559
|
#
|
1559
1560
|
# @!attribute [rw] organization_id
|
1560
|
-
# The organization that contains the
|
1561
|
+
# The organization that contains the user, group, or resource to
|
1562
|
+
# update.
|
1561
1563
|
# @return [String]
|
1562
1564
|
#
|
1563
1565
|
# @!attribute [rw] entity_id
|
1564
|
-
# The
|
1566
|
+
# The user, group, or resource to update.
|
1565
1567
|
# @return [String]
|
1566
1568
|
#
|
1567
1569
|
# @!attribute [rw] email
|
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.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-03-
|
11
|
+
date: 2019-03-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|