aws-sdk-workmail 1.57.0 → 1.59.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workmail/client.rb +684 -44
- data/lib/aws-sdk-workmail/client_api.rb +230 -32
- data/lib/aws-sdk-workmail/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-workmail/endpoints.rb +56 -0
- data/lib/aws-sdk-workmail/plugins/endpoints.rb +8 -0
- data/lib/aws-sdk-workmail/types.rb +849 -26
- data/lib/aws-sdk-workmail.rb +1 -1
- metadata +2 -2
@@ -94,10 +94,29 @@ module Aws::WorkMail
|
|
94
94
|
#
|
95
95
|
# @!attribute [rw] resource_id
|
96
96
|
# The resource for which members (users or groups) are associated.
|
97
|
+
#
|
98
|
+
# The identifier can accept *ResourceId*, *Resourcename*, or *email*.
|
99
|
+
# The following identity formats are available:
|
100
|
+
#
|
101
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
102
|
+
#
|
103
|
+
# * Email address: resource@domain.tld
|
104
|
+
#
|
105
|
+
# * Resource name: resource
|
97
106
|
# @return [String]
|
98
107
|
#
|
99
108
|
# @!attribute [rw] entity_id
|
100
109
|
# The member (user or group) to associate to the resource.
|
110
|
+
#
|
111
|
+
# The entity ID can accept *UserId or GroupID*, *Username or
|
112
|
+
# Groupname*, or *email*.
|
113
|
+
#
|
114
|
+
# * Entity: 12345678-1234-1234-1234-123456789012 or
|
115
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
116
|
+
#
|
117
|
+
# * Email address: entity@domain.tld
|
118
|
+
#
|
119
|
+
# * Entity: entity
|
101
120
|
# @return [String]
|
102
121
|
#
|
103
122
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceRequest AWS API Documentation
|
@@ -120,10 +139,30 @@ module Aws::WorkMail
|
|
120
139
|
#
|
121
140
|
# @!attribute [rw] group_id
|
122
141
|
# The group to which the member (user or group) is associated.
|
142
|
+
#
|
143
|
+
# The identifier can accept *GroupId*, *Groupname*, or *email*. The
|
144
|
+
# following identity formats are available:
|
145
|
+
#
|
146
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
147
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
148
|
+
#
|
149
|
+
# * Email address: group@domain.tld
|
150
|
+
#
|
151
|
+
# * Group name: group
|
123
152
|
# @return [String]
|
124
153
|
#
|
125
154
|
# @!attribute [rw] member_id
|
126
155
|
# The member (user or group) to associate to the group.
|
156
|
+
#
|
157
|
+
# The member ID can accept *UserID or GroupId*, *Username or
|
158
|
+
# Groupname*, or *email*.
|
159
|
+
#
|
160
|
+
# * Member: 12345678-1234-1234-1234-123456789012 or
|
161
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
162
|
+
#
|
163
|
+
# * Email address: member@domain.tld
|
164
|
+
#
|
165
|
+
# * Member name: member
|
127
166
|
# @return [String]
|
128
167
|
#
|
129
168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupRequest AWS API Documentation
|
@@ -355,11 +394,17 @@ module Aws::WorkMail
|
|
355
394
|
# The name of the group.
|
356
395
|
# @return [String]
|
357
396
|
#
|
397
|
+
# @!attribute [rw] hidden_from_global_address_list
|
398
|
+
# If this parameter is enabled, the group will be hidden from the
|
399
|
+
# address book.
|
400
|
+
# @return [Boolean]
|
401
|
+
#
|
358
402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupRequest AWS API Documentation
|
359
403
|
#
|
360
404
|
class CreateGroupRequest < Struct.new(
|
361
405
|
:organization_id,
|
362
|
-
:name
|
406
|
+
:name,
|
407
|
+
:hidden_from_global_address_list)
|
363
408
|
SENSITIVE = []
|
364
409
|
include Aws::Structure
|
365
410
|
end
|
@@ -591,12 +636,23 @@ module Aws::WorkMail
|
|
591
636
|
# and `room`.
|
592
637
|
# @return [String]
|
593
638
|
#
|
639
|
+
# @!attribute [rw] description
|
640
|
+
# Resource description.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] hidden_from_global_address_list
|
644
|
+
# If this parameter is enabled, the resource will be hidden from the
|
645
|
+
# address book.
|
646
|
+
# @return [Boolean]
|
647
|
+
#
|
594
648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceRequest AWS API Documentation
|
595
649
|
#
|
596
650
|
class CreateResourceRequest < Struct.new(
|
597
651
|
:organization_id,
|
598
652
|
:name,
|
599
|
-
:type
|
653
|
+
:type,
|
654
|
+
:description,
|
655
|
+
:hidden_from_global_address_list)
|
600
656
|
SENSITIVE = []
|
601
657
|
include Aws::Structure
|
602
658
|
end
|
@@ -630,14 +686,39 @@ module Aws::WorkMail
|
|
630
686
|
# The password for the new user.
|
631
687
|
# @return [String]
|
632
688
|
#
|
689
|
+
# @!attribute [rw] role
|
690
|
+
# The role of the new user.
|
691
|
+
#
|
692
|
+
# You cannot pass *SYSTEM\_USER* or *RESOURCE* role in a single
|
693
|
+
# request. When a user role is not selected, the default role of
|
694
|
+
# *USER* is selected.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] first_name
|
698
|
+
# The first name of the new user.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] last_name
|
702
|
+
# The last name of the new user.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] hidden_from_global_address_list
|
706
|
+
# If this parameter is enabled, the user will be hidden from the
|
707
|
+
# address book.
|
708
|
+
# @return [Boolean]
|
709
|
+
#
|
633
710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserRequest AWS API Documentation
|
634
711
|
#
|
635
712
|
class CreateUserRequest < Struct.new(
|
636
713
|
:organization_id,
|
637
714
|
:name,
|
638
715
|
:display_name,
|
639
|
-
:password
|
640
|
-
|
716
|
+
:password,
|
717
|
+
:role,
|
718
|
+
:first_name,
|
719
|
+
:last_name,
|
720
|
+
:hidden_from_global_address_list)
|
721
|
+
SENSITIVE = [:display_name, :password, :first_name, :last_name]
|
641
722
|
include Aws::Structure
|
642
723
|
end
|
643
724
|
|
@@ -770,6 +851,14 @@ module Aws::WorkMail
|
|
770
851
|
#
|
771
852
|
# @!attribute [rw] group_id
|
772
853
|
# The identifier of the group to be deleted.
|
854
|
+
#
|
855
|
+
# The identifier can be the *GroupId*, or *Groupname*. The following
|
856
|
+
# identity formats are available:
|
857
|
+
#
|
858
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
859
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
860
|
+
#
|
861
|
+
# * Group name: group
|
773
862
|
# @return [String]
|
774
863
|
#
|
775
864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupRequest AWS API Documentation
|
@@ -813,12 +902,34 @@ module Aws::WorkMail
|
|
813
902
|
# @return [String]
|
814
903
|
#
|
815
904
|
# @!attribute [rw] entity_id
|
816
|
-
# The identifier of the
|
905
|
+
# The identifier of the entity that owns the mailbox.
|
906
|
+
#
|
907
|
+
# The identifier can be *UserId or Group Id*, *Username or Groupname*,
|
908
|
+
# or *email*.
|
909
|
+
#
|
910
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
911
|
+
# r-0123456789a0123456789b0123456789, or
|
912
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
913
|
+
#
|
914
|
+
# * Email address: entity@domain.tld
|
915
|
+
#
|
916
|
+
# * Entity name: entity
|
817
917
|
# @return [String]
|
818
918
|
#
|
819
919
|
# @!attribute [rw] grantee_id
|
820
|
-
# The identifier of the
|
821
|
-
#
|
920
|
+
# The identifier of the entity for which to delete granted
|
921
|
+
# permissions.
|
922
|
+
#
|
923
|
+
# The identifier can be *UserId, ResourceID, or Group Id*, *Username
|
924
|
+
# or Groupname*, or *email*.
|
925
|
+
#
|
926
|
+
# * Grantee ID:
|
927
|
+
# 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789,
|
928
|
+
# or S-1-1-12-1234567890-123456789-123456789-1234
|
929
|
+
#
|
930
|
+
# * Email address: grantee@domain.tld
|
931
|
+
#
|
932
|
+
# * Grantee name: grantee
|
822
933
|
# @return [String]
|
823
934
|
#
|
824
935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissionsRequest AWS API Documentation
|
@@ -908,12 +1019,18 @@ module Aws::WorkMail
|
|
908
1019
|
# the organization.
|
909
1020
|
# @return [Boolean]
|
910
1021
|
#
|
1022
|
+
# @!attribute [rw] force_delete
|
1023
|
+
# Deletes a WorkMail organization even if the organization has enabled
|
1024
|
+
# users.
|
1025
|
+
# @return [Boolean]
|
1026
|
+
#
|
911
1027
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganizationRequest AWS API Documentation
|
912
1028
|
#
|
913
1029
|
class DeleteOrganizationRequest < Struct.new(
|
914
1030
|
:client_token,
|
915
1031
|
:organization_id,
|
916
|
-
:delete_directory
|
1032
|
+
:delete_directory,
|
1033
|
+
:force_delete)
|
917
1034
|
SENSITIVE = []
|
918
1035
|
include Aws::Structure
|
919
1036
|
end
|
@@ -942,6 +1059,13 @@ module Aws::WorkMail
|
|
942
1059
|
#
|
943
1060
|
# @!attribute [rw] resource_id
|
944
1061
|
# The identifier of the resource to be deleted.
|
1062
|
+
#
|
1063
|
+
# The identifier can accept *ResourceId*, or *Resourcename*. The
|
1064
|
+
# following identity formats are available:
|
1065
|
+
#
|
1066
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
1067
|
+
#
|
1068
|
+
# * Resource name: resource
|
945
1069
|
# @return [String]
|
946
1070
|
#
|
947
1071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceRequest AWS API Documentation
|
@@ -984,6 +1108,14 @@ module Aws::WorkMail
|
|
984
1108
|
#
|
985
1109
|
# @!attribute [rw] user_id
|
986
1110
|
# The identifier of the user to be deleted.
|
1111
|
+
#
|
1112
|
+
# The identifier can be the *UserId* or *Username*. The following
|
1113
|
+
# identity formats are available:
|
1114
|
+
#
|
1115
|
+
# * User ID: 12345678-1234-1234-1234-123456789012 or
|
1116
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1117
|
+
#
|
1118
|
+
# * User name: user
|
987
1119
|
# @return [String]
|
988
1120
|
#
|
989
1121
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserRequest AWS API Documentation
|
@@ -1005,7 +1137,18 @@ module Aws::WorkMail
|
|
1005
1137
|
# @return [String]
|
1006
1138
|
#
|
1007
1139
|
# @!attribute [rw] entity_id
|
1008
|
-
# The identifier for the member
|
1140
|
+
# The identifier for the member to be updated.
|
1141
|
+
#
|
1142
|
+
# The identifier can be *UserId, ResourceId, or Group Id*, *Username,
|
1143
|
+
# Resourcename, or Groupname*, or *email*.
|
1144
|
+
#
|
1145
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
1146
|
+
# r-0123456789a0123456789b0123456789, or
|
1147
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1148
|
+
#
|
1149
|
+
# * Email address: entity@domain.tld
|
1150
|
+
#
|
1151
|
+
# * Entity name: entity
|
1009
1152
|
# @return [String]
|
1010
1153
|
#
|
1011
1154
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailRequest AWS API Documentation
|
@@ -1074,12 +1217,61 @@ module Aws::WorkMail
|
|
1074
1217
|
include Aws::Structure
|
1075
1218
|
end
|
1076
1219
|
|
1220
|
+
# @!attribute [rw] organization_id
|
1221
|
+
# The identifier for the organization under which the entity exists.
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] email
|
1225
|
+
# The email under which the entity exists.
|
1226
|
+
# @return [String]
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeEntityRequest AWS API Documentation
|
1229
|
+
#
|
1230
|
+
class DescribeEntityRequest < Struct.new(
|
1231
|
+
:organization_id,
|
1232
|
+
:email)
|
1233
|
+
SENSITIVE = []
|
1234
|
+
include Aws::Structure
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# @!attribute [rw] entity_id
|
1238
|
+
# The entity ID under which the entity exists.
|
1239
|
+
# @return [String]
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] name
|
1242
|
+
# Username, GroupName, or ResourceName based on entity type.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] type
|
1246
|
+
# Entity type.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeEntityResponse AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class DescribeEntityResponse < Struct.new(
|
1252
|
+
:entity_id,
|
1253
|
+
:name,
|
1254
|
+
:type)
|
1255
|
+
SENSITIVE = []
|
1256
|
+
include Aws::Structure
|
1257
|
+
end
|
1258
|
+
|
1077
1259
|
# @!attribute [rw] organization_id
|
1078
1260
|
# The identifier for the organization under which the group exists.
|
1079
1261
|
# @return [String]
|
1080
1262
|
#
|
1081
1263
|
# @!attribute [rw] group_id
|
1082
1264
|
# The identifier for the group to be described.
|
1265
|
+
#
|
1266
|
+
# The identifier can accept *GroupId*, *Groupname*, or *email*. The
|
1267
|
+
# following identity formats are available:
|
1268
|
+
#
|
1269
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
1270
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1271
|
+
#
|
1272
|
+
# * Email address: group@domain.tld
|
1273
|
+
#
|
1274
|
+
# * Group name: group
|
1083
1275
|
# @return [String]
|
1084
1276
|
#
|
1085
1277
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupRequest AWS API Documentation
|
@@ -1118,6 +1310,11 @@ module Aws::WorkMail
|
|
1118
1310
|
# UNIX epoch time format.
|
1119
1311
|
# @return [Time]
|
1120
1312
|
#
|
1313
|
+
# @!attribute [rw] hidden_from_global_address_list
|
1314
|
+
# If the value is set to *true*, the group is hidden from the address
|
1315
|
+
# book.
|
1316
|
+
# @return [Boolean]
|
1317
|
+
#
|
1121
1318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupResponse AWS API Documentation
|
1122
1319
|
#
|
1123
1320
|
class DescribeGroupResponse < Struct.new(
|
@@ -1126,7 +1323,8 @@ module Aws::WorkMail
|
|
1126
1323
|
:email,
|
1127
1324
|
:state,
|
1128
1325
|
:enabled_date,
|
1129
|
-
:disabled_date
|
1326
|
+
:disabled_date,
|
1327
|
+
:hidden_from_global_address_list)
|
1130
1328
|
SENSITIVE = []
|
1131
1329
|
include Aws::Structure
|
1132
1330
|
end
|
@@ -1295,6 +1493,15 @@ module Aws::WorkMail
|
|
1295
1493
|
# The Amazon Resource Name (ARN) of the organization.
|
1296
1494
|
# @return [String]
|
1297
1495
|
#
|
1496
|
+
# @!attribute [rw] migration_admin
|
1497
|
+
# The user ID of the migration admin if migration is enabled for the
|
1498
|
+
# organization.
|
1499
|
+
# @return [String]
|
1500
|
+
#
|
1501
|
+
# @!attribute [rw] interoperability_enabled
|
1502
|
+
# Indicates if interoperability is enabled for this organization.
|
1503
|
+
# @return [Boolean]
|
1504
|
+
#
|
1298
1505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationResponse AWS API Documentation
|
1299
1506
|
#
|
1300
1507
|
class DescribeOrganizationResponse < Struct.new(
|
@@ -1306,7 +1513,9 @@ module Aws::WorkMail
|
|
1306
1513
|
:default_mail_domain,
|
1307
1514
|
:completed_date,
|
1308
1515
|
:error_message,
|
1309
|
-
:arn
|
1516
|
+
:arn,
|
1517
|
+
:migration_admin,
|
1518
|
+
:interoperability_enabled)
|
1310
1519
|
SENSITIVE = []
|
1311
1520
|
include Aws::Structure
|
1312
1521
|
end
|
@@ -1318,6 +1527,15 @@ module Aws::WorkMail
|
|
1318
1527
|
#
|
1319
1528
|
# @!attribute [rw] resource_id
|
1320
1529
|
# The identifier of the resource to be described.
|
1530
|
+
#
|
1531
|
+
# The identifier can accept *ResourceId*, *Resourcename*, or *email*.
|
1532
|
+
# The following identity formats are available:
|
1533
|
+
#
|
1534
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
1535
|
+
#
|
1536
|
+
# * Email address: resource@domain.tld
|
1537
|
+
#
|
1538
|
+
# * Resource name: resource
|
1321
1539
|
# @return [String]
|
1322
1540
|
#
|
1323
1541
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceRequest AWS API Documentation
|
@@ -1364,6 +1582,14 @@ module Aws::WorkMail
|
|
1364
1582
|
# UNIX epoch time format.
|
1365
1583
|
# @return [Time]
|
1366
1584
|
#
|
1585
|
+
# @!attribute [rw] description
|
1586
|
+
# Description of the resource.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] hidden_from_global_address_list
|
1590
|
+
# If enabled, the resource is hidden from the global address list.
|
1591
|
+
# @return [Boolean]
|
1592
|
+
#
|
1367
1593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceResponse AWS API Documentation
|
1368
1594
|
#
|
1369
1595
|
class DescribeResourceResponse < Struct.new(
|
@@ -1374,7 +1600,9 @@ module Aws::WorkMail
|
|
1374
1600
|
:booking_options,
|
1375
1601
|
:state,
|
1376
1602
|
:enabled_date,
|
1377
|
-
:disabled_date
|
1603
|
+
:disabled_date,
|
1604
|
+
:description,
|
1605
|
+
:hidden_from_global_address_list)
|
1378
1606
|
SENSITIVE = []
|
1379
1607
|
include Aws::Structure
|
1380
1608
|
end
|
@@ -1385,6 +1613,16 @@ module Aws::WorkMail
|
|
1385
1613
|
#
|
1386
1614
|
# @!attribute [rw] user_id
|
1387
1615
|
# The identifier for the user to be described.
|
1616
|
+
#
|
1617
|
+
# The identifier can be the *UserId*, *Username*, or *email*. The
|
1618
|
+
# following identity formats are available:
|
1619
|
+
#
|
1620
|
+
# * User ID: 12345678-1234-1234-1234-123456789012 or
|
1621
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1622
|
+
#
|
1623
|
+
# * Email address: user@domain.tld
|
1624
|
+
#
|
1625
|
+
# * User name: user
|
1388
1626
|
# @return [String]
|
1389
1627
|
#
|
1390
1628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserRequest AWS API Documentation
|
@@ -1423,8 +1661,8 @@ module Aws::WorkMail
|
|
1423
1661
|
# users. Because different WorkMail organizations rely on different
|
1424
1662
|
# directory types, administrators can distinguish between an
|
1425
1663
|
# unregistered user (account is disabled and has a user role) and the
|
1426
|
-
# directory administrators. The values are USER, RESOURCE,
|
1427
|
-
# SYSTEM\_USER.
|
1664
|
+
# directory administrators. The values are USER, RESOURCE,
|
1665
|
+
# SYSTEM\_USER, and REMOTE\_USER.
|
1428
1666
|
# @return [String]
|
1429
1667
|
#
|
1430
1668
|
# @!attribute [rw] enabled_date
|
@@ -1437,6 +1675,66 @@ module Aws::WorkMail
|
|
1437
1675
|
# in UNIX epoch time format.
|
1438
1676
|
# @return [Time]
|
1439
1677
|
#
|
1678
|
+
# @!attribute [rw] mailbox_provisioned_date
|
1679
|
+
# The date when the mailbox was created for the user.
|
1680
|
+
# @return [Time]
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] mailbox_deprovisioned_date
|
1683
|
+
# The date when the mailbox was removed for the user.
|
1684
|
+
# @return [Time]
|
1685
|
+
#
|
1686
|
+
# @!attribute [rw] first_name
|
1687
|
+
# First name of the user.
|
1688
|
+
# @return [String]
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] last_name
|
1691
|
+
# Last name of the user.
|
1692
|
+
# @return [String]
|
1693
|
+
#
|
1694
|
+
# @!attribute [rw] hidden_from_global_address_list
|
1695
|
+
# If enabled, the user is hidden from the global address list.
|
1696
|
+
# @return [Boolean]
|
1697
|
+
#
|
1698
|
+
# @!attribute [rw] initials
|
1699
|
+
# Initials of the user.
|
1700
|
+
# @return [String]
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] telephone
|
1703
|
+
# User's contact number.
|
1704
|
+
# @return [String]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] street
|
1707
|
+
# Street where the user is located.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] job_title
|
1711
|
+
# Job title of the user.
|
1712
|
+
# @return [String]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] city
|
1715
|
+
# City where the user is located.
|
1716
|
+
# @return [String]
|
1717
|
+
#
|
1718
|
+
# @!attribute [rw] company
|
1719
|
+
# Company of the user.
|
1720
|
+
# @return [String]
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] zip_code
|
1723
|
+
# Zip code of the user.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] department
|
1727
|
+
# Department of the user.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] country
|
1731
|
+
# Country where the user is located.
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] office
|
1735
|
+
# Office where the user is located.
|
1736
|
+
# @return [String]
|
1737
|
+
#
|
1440
1738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserResponse AWS API Documentation
|
1441
1739
|
#
|
1442
1740
|
class DescribeUserResponse < Struct.new(
|
@@ -1447,8 +1745,23 @@ module Aws::WorkMail
|
|
1447
1745
|
:state,
|
1448
1746
|
:user_role,
|
1449
1747
|
:enabled_date,
|
1450
|
-
:disabled_date
|
1451
|
-
|
1748
|
+
:disabled_date,
|
1749
|
+
:mailbox_provisioned_date,
|
1750
|
+
:mailbox_deprovisioned_date,
|
1751
|
+
:first_name,
|
1752
|
+
:last_name,
|
1753
|
+
:hidden_from_global_address_list,
|
1754
|
+
:initials,
|
1755
|
+
:telephone,
|
1756
|
+
:street,
|
1757
|
+
:job_title,
|
1758
|
+
:city,
|
1759
|
+
:company,
|
1760
|
+
:zip_code,
|
1761
|
+
:department,
|
1762
|
+
:country,
|
1763
|
+
:office)
|
1764
|
+
SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
|
1452
1765
|
include Aws::Structure
|
1453
1766
|
end
|
1454
1767
|
|
@@ -1501,11 +1814,30 @@ module Aws::WorkMail
|
|
1501
1814
|
# @!attribute [rw] resource_id
|
1502
1815
|
# The identifier of the resource from which delegates' set members
|
1503
1816
|
# are removed.
|
1817
|
+
#
|
1818
|
+
# The identifier can accept *ResourceId*, *Resourcename*, or *email*.
|
1819
|
+
# The following identity formats are available:
|
1820
|
+
#
|
1821
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
1822
|
+
#
|
1823
|
+
# * Email address: resource@domain.tld
|
1824
|
+
#
|
1825
|
+
# * Resource name: resource
|
1504
1826
|
# @return [String]
|
1505
1827
|
#
|
1506
1828
|
# @!attribute [rw] entity_id
|
1507
1829
|
# The identifier for the member (user, group) to be removed from the
|
1508
1830
|
# resource's delegates.
|
1831
|
+
#
|
1832
|
+
# The entity ID can accept *UserId or GroupID*, *Username or
|
1833
|
+
# Groupname*, or *email*.
|
1834
|
+
#
|
1835
|
+
# * Entity: 12345678-1234-1234-1234-123456789012 or
|
1836
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1837
|
+
#
|
1838
|
+
# * Email address: entity@domain.tld
|
1839
|
+
#
|
1840
|
+
# * Entity: entity
|
1509
1841
|
# @return [String]
|
1510
1842
|
#
|
1511
1843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceRequest AWS API Documentation
|
@@ -1528,10 +1860,30 @@ module Aws::WorkMail
|
|
1528
1860
|
#
|
1529
1861
|
# @!attribute [rw] group_id
|
1530
1862
|
# The identifier for the group from which members are removed.
|
1863
|
+
#
|
1864
|
+
# The identifier can accept *GroupId*, *Groupname*, or *email*. The
|
1865
|
+
# following identity formats are available:
|
1866
|
+
#
|
1867
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
1868
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1869
|
+
#
|
1870
|
+
# * Email address: group@domain.tld
|
1871
|
+
#
|
1872
|
+
# * Group name: group
|
1531
1873
|
# @return [String]
|
1532
1874
|
#
|
1533
1875
|
# @!attribute [rw] member_id
|
1534
|
-
# The identifier for the member to be removed
|
1876
|
+
# The identifier for the member to be removed from the group.
|
1877
|
+
#
|
1878
|
+
# The member ID can accept *UserID or GroupId*, *Username or
|
1879
|
+
# Groupname*, or *email*.
|
1880
|
+
#
|
1881
|
+
# * Member ID: 12345678-1234-1234-1234-123456789012 or
|
1882
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
1883
|
+
#
|
1884
|
+
# * Email address: member@domain.tld
|
1885
|
+
#
|
1886
|
+
# * Member name: member
|
1535
1887
|
# @return [String]
|
1536
1888
|
#
|
1537
1889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupRequest AWS API Documentation
|
@@ -1977,6 +2329,16 @@ module Aws::WorkMail
|
|
1977
2329
|
# @!attribute [rw] user_id
|
1978
2330
|
# The identifier for the user whose mailbox details are being
|
1979
2331
|
# requested.
|
2332
|
+
#
|
2333
|
+
# The identifier can be the *UserId*, *Username*, or *email*. The
|
2334
|
+
# following identity formats are available:
|
2335
|
+
#
|
2336
|
+
# * User ID: 12345678-1234-1234-1234-123456789012 or
|
2337
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
2338
|
+
#
|
2339
|
+
# * Email address: user@domain.tld
|
2340
|
+
#
|
2341
|
+
# * User name: user
|
1980
2342
|
# @return [String]
|
1981
2343
|
#
|
1982
2344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetailsRequest AWS API Documentation
|
@@ -2164,6 +2526,25 @@ module Aws::WorkMail
|
|
2164
2526
|
include Aws::Structure
|
2165
2527
|
end
|
2166
2528
|
|
2529
|
+
# The identifier that contains the Group ID and name of a group.
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] group_id
|
2532
|
+
# Group ID that matched the group.
|
2533
|
+
# @return [String]
|
2534
|
+
#
|
2535
|
+
# @!attribute [rw] group_name
|
2536
|
+
# Group name that matched the group.
|
2537
|
+
# @return [String]
|
2538
|
+
#
|
2539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GroupIdentifier AWS API Documentation
|
2540
|
+
#
|
2541
|
+
class GroupIdentifier < Struct.new(
|
2542
|
+
:group_id,
|
2543
|
+
:group_name)
|
2544
|
+
SENSITIVE = []
|
2545
|
+
include Aws::Structure
|
2546
|
+
end
|
2547
|
+
|
2167
2548
|
# The impersonation rule that matched the input.
|
2168
2549
|
#
|
2169
2550
|
# @!attribute [rw] impersonation_rule_id
|
@@ -2467,6 +2848,16 @@ module Aws::WorkMail
|
|
2467
2848
|
# @!attribute [rw] group_id
|
2468
2849
|
# The identifier for the group to which the members (users or groups)
|
2469
2850
|
# are associated.
|
2851
|
+
#
|
2852
|
+
# The identifier can accept *GroupId*, *Groupname*, or *email*. The
|
2853
|
+
# following identity formats are available:
|
2854
|
+
#
|
2855
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
2856
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
2857
|
+
#
|
2858
|
+
# * Email address: group@domain.tld
|
2859
|
+
#
|
2860
|
+
# * Group name: group
|
2470
2861
|
# @return [String]
|
2471
2862
|
#
|
2472
2863
|
# @!attribute [rw] next_token
|
@@ -2507,6 +2898,107 @@ module Aws::WorkMail
|
|
2507
2898
|
include Aws::Structure
|
2508
2899
|
end
|
2509
2900
|
|
2901
|
+
# Filtering options for *ListGroups* operation. This is only used as
|
2902
|
+
# input to Operation.
|
2903
|
+
#
|
2904
|
+
# @!attribute [rw] name_prefix
|
2905
|
+
# Filters only groups with the provided name prefix.
|
2906
|
+
# @return [String]
|
2907
|
+
#
|
2908
|
+
# @!attribute [rw] primary_email_prefix
|
2909
|
+
# Filters only groups with the provided primary email prefix.
|
2910
|
+
# @return [String]
|
2911
|
+
#
|
2912
|
+
# @!attribute [rw] state
|
2913
|
+
# Filters only groups with the provided state.
|
2914
|
+
# @return [String]
|
2915
|
+
#
|
2916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsFilters AWS API Documentation
|
2917
|
+
#
|
2918
|
+
class ListGroupsFilters < Struct.new(
|
2919
|
+
:name_prefix,
|
2920
|
+
:primary_email_prefix,
|
2921
|
+
:state)
|
2922
|
+
SENSITIVE = []
|
2923
|
+
include Aws::Structure
|
2924
|
+
end
|
2925
|
+
|
2926
|
+
# Filtering options for *ListGroupsForEntity* operation. This is only
|
2927
|
+
# used as input to Operation.
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] group_name_prefix
|
2930
|
+
# Filters only group names that start with the provided name prefix.
|
2931
|
+
# @return [String]
|
2932
|
+
#
|
2933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsForEntityFilters AWS API Documentation
|
2934
|
+
#
|
2935
|
+
class ListGroupsForEntityFilters < Struct.new(
|
2936
|
+
:group_name_prefix)
|
2937
|
+
SENSITIVE = []
|
2938
|
+
include Aws::Structure
|
2939
|
+
end
|
2940
|
+
|
2941
|
+
# @!attribute [rw] organization_id
|
2942
|
+
# The identifier for the organization under which the entity exists.
|
2943
|
+
# @return [String]
|
2944
|
+
#
|
2945
|
+
# @!attribute [rw] entity_id
|
2946
|
+
# The identifier for the entity.
|
2947
|
+
#
|
2948
|
+
# The entity ID can accept *UserId or GroupID*, *Username or
|
2949
|
+
# Groupname*, or *email*.
|
2950
|
+
#
|
2951
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012 or
|
2952
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
2953
|
+
#
|
2954
|
+
# * Email address: entity@domain.tld
|
2955
|
+
#
|
2956
|
+
# * Entity name: entity
|
2957
|
+
# @return [String]
|
2958
|
+
#
|
2959
|
+
# @!attribute [rw] filters
|
2960
|
+
# Limit the search results based on the filter criteria.
|
2961
|
+
# @return [Types::ListGroupsForEntityFilters]
|
2962
|
+
#
|
2963
|
+
# @!attribute [rw] next_token
|
2964
|
+
# The token to use to retrieve the next page of results. The first
|
2965
|
+
# call does not contain any tokens.
|
2966
|
+
# @return [String]
|
2967
|
+
#
|
2968
|
+
# @!attribute [rw] max_results
|
2969
|
+
# The maximum number of results to return in a single call.
|
2970
|
+
# @return [Integer]
|
2971
|
+
#
|
2972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsForEntityRequest AWS API Documentation
|
2973
|
+
#
|
2974
|
+
class ListGroupsForEntityRequest < Struct.new(
|
2975
|
+
:organization_id,
|
2976
|
+
:entity_id,
|
2977
|
+
:filters,
|
2978
|
+
:next_token,
|
2979
|
+
:max_results)
|
2980
|
+
SENSITIVE = []
|
2981
|
+
include Aws::Structure
|
2982
|
+
end
|
2983
|
+
|
2984
|
+
# @!attribute [rw] groups
|
2985
|
+
# The overview of groups in an organization.
|
2986
|
+
# @return [Array<Types::GroupIdentifier>]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] next_token
|
2989
|
+
# The token to use to retrieve the next page of results. This value is
|
2990
|
+
# `null` when there are no more results to return.
|
2991
|
+
# @return [String]
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsForEntityResponse AWS API Documentation
|
2994
|
+
#
|
2995
|
+
class ListGroupsForEntityResponse < Struct.new(
|
2996
|
+
:groups,
|
2997
|
+
:next_token)
|
2998
|
+
SENSITIVE = []
|
2999
|
+
include Aws::Structure
|
3000
|
+
end
|
3001
|
+
|
2510
3002
|
# @!attribute [rw] organization_id
|
2511
3003
|
# The identifier for the organization under which the groups exist.
|
2512
3004
|
# @return [String]
|
@@ -2520,12 +3012,18 @@ module Aws::WorkMail
|
|
2520
3012
|
# The maximum number of results to return in a single call.
|
2521
3013
|
# @return [Integer]
|
2522
3014
|
#
|
3015
|
+
# @!attribute [rw] filters
|
3016
|
+
# Limit the search results based on the filter criteria. Only one
|
3017
|
+
# filter per request is supported.
|
3018
|
+
# @return [Types::ListGroupsFilters]
|
3019
|
+
#
|
2523
3020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsRequest AWS API Documentation
|
2524
3021
|
#
|
2525
3022
|
class ListGroupsRequest < Struct.new(
|
2526
3023
|
:organization_id,
|
2527
3024
|
:next_token,
|
2528
|
-
:max_results
|
3025
|
+
:max_results,
|
3026
|
+
:filters)
|
2529
3027
|
SENSITIVE = []
|
2530
3028
|
include Aws::Structure
|
2531
3029
|
end
|
@@ -2679,8 +3177,18 @@ module Aws::WorkMail
|
|
2679
3177
|
# @return [String]
|
2680
3178
|
#
|
2681
3179
|
# @!attribute [rw] entity_id
|
2682
|
-
# The identifier of the user,
|
2683
|
-
#
|
3180
|
+
# The identifier of the user, or resource for which to list mailbox
|
3181
|
+
# permissions.
|
3182
|
+
#
|
3183
|
+
# The entity ID can accept *UserId or ResourceId*, *Username or
|
3184
|
+
# Resourcename*, or *email*.
|
3185
|
+
#
|
3186
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012, or
|
3187
|
+
# r-0123456789a0123456789b0123456789
|
3188
|
+
#
|
3189
|
+
# * Email address: entity@domain.tld
|
3190
|
+
#
|
3191
|
+
# * Entity name: entity
|
2684
3192
|
# @return [String]
|
2685
3193
|
#
|
2686
3194
|
# @!attribute [rw] next_token
|
@@ -2851,6 +3359,15 @@ module Aws::WorkMail
|
|
2851
3359
|
#
|
2852
3360
|
# @!attribute [rw] resource_id
|
2853
3361
|
# The identifier for the resource whose delegates are listed.
|
3362
|
+
#
|
3363
|
+
# The identifier can accept *ResourceId*, *Resourcename*, or *email*.
|
3364
|
+
# The following identity formats are available:
|
3365
|
+
#
|
3366
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
3367
|
+
#
|
3368
|
+
# * Email address: resource@domain.tld
|
3369
|
+
#
|
3370
|
+
# * Resource name: resource
|
2854
3371
|
# @return [String]
|
2855
3372
|
#
|
2856
3373
|
# @!attribute [rw] next_token
|
@@ -2892,6 +3409,31 @@ module Aws::WorkMail
|
|
2892
3409
|
include Aws::Structure
|
2893
3410
|
end
|
2894
3411
|
|
3412
|
+
# Filtering options for *ListResources* operation. This is only used as
|
3413
|
+
# input to Operation.
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] name_prefix
|
3416
|
+
# Filters only resource that start with the entered name prefix .
|
3417
|
+
# @return [String]
|
3418
|
+
#
|
3419
|
+
# @!attribute [rw] primary_email_prefix
|
3420
|
+
# Filters only resource with the provided primary email prefix.
|
3421
|
+
# @return [String]
|
3422
|
+
#
|
3423
|
+
# @!attribute [rw] state
|
3424
|
+
# Filters only resource with the provided state.
|
3425
|
+
# @return [String]
|
3426
|
+
#
|
3427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesFilters AWS API Documentation
|
3428
|
+
#
|
3429
|
+
class ListResourcesFilters < Struct.new(
|
3430
|
+
:name_prefix,
|
3431
|
+
:primary_email_prefix,
|
3432
|
+
:state)
|
3433
|
+
SENSITIVE = []
|
3434
|
+
include Aws::Structure
|
3435
|
+
end
|
3436
|
+
|
2895
3437
|
# @!attribute [rw] organization_id
|
2896
3438
|
# The identifier for the organization under which the resources exist.
|
2897
3439
|
# @return [String]
|
@@ -2905,12 +3447,18 @@ module Aws::WorkMail
|
|
2905
3447
|
# The maximum number of results to return in a single call.
|
2906
3448
|
# @return [Integer]
|
2907
3449
|
#
|
3450
|
+
# @!attribute [rw] filters
|
3451
|
+
# Limit the resource search results based on the filter criteria. You
|
3452
|
+
# can only use one filter per request.
|
3453
|
+
# @return [Types::ListResourcesFilters]
|
3454
|
+
#
|
2908
3455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesRequest AWS API Documentation
|
2909
3456
|
#
|
2910
3457
|
class ListResourcesRequest < Struct.new(
|
2911
3458
|
:organization_id,
|
2912
3459
|
:next_token,
|
2913
|
-
:max_results
|
3460
|
+
:max_results,
|
3461
|
+
:filters)
|
2914
3462
|
SENSITIVE = []
|
2915
3463
|
include Aws::Structure
|
2916
3464
|
end
|
@@ -2958,6 +3506,36 @@ module Aws::WorkMail
|
|
2958
3506
|
include Aws::Structure
|
2959
3507
|
end
|
2960
3508
|
|
3509
|
+
# Filtering options for *ListUsers* operation. This is only used as
|
3510
|
+
# input to Operation.
|
3511
|
+
#
|
3512
|
+
# @!attribute [rw] username_prefix
|
3513
|
+
# Filters only users with the provided username prefix.
|
3514
|
+
# @return [String]
|
3515
|
+
#
|
3516
|
+
# @!attribute [rw] display_name_prefix
|
3517
|
+
# Filters only users with the provided display name prefix.
|
3518
|
+
# @return [String]
|
3519
|
+
#
|
3520
|
+
# @!attribute [rw] primary_email_prefix
|
3521
|
+
# Filters only users with the provided email prefix.
|
3522
|
+
# @return [String]
|
3523
|
+
#
|
3524
|
+
# @!attribute [rw] state
|
3525
|
+
# Filters only users with the provided state.
|
3526
|
+
# @return [String]
|
3527
|
+
#
|
3528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersFilters AWS API Documentation
|
3529
|
+
#
|
3530
|
+
class ListUsersFilters < Struct.new(
|
3531
|
+
:username_prefix,
|
3532
|
+
:display_name_prefix,
|
3533
|
+
:primary_email_prefix,
|
3534
|
+
:state)
|
3535
|
+
SENSITIVE = [:display_name_prefix]
|
3536
|
+
include Aws::Structure
|
3537
|
+
end
|
3538
|
+
|
2961
3539
|
# @!attribute [rw] organization_id
|
2962
3540
|
# The identifier for the organization under which the users exist.
|
2963
3541
|
# @return [String]
|
@@ -2971,12 +3549,18 @@ module Aws::WorkMail
|
|
2971
3549
|
# The maximum number of results to return in a single call.
|
2972
3550
|
# @return [Integer]
|
2973
3551
|
#
|
3552
|
+
# @!attribute [rw] filters
|
3553
|
+
# Limit the user search results based on the filter criteria. You can
|
3554
|
+
# only use one filter per request.
|
3555
|
+
# @return [Types::ListUsersFilters]
|
3556
|
+
#
|
2974
3557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersRequest AWS API Documentation
|
2975
3558
|
#
|
2976
3559
|
class ListUsersRequest < Struct.new(
|
2977
3560
|
:organization_id,
|
2978
3561
|
:next_token,
|
2979
|
-
:max_results
|
3562
|
+
:max_results,
|
3563
|
+
:filters)
|
2980
3564
|
SENSITIVE = []
|
2981
3565
|
include Aws::Structure
|
2982
3566
|
end
|
@@ -3540,13 +4124,35 @@ module Aws::WorkMail
|
|
3540
4124
|
# @return [String]
|
3541
4125
|
#
|
3542
4126
|
# @!attribute [rw] entity_id
|
3543
|
-
# The identifier of the user
|
3544
|
-
#
|
4127
|
+
# The identifier of the user or resource for which to update mailbox
|
4128
|
+
# permissions.
|
4129
|
+
#
|
4130
|
+
# The identifier can be *UserId, ResourceID, or Group Id*, *Username,
|
4131
|
+
# Resourcename, or Groupname*, or *email*.
|
4132
|
+
#
|
4133
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
4134
|
+
# r-0123456789a0123456789b0123456789, or
|
4135
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4136
|
+
#
|
4137
|
+
# * Email address: entity@domain.tld
|
4138
|
+
#
|
4139
|
+
# * Entity name: entity
|
3545
4140
|
# @return [String]
|
3546
4141
|
#
|
3547
4142
|
# @!attribute [rw] grantee_id
|
3548
4143
|
# The identifier of the user, group, or resource to which to grant the
|
3549
4144
|
# permissions.
|
4145
|
+
#
|
4146
|
+
# The identifier can be *UserId, ResourceID, or Group Id*, *Username,
|
4147
|
+
# Resourcename, or Groupname*, or *email*.
|
4148
|
+
#
|
4149
|
+
# * Grantee ID: 12345678-1234-1234-1234-123456789012,
|
4150
|
+
# r-0123456789a0123456789b0123456789, or
|
4151
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4152
|
+
#
|
4153
|
+
# * Email address: grantee@domain.tld
|
4154
|
+
#
|
4155
|
+
# * Grantee name: grantee
|
3550
4156
|
# @return [String]
|
3551
4157
|
#
|
3552
4158
|
# @!attribute [rw] permission_values
|
@@ -3712,6 +4318,16 @@ module Aws::WorkMail
|
|
3712
4318
|
#
|
3713
4319
|
# @!attribute [rw] entity_id
|
3714
4320
|
# The identifier for the user, group, or resource to be updated.
|
4321
|
+
#
|
4322
|
+
# The identifier can accept *UserId, ResourceId, or GroupId*, or
|
4323
|
+
# *Username, Resourcename, or Groupname*. The following identity
|
4324
|
+
# formats are available:
|
4325
|
+
#
|
4326
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
4327
|
+
# r-0123456789a0123456789b0123456789, or
|
4328
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4329
|
+
#
|
4330
|
+
# * Entity name: entity
|
3715
4331
|
# @return [String]
|
3716
4332
|
#
|
3717
4333
|
# @!attribute [rw] email
|
@@ -3804,6 +4420,10 @@ module Aws::WorkMail
|
|
3804
4420
|
# use.
|
3805
4421
|
# @return [Time]
|
3806
4422
|
#
|
4423
|
+
# @!attribute [rw] description
|
4424
|
+
# Resource description.
|
4425
|
+
# @return [String]
|
4426
|
+
#
|
3807
4427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Resource AWS API Documentation
|
3808
4428
|
#
|
3809
4429
|
class Resource < Struct.new(
|
@@ -3813,7 +4433,8 @@ module Aws::WorkMail
|
|
3813
4433
|
:type,
|
3814
4434
|
:state,
|
3815
4435
|
:enabled_date,
|
3816
|
-
:disabled_date
|
4436
|
+
:disabled_date,
|
4437
|
+
:description)
|
3817
4438
|
SENSITIVE = []
|
3818
4439
|
include Aws::Structure
|
3819
4440
|
end
|
@@ -3844,6 +4465,18 @@ module Aws::WorkMail
|
|
3844
4465
|
#
|
3845
4466
|
# @!attribute [rw] entity_id
|
3846
4467
|
# The identifier of the user or resource associated with the mailbox.
|
4468
|
+
#
|
4469
|
+
# The identifier can accept *UserId or ResourceId*, *Username or
|
4470
|
+
# Resourcename*, or *email*. The following identity formats are
|
4471
|
+
# available:
|
4472
|
+
#
|
4473
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
4474
|
+
# r-0123456789a0123456789b0123456789 , or
|
4475
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4476
|
+
#
|
4477
|
+
# * Email address: entity@domain.tld
|
4478
|
+
#
|
4479
|
+
# * Entity name: entity
|
3847
4480
|
# @return [String]
|
3848
4481
|
#
|
3849
4482
|
# @!attribute [rw] description
|
@@ -4091,6 +4724,42 @@ module Aws::WorkMail
|
|
4091
4724
|
#
|
4092
4725
|
class UpdateDefaultMailDomainResponse < Aws::EmptyStructure; end
|
4093
4726
|
|
4727
|
+
# @!attribute [rw] organization_id
|
4728
|
+
# The identifier for the organization under which the group exists.
|
4729
|
+
# @return [String]
|
4730
|
+
#
|
4731
|
+
# @!attribute [rw] group_id
|
4732
|
+
# The identifier for the group to be updated.
|
4733
|
+
#
|
4734
|
+
# The identifier can accept *GroupId*, *Groupname*, or *email*. The
|
4735
|
+
# following identity formats are available:
|
4736
|
+
#
|
4737
|
+
# * Group ID: 12345678-1234-1234-1234-123456789012 or
|
4738
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4739
|
+
#
|
4740
|
+
# * Email address: group@domain.tld
|
4741
|
+
#
|
4742
|
+
# * Group name: group
|
4743
|
+
# @return [String]
|
4744
|
+
#
|
4745
|
+
# @!attribute [rw] hidden_from_global_address_list
|
4746
|
+
# If enabled, the group is hidden from the global address list.
|
4747
|
+
# @return [Boolean]
|
4748
|
+
#
|
4749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateGroupRequest AWS API Documentation
|
4750
|
+
#
|
4751
|
+
class UpdateGroupRequest < Struct.new(
|
4752
|
+
:organization_id,
|
4753
|
+
:group_id,
|
4754
|
+
:hidden_from_global_address_list)
|
4755
|
+
SENSITIVE = []
|
4756
|
+
include Aws::Structure
|
4757
|
+
end
|
4758
|
+
|
4759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateGroupResponse AWS API Documentation
|
4760
|
+
#
|
4761
|
+
class UpdateGroupResponse < Aws::EmptyStructure; end
|
4762
|
+
|
4094
4763
|
# @!attribute [rw] organization_id
|
4095
4764
|
# The WorkMail organization that contains the impersonation role to
|
4096
4765
|
# update.
|
@@ -4140,6 +4809,16 @@ module Aws::WorkMail
|
|
4140
4809
|
#
|
4141
4810
|
# @!attribute [rw] user_id
|
4142
4811
|
# The identifer for the user for whom to update the mailbox quota.
|
4812
|
+
#
|
4813
|
+
# The identifier can be the *UserId*, *Username*, or *email*. The
|
4814
|
+
# following identity formats are available:
|
4815
|
+
#
|
4816
|
+
# * User ID: 12345678-1234-1234-1234-123456789012 or
|
4817
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4818
|
+
#
|
4819
|
+
# * Email address: user@domain.tld
|
4820
|
+
#
|
4821
|
+
# * User name: user
|
4143
4822
|
# @return [String]
|
4144
4823
|
#
|
4145
4824
|
# @!attribute [rw] mailbox_quota
|
@@ -4248,6 +4927,18 @@ module Aws::WorkMail
|
|
4248
4927
|
#
|
4249
4928
|
# @!attribute [rw] entity_id
|
4250
4929
|
# The user, group, or resource to update.
|
4930
|
+
#
|
4931
|
+
# The identifier can accept *UseriD, ResourceId, or GroupId*,
|
4932
|
+
# *Username, Resourcename, or Groupname*, or *email*. The following
|
4933
|
+
# identity formats are available:
|
4934
|
+
#
|
4935
|
+
# * Entity ID: 12345678-1234-1234-1234-123456789012,
|
4936
|
+
# r-0123456789a0123456789b0123456789, or
|
4937
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
4938
|
+
#
|
4939
|
+
# * Email address: entity@domain.tld
|
4940
|
+
#
|
4941
|
+
# * Entity name: entity
|
4251
4942
|
# @return [String]
|
4252
4943
|
#
|
4253
4944
|
# @!attribute [rw] email
|
@@ -4275,6 +4966,15 @@ module Aws::WorkMail
|
|
4275
4966
|
#
|
4276
4967
|
# @!attribute [rw] resource_id
|
4277
4968
|
# The identifier of the resource to be updated.
|
4969
|
+
#
|
4970
|
+
# The identifier can accept *ResourceId*, *Resourcename*, or *email*.
|
4971
|
+
# The following identity formats are available:
|
4972
|
+
#
|
4973
|
+
# * Resource ID: r-0123456789a0123456789b0123456789
|
4974
|
+
#
|
4975
|
+
# * Email address: resource@domain.tld
|
4976
|
+
#
|
4977
|
+
# * Resource name: resource
|
4278
4978
|
# @return [String]
|
4279
4979
|
#
|
4280
4980
|
# @!attribute [rw] name
|
@@ -4285,13 +4985,28 @@ module Aws::WorkMail
|
|
4285
4985
|
# The resource's booking options to be updated.
|
4286
4986
|
# @return [Types::BookingOptions]
|
4287
4987
|
#
|
4988
|
+
# @!attribute [rw] description
|
4989
|
+
# Updates the resource description.
|
4990
|
+
# @return [String]
|
4991
|
+
#
|
4992
|
+
# @!attribute [rw] type
|
4993
|
+
# Updates the resource type.
|
4994
|
+
# @return [String]
|
4995
|
+
#
|
4996
|
+
# @!attribute [rw] hidden_from_global_address_list
|
4997
|
+
# If enabled, the resource is hidden from the global address list.
|
4998
|
+
# @return [Boolean]
|
4999
|
+
#
|
4288
5000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceRequest AWS API Documentation
|
4289
5001
|
#
|
4290
5002
|
class UpdateResourceRequest < Struct.new(
|
4291
5003
|
:organization_id,
|
4292
5004
|
:resource_id,
|
4293
5005
|
:name,
|
4294
|
-
:booking_options
|
5006
|
+
:booking_options,
|
5007
|
+
:description,
|
5008
|
+
:type,
|
5009
|
+
:hidden_from_global_address_list)
|
4295
5010
|
SENSITIVE = []
|
4296
5011
|
include Aws::Structure
|
4297
5012
|
end
|
@@ -4300,6 +5015,114 @@ module Aws::WorkMail
|
|
4300
5015
|
#
|
4301
5016
|
class UpdateResourceResponse < Aws::EmptyStructure; end
|
4302
5017
|
|
5018
|
+
# @!attribute [rw] organization_id
|
5019
|
+
# The identifier for the organization under which the user exists.
|
5020
|
+
# @return [String]
|
5021
|
+
#
|
5022
|
+
# @!attribute [rw] user_id
|
5023
|
+
# The identifier for the user to be updated.
|
5024
|
+
#
|
5025
|
+
# The identifier can be the *UserId*, *Username*, or *email*. The
|
5026
|
+
# following identity formats are available:
|
5027
|
+
#
|
5028
|
+
# * User ID: 12345678-1234-1234-1234-123456789012 or
|
5029
|
+
# S-1-1-12-1234567890-123456789-123456789-1234
|
5030
|
+
#
|
5031
|
+
# * Email address: user@domain.tld
|
5032
|
+
#
|
5033
|
+
# * User name: user
|
5034
|
+
# @return [String]
|
5035
|
+
#
|
5036
|
+
# @!attribute [rw] role
|
5037
|
+
# Updates the user role.
|
5038
|
+
#
|
5039
|
+
# You cannot pass *SYSTEM\_USER* or *RESOURCE*.
|
5040
|
+
# @return [String]
|
5041
|
+
#
|
5042
|
+
# @!attribute [rw] display_name
|
5043
|
+
# Updates the display name of the user.
|
5044
|
+
# @return [String]
|
5045
|
+
#
|
5046
|
+
# @!attribute [rw] first_name
|
5047
|
+
# Updates the user's first name.
|
5048
|
+
# @return [String]
|
5049
|
+
#
|
5050
|
+
# @!attribute [rw] last_name
|
5051
|
+
# Updates the user's last name.
|
5052
|
+
# @return [String]
|
5053
|
+
#
|
5054
|
+
# @!attribute [rw] hidden_from_global_address_list
|
5055
|
+
# If enabled, the user is hidden from the global address list.
|
5056
|
+
# @return [Boolean]
|
5057
|
+
#
|
5058
|
+
# @!attribute [rw] initials
|
5059
|
+
# Updates the user's initials.
|
5060
|
+
# @return [String]
|
5061
|
+
#
|
5062
|
+
# @!attribute [rw] telephone
|
5063
|
+
# Updates the user's contact details.
|
5064
|
+
# @return [String]
|
5065
|
+
#
|
5066
|
+
# @!attribute [rw] street
|
5067
|
+
# Updates the user's street address.
|
5068
|
+
# @return [String]
|
5069
|
+
#
|
5070
|
+
# @!attribute [rw] job_title
|
5071
|
+
# Updates the user's job title.
|
5072
|
+
# @return [String]
|
5073
|
+
#
|
5074
|
+
# @!attribute [rw] city
|
5075
|
+
# Updates the user's city.
|
5076
|
+
# @return [String]
|
5077
|
+
#
|
5078
|
+
# @!attribute [rw] company
|
5079
|
+
# Updates the user's company.
|
5080
|
+
# @return [String]
|
5081
|
+
#
|
5082
|
+
# @!attribute [rw] zip_code
|
5083
|
+
# Updates the user's zipcode.
|
5084
|
+
# @return [String]
|
5085
|
+
#
|
5086
|
+
# @!attribute [rw] department
|
5087
|
+
# Updates the user's department.
|
5088
|
+
# @return [String]
|
5089
|
+
#
|
5090
|
+
# @!attribute [rw] country
|
5091
|
+
# Updates the user's country.
|
5092
|
+
# @return [String]
|
5093
|
+
#
|
5094
|
+
# @!attribute [rw] office
|
5095
|
+
# Updates the user's office.
|
5096
|
+
# @return [String]
|
5097
|
+
#
|
5098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateUserRequest AWS API Documentation
|
5099
|
+
#
|
5100
|
+
class UpdateUserRequest < Struct.new(
|
5101
|
+
:organization_id,
|
5102
|
+
:user_id,
|
5103
|
+
:role,
|
5104
|
+
:display_name,
|
5105
|
+
:first_name,
|
5106
|
+
:last_name,
|
5107
|
+
:hidden_from_global_address_list,
|
5108
|
+
:initials,
|
5109
|
+
:telephone,
|
5110
|
+
:street,
|
5111
|
+
:job_title,
|
5112
|
+
:city,
|
5113
|
+
:company,
|
5114
|
+
:zip_code,
|
5115
|
+
:department,
|
5116
|
+
:country,
|
5117
|
+
:office)
|
5118
|
+
SENSITIVE = [:display_name, :first_name, :last_name, :initials, :telephone, :street, :job_title, :city, :company, :zip_code, :department, :country, :office]
|
5119
|
+
include Aws::Structure
|
5120
|
+
end
|
5121
|
+
|
5122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateUserResponse AWS API Documentation
|
5123
|
+
#
|
5124
|
+
class UpdateUserResponse < Aws::EmptyStructure; end
|
5125
|
+
|
4303
5126
|
# The representation of an WorkMail user.
|
4304
5127
|
#
|
4305
5128
|
# @!attribute [rw] id
|