aws-sdk-workmail 1.25.0 → 1.30.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 +4 -4
- data/lib/aws-sdk-workmail.rb +5 -2
- data/lib/aws-sdk-workmail/client.rb +239 -9
- data/lib/aws-sdk-workmail/client_api.rb +136 -0
- data/lib/aws-sdk-workmail/errors.rb +2 -0
- data/lib/aws-sdk-workmail/resource.rb +2 -0
- data/lib/aws-sdk-workmail/types.rb +414 -0
- metadata +4 -4
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -72,6 +74,7 @@ module Aws::WorkMail
|
|
72
74
|
:not_user_ids,
|
73
75
|
:date_created,
|
74
76
|
:date_modified)
|
77
|
+
SENSITIVE = []
|
75
78
|
include Aws::Structure
|
76
79
|
end
|
77
80
|
|
@@ -102,6 +105,7 @@ module Aws::WorkMail
|
|
102
105
|
:organization_id,
|
103
106
|
:resource_id,
|
104
107
|
:entity_id)
|
108
|
+
SENSITIVE = []
|
105
109
|
include Aws::Structure
|
106
110
|
end
|
107
111
|
|
@@ -136,6 +140,7 @@ module Aws::WorkMail
|
|
136
140
|
:organization_id,
|
137
141
|
:group_id,
|
138
142
|
:member_id)
|
143
|
+
SENSITIVE = []
|
139
144
|
include Aws::Structure
|
140
145
|
end
|
141
146
|
|
@@ -176,9 +181,48 @@ module Aws::WorkMail
|
|
176
181
|
:auto_accept_requests,
|
177
182
|
:auto_decline_recurring_requests,
|
178
183
|
:auto_decline_conflicting_requests)
|
184
|
+
SENSITIVE = []
|
179
185
|
include Aws::Structure
|
180
186
|
end
|
181
187
|
|
188
|
+
# @note When making an API call, you may pass CancelMailboxExportJobRequest
|
189
|
+
# data as a hash:
|
190
|
+
#
|
191
|
+
# {
|
192
|
+
# client_token: "IdempotencyClientToken", # required
|
193
|
+
# job_id: "MailboxExportJobId", # required
|
194
|
+
# organization_id: "OrganizationId", # required
|
195
|
+
# }
|
196
|
+
#
|
197
|
+
# @!attribute [rw] client_token
|
198
|
+
# The idempotency token for the client request.
|
199
|
+
#
|
200
|
+
# **A suitable default value is auto-generated.** You should normally
|
201
|
+
# not need to pass this option.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] job_id
|
205
|
+
# The job ID.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] organization_id
|
209
|
+
# The organization ID.
|
210
|
+
# @return [String]
|
211
|
+
#
|
212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJobRequest AWS API Documentation
|
213
|
+
#
|
214
|
+
class CancelMailboxExportJobRequest < Struct.new(
|
215
|
+
:client_token,
|
216
|
+
:job_id,
|
217
|
+
:organization_id)
|
218
|
+
SENSITIVE = []
|
219
|
+
include Aws::Structure
|
220
|
+
end
|
221
|
+
|
222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJobResponse AWS API Documentation
|
223
|
+
#
|
224
|
+
class CancelMailboxExportJobResponse < Aws::EmptyStructure; end
|
225
|
+
|
182
226
|
# @note When making an API call, you may pass CreateAliasRequest
|
183
227
|
# data as a hash:
|
184
228
|
#
|
@@ -206,6 +250,7 @@ module Aws::WorkMail
|
|
206
250
|
:organization_id,
|
207
251
|
:entity_id,
|
208
252
|
:alias)
|
253
|
+
SENSITIVE = []
|
209
254
|
include Aws::Structure
|
210
255
|
end
|
211
256
|
|
@@ -234,6 +279,7 @@ module Aws::WorkMail
|
|
234
279
|
class CreateGroupRequest < Struct.new(
|
235
280
|
:organization_id,
|
236
281
|
:name)
|
282
|
+
SENSITIVE = []
|
237
283
|
include Aws::Structure
|
238
284
|
end
|
239
285
|
|
@@ -245,6 +291,7 @@ module Aws::WorkMail
|
|
245
291
|
#
|
246
292
|
class CreateGroupResponse < Struct.new(
|
247
293
|
:group_id)
|
294
|
+
SENSITIVE = []
|
248
295
|
include Aws::Structure
|
249
296
|
end
|
250
297
|
|
@@ -277,6 +324,7 @@ module Aws::WorkMail
|
|
277
324
|
:organization_id,
|
278
325
|
:name,
|
279
326
|
:type)
|
327
|
+
SENSITIVE = []
|
280
328
|
include Aws::Structure
|
281
329
|
end
|
282
330
|
|
@@ -288,6 +336,7 @@ module Aws::WorkMail
|
|
288
336
|
#
|
289
337
|
class CreateResourceResponse < Struct.new(
|
290
338
|
:resource_id)
|
339
|
+
SENSITIVE = []
|
291
340
|
include Aws::Structure
|
292
341
|
end
|
293
342
|
|
@@ -325,6 +374,7 @@ module Aws::WorkMail
|
|
325
374
|
:name,
|
326
375
|
:display_name,
|
327
376
|
:password)
|
377
|
+
SENSITIVE = [:password]
|
328
378
|
include Aws::Structure
|
329
379
|
end
|
330
380
|
|
@@ -336,6 +386,7 @@ module Aws::WorkMail
|
|
336
386
|
#
|
337
387
|
class CreateUserResponse < Struct.new(
|
338
388
|
:user_id)
|
389
|
+
SENSITIVE = []
|
339
390
|
include Aws::Structure
|
340
391
|
end
|
341
392
|
|
@@ -356,6 +407,7 @@ module Aws::WorkMail
|
|
356
407
|
class Delegate < Struct.new(
|
357
408
|
:id,
|
358
409
|
:type)
|
410
|
+
SENSITIVE = []
|
359
411
|
include Aws::Structure
|
360
412
|
end
|
361
413
|
|
@@ -380,6 +432,7 @@ module Aws::WorkMail
|
|
380
432
|
class DeleteAccessControlRuleRequest < Struct.new(
|
381
433
|
:organization_id,
|
382
434
|
:name)
|
435
|
+
SENSITIVE = []
|
383
436
|
include Aws::Structure
|
384
437
|
end
|
385
438
|
|
@@ -417,6 +470,7 @@ module Aws::WorkMail
|
|
417
470
|
:organization_id,
|
418
471
|
:entity_id,
|
419
472
|
:alias)
|
473
|
+
SENSITIVE = []
|
420
474
|
include Aws::Structure
|
421
475
|
end
|
422
476
|
|
@@ -445,6 +499,7 @@ module Aws::WorkMail
|
|
445
499
|
class DeleteGroupRequest < Struct.new(
|
446
500
|
:organization_id,
|
447
501
|
:group_id)
|
502
|
+
SENSITIVE = []
|
448
503
|
include Aws::Structure
|
449
504
|
end
|
450
505
|
|
@@ -481,6 +536,7 @@ module Aws::WorkMail
|
|
481
536
|
:organization_id,
|
482
537
|
:entity_id,
|
483
538
|
:grantee_id)
|
539
|
+
SENSITIVE = []
|
484
540
|
include Aws::Structure
|
485
541
|
end
|
486
542
|
|
@@ -510,6 +566,7 @@ module Aws::WorkMail
|
|
510
566
|
class DeleteResourceRequest < Struct.new(
|
511
567
|
:organization_id,
|
512
568
|
:resource_id)
|
569
|
+
SENSITIVE = []
|
513
570
|
include Aws::Structure
|
514
571
|
end
|
515
572
|
|
@@ -538,6 +595,7 @@ module Aws::WorkMail
|
|
538
595
|
class DeleteRetentionPolicyRequest < Struct.new(
|
539
596
|
:organization_id,
|
540
597
|
:id)
|
598
|
+
SENSITIVE = []
|
541
599
|
include Aws::Structure
|
542
600
|
end
|
543
601
|
|
@@ -566,6 +624,7 @@ module Aws::WorkMail
|
|
566
624
|
class DeleteUserRequest < Struct.new(
|
567
625
|
:organization_id,
|
568
626
|
:user_id)
|
627
|
+
SENSITIVE = []
|
569
628
|
include Aws::Structure
|
570
629
|
end
|
571
630
|
|
@@ -595,6 +654,7 @@ module Aws::WorkMail
|
|
595
654
|
class DeregisterFromWorkMailRequest < Struct.new(
|
596
655
|
:organization_id,
|
597
656
|
:entity_id)
|
657
|
+
SENSITIVE = []
|
598
658
|
include Aws::Structure
|
599
659
|
end
|
600
660
|
|
@@ -623,6 +683,7 @@ module Aws::WorkMail
|
|
623
683
|
class DescribeGroupRequest < Struct.new(
|
624
684
|
:organization_id,
|
625
685
|
:group_id)
|
686
|
+
SENSITIVE = []
|
626
687
|
include Aws::Structure
|
627
688
|
end
|
628
689
|
|
@@ -662,6 +723,104 @@ module Aws::WorkMail
|
|
662
723
|
:state,
|
663
724
|
:enabled_date,
|
664
725
|
:disabled_date)
|
726
|
+
SENSITIVE = []
|
727
|
+
include Aws::Structure
|
728
|
+
end
|
729
|
+
|
730
|
+
# @note When making an API call, you may pass DescribeMailboxExportJobRequest
|
731
|
+
# data as a hash:
|
732
|
+
#
|
733
|
+
# {
|
734
|
+
# job_id: "MailboxExportJobId", # required
|
735
|
+
# organization_id: "OrganizationId", # required
|
736
|
+
# }
|
737
|
+
#
|
738
|
+
# @!attribute [rw] job_id
|
739
|
+
# The mailbox export job ID.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] organization_id
|
743
|
+
# The organization ID.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJobRequest AWS API Documentation
|
747
|
+
#
|
748
|
+
class DescribeMailboxExportJobRequest < Struct.new(
|
749
|
+
:job_id,
|
750
|
+
:organization_id)
|
751
|
+
SENSITIVE = []
|
752
|
+
include Aws::Structure
|
753
|
+
end
|
754
|
+
|
755
|
+
# @!attribute [rw] entity_id
|
756
|
+
# The identifier of the user or resource associated with the mailbox.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] description
|
760
|
+
# The mailbox export job description.
|
761
|
+
# @return [String]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] role_arn
|
764
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
765
|
+
# grants write permission to the Amazon Simple Storage Service (Amazon
|
766
|
+
# S3) bucket.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] kms_key_arn
|
770
|
+
# The Amazon Resource Name (ARN) of the symmetric AWS Key Management
|
771
|
+
# Service (AWS KMS) key that encrypts the exported mailbox content.
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] s3_bucket_name
|
775
|
+
# The name of the S3 bucket.
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @!attribute [rw] s3_prefix
|
779
|
+
# The S3 bucket prefix.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] s3_path
|
783
|
+
# The path to the S3 bucket and file that the mailbox export job is
|
784
|
+
# exporting to.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @!attribute [rw] estimated_progress
|
788
|
+
# The estimated progress of the mailbox export job, in percentage
|
789
|
+
# points.
|
790
|
+
# @return [Integer]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] state
|
793
|
+
# The state of the mailbox export job.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] error_info
|
797
|
+
# Error information for failed mailbox export jobs.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] start_time
|
801
|
+
# The mailbox export job start timestamp.
|
802
|
+
# @return [Time]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] end_time
|
805
|
+
# The mailbox export job end timestamp.
|
806
|
+
# @return [Time]
|
807
|
+
#
|
808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJobResponse AWS API Documentation
|
809
|
+
#
|
810
|
+
class DescribeMailboxExportJobResponse < Struct.new(
|
811
|
+
:entity_id,
|
812
|
+
:description,
|
813
|
+
:role_arn,
|
814
|
+
:kms_key_arn,
|
815
|
+
:s3_bucket_name,
|
816
|
+
:s3_prefix,
|
817
|
+
:s3_path,
|
818
|
+
:estimated_progress,
|
819
|
+
:state,
|
820
|
+
:error_info,
|
821
|
+
:start_time,
|
822
|
+
:end_time)
|
823
|
+
SENSITIVE = []
|
665
824
|
include Aws::Structure
|
666
825
|
end
|
667
826
|
|
@@ -680,6 +839,7 @@ module Aws::WorkMail
|
|
680
839
|
#
|
681
840
|
class DescribeOrganizationRequest < Struct.new(
|
682
841
|
:organization_id)
|
842
|
+
SENSITIVE = []
|
683
843
|
include Aws::Structure
|
684
844
|
end
|
685
845
|
|
@@ -734,6 +894,7 @@ module Aws::WorkMail
|
|
734
894
|
:completed_date,
|
735
895
|
:error_message,
|
736
896
|
:arn)
|
897
|
+
SENSITIVE = []
|
737
898
|
include Aws::Structure
|
738
899
|
end
|
739
900
|
|
@@ -759,6 +920,7 @@ module Aws::WorkMail
|
|
759
920
|
class DescribeResourceRequest < Struct.new(
|
760
921
|
:organization_id,
|
761
922
|
:resource_id)
|
923
|
+
SENSITIVE = []
|
762
924
|
include Aws::Structure
|
763
925
|
end
|
764
926
|
|
@@ -808,6 +970,7 @@ module Aws::WorkMail
|
|
808
970
|
:state,
|
809
971
|
:enabled_date,
|
810
972
|
:disabled_date)
|
973
|
+
SENSITIVE = []
|
811
974
|
include Aws::Structure
|
812
975
|
end
|
813
976
|
|
@@ -832,6 +995,7 @@ module Aws::WorkMail
|
|
832
995
|
class DescribeUserRequest < Struct.new(
|
833
996
|
:organization_id,
|
834
997
|
:user_id)
|
998
|
+
SENSITIVE = []
|
835
999
|
include Aws::Structure
|
836
1000
|
end
|
837
1001
|
|
@@ -887,6 +1051,7 @@ module Aws::WorkMail
|
|
887
1051
|
:user_role,
|
888
1052
|
:enabled_date,
|
889
1053
|
:disabled_date)
|
1054
|
+
SENSITIVE = []
|
890
1055
|
include Aws::Structure
|
891
1056
|
end
|
892
1057
|
|
@@ -900,6 +1065,7 @@ module Aws::WorkMail
|
|
900
1065
|
#
|
901
1066
|
class DirectoryServiceAuthenticationFailedException < Struct.new(
|
902
1067
|
:message)
|
1068
|
+
SENSITIVE = []
|
903
1069
|
include Aws::Structure
|
904
1070
|
end
|
905
1071
|
|
@@ -913,6 +1079,7 @@ module Aws::WorkMail
|
|
913
1079
|
#
|
914
1080
|
class DirectoryUnavailableException < Struct.new(
|
915
1081
|
:message)
|
1082
|
+
SENSITIVE = []
|
916
1083
|
include Aws::Structure
|
917
1084
|
end
|
918
1085
|
|
@@ -945,6 +1112,7 @@ module Aws::WorkMail
|
|
945
1112
|
:organization_id,
|
946
1113
|
:resource_id,
|
947
1114
|
:entity_id)
|
1115
|
+
SENSITIVE = []
|
948
1116
|
include Aws::Structure
|
949
1117
|
end
|
950
1118
|
|
@@ -979,6 +1147,7 @@ module Aws::WorkMail
|
|
979
1147
|
:organization_id,
|
980
1148
|
:group_id,
|
981
1149
|
:member_id)
|
1150
|
+
SENSITIVE = []
|
982
1151
|
include Aws::Structure
|
983
1152
|
end
|
984
1153
|
|
@@ -996,6 +1165,7 @@ module Aws::WorkMail
|
|
996
1165
|
#
|
997
1166
|
class EmailAddressInUseException < Struct.new(
|
998
1167
|
:message)
|
1168
|
+
SENSITIVE = []
|
999
1169
|
include Aws::Structure
|
1000
1170
|
end
|
1001
1171
|
|
@@ -1009,6 +1179,7 @@ module Aws::WorkMail
|
|
1009
1179
|
#
|
1010
1180
|
class EntityAlreadyRegisteredException < Struct.new(
|
1011
1181
|
:message)
|
1182
|
+
SENSITIVE = []
|
1012
1183
|
include Aws::Structure
|
1013
1184
|
end
|
1014
1185
|
|
@@ -1022,6 +1193,7 @@ module Aws::WorkMail
|
|
1022
1193
|
#
|
1023
1194
|
class EntityNotFoundException < Struct.new(
|
1024
1195
|
:message)
|
1196
|
+
SENSITIVE = []
|
1025
1197
|
include Aws::Structure
|
1026
1198
|
end
|
1027
1199
|
|
@@ -1035,6 +1207,7 @@ module Aws::WorkMail
|
|
1035
1207
|
#
|
1036
1208
|
class EntityStateException < Struct.new(
|
1037
1209
|
:message)
|
1210
|
+
SENSITIVE = []
|
1038
1211
|
include Aws::Structure
|
1039
1212
|
end
|
1040
1213
|
|
@@ -1070,6 +1243,7 @@ module Aws::WorkMail
|
|
1070
1243
|
:name,
|
1071
1244
|
:action,
|
1072
1245
|
:period)
|
1246
|
+
SENSITIVE = []
|
1073
1247
|
include Aws::Structure
|
1074
1248
|
end
|
1075
1249
|
|
@@ -1108,6 +1282,7 @@ module Aws::WorkMail
|
|
1108
1282
|
:ip_address,
|
1109
1283
|
:action,
|
1110
1284
|
:user_id)
|
1285
|
+
SENSITIVE = []
|
1111
1286
|
include Aws::Structure
|
1112
1287
|
end
|
1113
1288
|
|
@@ -1124,6 +1299,7 @@ module Aws::WorkMail
|
|
1124
1299
|
class GetAccessControlEffectResponse < Struct.new(
|
1125
1300
|
:effect,
|
1126
1301
|
:matched_rules)
|
1302
|
+
SENSITIVE = []
|
1127
1303
|
include Aws::Structure
|
1128
1304
|
end
|
1129
1305
|
|
@@ -1142,6 +1318,7 @@ module Aws::WorkMail
|
|
1142
1318
|
#
|
1143
1319
|
class GetDefaultRetentionPolicyRequest < Struct.new(
|
1144
1320
|
:organization_id)
|
1321
|
+
SENSITIVE = []
|
1145
1322
|
include Aws::Structure
|
1146
1323
|
end
|
1147
1324
|
|
@@ -1168,6 +1345,7 @@ module Aws::WorkMail
|
|
1168
1345
|
:name,
|
1169
1346
|
:description,
|
1170
1347
|
:folder_configurations)
|
1348
|
+
SENSITIVE = []
|
1171
1349
|
include Aws::Structure
|
1172
1350
|
end
|
1173
1351
|
|
@@ -1194,6 +1372,7 @@ module Aws::WorkMail
|
|
1194
1372
|
class GetMailboxDetailsRequest < Struct.new(
|
1195
1373
|
:organization_id,
|
1196
1374
|
:user_id)
|
1375
|
+
SENSITIVE = []
|
1197
1376
|
include Aws::Structure
|
1198
1377
|
end
|
1199
1378
|
|
@@ -1210,6 +1389,7 @@ module Aws::WorkMail
|
|
1210
1389
|
class GetMailboxDetailsResponse < Struct.new(
|
1211
1390
|
:mailbox_quota,
|
1212
1391
|
:mailbox_size)
|
1392
|
+
SENSITIVE = []
|
1213
1393
|
include Aws::Structure
|
1214
1394
|
end
|
1215
1395
|
|
@@ -1250,6 +1430,7 @@ module Aws::WorkMail
|
|
1250
1430
|
:state,
|
1251
1431
|
:enabled_date,
|
1252
1432
|
:disabled_date)
|
1433
|
+
SENSITIVE = []
|
1253
1434
|
include Aws::Structure
|
1254
1435
|
end
|
1255
1436
|
|
@@ -1264,6 +1445,7 @@ module Aws::WorkMail
|
|
1264
1445
|
#
|
1265
1446
|
class InvalidConfigurationException < Struct.new(
|
1266
1447
|
:message)
|
1448
|
+
SENSITIVE = []
|
1267
1449
|
include Aws::Structure
|
1268
1450
|
end
|
1269
1451
|
|
@@ -1277,6 +1459,7 @@ module Aws::WorkMail
|
|
1277
1459
|
#
|
1278
1460
|
class InvalidParameterException < Struct.new(
|
1279
1461
|
:message)
|
1462
|
+
SENSITIVE = []
|
1280
1463
|
include Aws::Structure
|
1281
1464
|
end
|
1282
1465
|
|
@@ -1290,6 +1473,7 @@ module Aws::WorkMail
|
|
1290
1473
|
#
|
1291
1474
|
class InvalidPasswordException < Struct.new(
|
1292
1475
|
:message)
|
1476
|
+
SENSITIVE = []
|
1293
1477
|
include Aws::Structure
|
1294
1478
|
end
|
1295
1479
|
|
@@ -1302,6 +1486,7 @@ module Aws::WorkMail
|
|
1302
1486
|
#
|
1303
1487
|
class LimitExceededException < Struct.new(
|
1304
1488
|
:message)
|
1489
|
+
SENSITIVE = []
|
1305
1490
|
include Aws::Structure
|
1306
1491
|
end
|
1307
1492
|
|
@@ -1320,6 +1505,7 @@ module Aws::WorkMail
|
|
1320
1505
|
#
|
1321
1506
|
class ListAccessControlRulesRequest < Struct.new(
|
1322
1507
|
:organization_id)
|
1508
|
+
SENSITIVE = []
|
1323
1509
|
include Aws::Structure
|
1324
1510
|
end
|
1325
1511
|
|
@@ -1331,6 +1517,7 @@ module Aws::WorkMail
|
|
1331
1517
|
#
|
1332
1518
|
class ListAccessControlRulesResponse < Struct.new(
|
1333
1519
|
:rules)
|
1520
|
+
SENSITIVE = []
|
1334
1521
|
include Aws::Structure
|
1335
1522
|
end
|
1336
1523
|
|
@@ -1368,6 +1555,7 @@ module Aws::WorkMail
|
|
1368
1555
|
:entity_id,
|
1369
1556
|
:next_token,
|
1370
1557
|
:max_results)
|
1558
|
+
SENSITIVE = []
|
1371
1559
|
include Aws::Structure
|
1372
1560
|
end
|
1373
1561
|
|
@@ -1385,6 +1573,7 @@ module Aws::WorkMail
|
|
1385
1573
|
class ListAliasesResponse < Struct.new(
|
1386
1574
|
:aliases,
|
1387
1575
|
:next_token)
|
1576
|
+
SENSITIVE = []
|
1388
1577
|
include Aws::Structure
|
1389
1578
|
end
|
1390
1579
|
|
@@ -1423,6 +1612,7 @@ module Aws::WorkMail
|
|
1423
1612
|
:group_id,
|
1424
1613
|
:next_token,
|
1425
1614
|
:max_results)
|
1615
|
+
SENSITIVE = []
|
1426
1616
|
include Aws::Structure
|
1427
1617
|
end
|
1428
1618
|
|
@@ -1440,6 +1630,7 @@ module Aws::WorkMail
|
|
1440
1630
|
class ListGroupMembersResponse < Struct.new(
|
1441
1631
|
:members,
|
1442
1632
|
:next_token)
|
1633
|
+
SENSITIVE = []
|
1443
1634
|
include Aws::Structure
|
1444
1635
|
end
|
1445
1636
|
|
@@ -1471,6 +1662,7 @@ module Aws::WorkMail
|
|
1471
1662
|
:organization_id,
|
1472
1663
|
:next_token,
|
1473
1664
|
:max_results)
|
1665
|
+
SENSITIVE = []
|
1474
1666
|
include Aws::Structure
|
1475
1667
|
end
|
1476
1668
|
|
@@ -1488,6 +1680,55 @@ module Aws::WorkMail
|
|
1488
1680
|
class ListGroupsResponse < Struct.new(
|
1489
1681
|
:groups,
|
1490
1682
|
:next_token)
|
1683
|
+
SENSITIVE = []
|
1684
|
+
include Aws::Structure
|
1685
|
+
end
|
1686
|
+
|
1687
|
+
# @note When making an API call, you may pass ListMailboxExportJobsRequest
|
1688
|
+
# data as a hash:
|
1689
|
+
#
|
1690
|
+
# {
|
1691
|
+
# organization_id: "OrganizationId", # required
|
1692
|
+
# next_token: "NextToken",
|
1693
|
+
# max_results: 1,
|
1694
|
+
# }
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] organization_id
|
1697
|
+
# The organization ID.
|
1698
|
+
# @return [String]
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] next_token
|
1701
|
+
# The token to use to retrieve the next page of results.
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] max_results
|
1705
|
+
# The maximum number of results to return in a single call.
|
1706
|
+
# @return [Integer]
|
1707
|
+
#
|
1708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobsRequest AWS API Documentation
|
1709
|
+
#
|
1710
|
+
class ListMailboxExportJobsRequest < Struct.new(
|
1711
|
+
:organization_id,
|
1712
|
+
:next_token,
|
1713
|
+
:max_results)
|
1714
|
+
SENSITIVE = []
|
1715
|
+
include Aws::Structure
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# @!attribute [rw] jobs
|
1719
|
+
# The mailbox export job details.
|
1720
|
+
# @return [Array<Types::MailboxExportJob>]
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] next_token
|
1723
|
+
# The token to use to retrieve the next page of results.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobsResponse AWS API Documentation
|
1727
|
+
#
|
1728
|
+
class ListMailboxExportJobsResponse < Struct.new(
|
1729
|
+
:jobs,
|
1730
|
+
:next_token)
|
1731
|
+
SENSITIVE = []
|
1491
1732
|
include Aws::Structure
|
1492
1733
|
end
|
1493
1734
|
|
@@ -1527,6 +1768,7 @@ module Aws::WorkMail
|
|
1527
1768
|
:entity_id,
|
1528
1769
|
:next_token,
|
1529
1770
|
:max_results)
|
1771
|
+
SENSITIVE = []
|
1530
1772
|
include Aws::Structure
|
1531
1773
|
end
|
1532
1774
|
|
@@ -1544,6 +1786,7 @@ module Aws::WorkMail
|
|
1544
1786
|
class ListMailboxPermissionsResponse < Struct.new(
|
1545
1787
|
:permissions,
|
1546
1788
|
:next_token)
|
1789
|
+
SENSITIVE = []
|
1547
1790
|
include Aws::Structure
|
1548
1791
|
end
|
1549
1792
|
|
@@ -1569,6 +1812,7 @@ module Aws::WorkMail
|
|
1569
1812
|
class ListOrganizationsRequest < Struct.new(
|
1570
1813
|
:next_token,
|
1571
1814
|
:max_results)
|
1815
|
+
SENSITIVE = []
|
1572
1816
|
include Aws::Structure
|
1573
1817
|
end
|
1574
1818
|
|
@@ -1587,6 +1831,7 @@ module Aws::WorkMail
|
|
1587
1831
|
class ListOrganizationsResponse < Struct.new(
|
1588
1832
|
:organization_summaries,
|
1589
1833
|
:next_token)
|
1834
|
+
SENSITIVE = []
|
1590
1835
|
include Aws::Structure
|
1591
1836
|
end
|
1592
1837
|
|
@@ -1625,6 +1870,7 @@ module Aws::WorkMail
|
|
1625
1870
|
:resource_id,
|
1626
1871
|
:next_token,
|
1627
1872
|
:max_results)
|
1873
|
+
SENSITIVE = []
|
1628
1874
|
include Aws::Structure
|
1629
1875
|
end
|
1630
1876
|
|
@@ -1643,6 +1889,7 @@ module Aws::WorkMail
|
|
1643
1889
|
class ListResourceDelegatesResponse < Struct.new(
|
1644
1890
|
:delegates,
|
1645
1891
|
:next_token)
|
1892
|
+
SENSITIVE = []
|
1646
1893
|
include Aws::Structure
|
1647
1894
|
end
|
1648
1895
|
|
@@ -1674,6 +1921,7 @@ module Aws::WorkMail
|
|
1674
1921
|
:organization_id,
|
1675
1922
|
:next_token,
|
1676
1923
|
:max_results)
|
1924
|
+
SENSITIVE = []
|
1677
1925
|
include Aws::Structure
|
1678
1926
|
end
|
1679
1927
|
|
@@ -1692,6 +1940,7 @@ module Aws::WorkMail
|
|
1692
1940
|
class ListResourcesResponse < Struct.new(
|
1693
1941
|
:resources,
|
1694
1942
|
:next_token)
|
1943
|
+
SENSITIVE = []
|
1695
1944
|
include Aws::Structure
|
1696
1945
|
end
|
1697
1946
|
|
@@ -1710,6 +1959,7 @@ module Aws::WorkMail
|
|
1710
1959
|
#
|
1711
1960
|
class ListTagsForResourceRequest < Struct.new(
|
1712
1961
|
:resource_arn)
|
1962
|
+
SENSITIVE = []
|
1713
1963
|
include Aws::Structure
|
1714
1964
|
end
|
1715
1965
|
|
@@ -1721,6 +1971,7 @@ module Aws::WorkMail
|
|
1721
1971
|
#
|
1722
1972
|
class ListTagsForResourceResponse < Struct.new(
|
1723
1973
|
:tags)
|
1974
|
+
SENSITIVE = []
|
1724
1975
|
include Aws::Structure
|
1725
1976
|
end
|
1726
1977
|
|
@@ -1752,6 +2003,7 @@ module Aws::WorkMail
|
|
1752
2003
|
:organization_id,
|
1753
2004
|
:next_token,
|
1754
2005
|
:max_results)
|
2006
|
+
SENSITIVE = []
|
1755
2007
|
include Aws::Structure
|
1756
2008
|
end
|
1757
2009
|
|
@@ -1769,6 +2021,7 @@ module Aws::WorkMail
|
|
1769
2021
|
class ListUsersResponse < Struct.new(
|
1770
2022
|
:users,
|
1771
2023
|
:next_token)
|
2024
|
+
SENSITIVE = []
|
1772
2025
|
include Aws::Structure
|
1773
2026
|
end
|
1774
2027
|
|
@@ -1782,6 +2035,7 @@ module Aws::WorkMail
|
|
1782
2035
|
#
|
1783
2036
|
class MailDomainNotFoundException < Struct.new(
|
1784
2037
|
:message)
|
2038
|
+
SENSITIVE = []
|
1785
2039
|
include Aws::Structure
|
1786
2040
|
end
|
1787
2041
|
|
@@ -1795,6 +2049,65 @@ module Aws::WorkMail
|
|
1795
2049
|
#
|
1796
2050
|
class MailDomainStateException < Struct.new(
|
1797
2051
|
:message)
|
2052
|
+
SENSITIVE = []
|
2053
|
+
include Aws::Structure
|
2054
|
+
end
|
2055
|
+
|
2056
|
+
# The details of a mailbox export job, including the user or resource ID
|
2057
|
+
# associated with the mailbox and the S3 bucket that the mailbox
|
2058
|
+
# contents are exported to.
|
2059
|
+
#
|
2060
|
+
# @!attribute [rw] job_id
|
2061
|
+
# The identifier of the mailbox export job.
|
2062
|
+
# @return [String]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] entity_id
|
2065
|
+
# The identifier of the user or resource associated with the mailbox.
|
2066
|
+
# @return [String]
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] description
|
2069
|
+
# The mailbox export job description.
|
2070
|
+
# @return [String]
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] s3_bucket_name
|
2073
|
+
# The name of the S3 bucket.
|
2074
|
+
# @return [String]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] s3_path
|
2077
|
+
# The path to the S3 bucket and file that the mailbox export job
|
2078
|
+
# exports to.
|
2079
|
+
# @return [String]
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] estimated_progress
|
2082
|
+
# The estimated progress of the mailbox export job, in percentage
|
2083
|
+
# points.
|
2084
|
+
# @return [Integer]
|
2085
|
+
#
|
2086
|
+
# @!attribute [rw] state
|
2087
|
+
# The state of the mailbox export job.
|
2088
|
+
# @return [String]
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] start_time
|
2091
|
+
# The mailbox export job start timestamp.
|
2092
|
+
# @return [Time]
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] end_time
|
2095
|
+
# The mailbox export job end timestamp.
|
2096
|
+
# @return [Time]
|
2097
|
+
#
|
2098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/MailboxExportJob AWS API Documentation
|
2099
|
+
#
|
2100
|
+
class MailboxExportJob < Struct.new(
|
2101
|
+
:job_id,
|
2102
|
+
:entity_id,
|
2103
|
+
:description,
|
2104
|
+
:s3_bucket_name,
|
2105
|
+
:s3_path,
|
2106
|
+
:estimated_progress,
|
2107
|
+
:state,
|
2108
|
+
:start_time,
|
2109
|
+
:end_time)
|
2110
|
+
SENSITIVE = []
|
1798
2111
|
include Aws::Structure
|
1799
2112
|
end
|
1800
2113
|
|
@@ -1835,6 +2148,7 @@ module Aws::WorkMail
|
|
1835
2148
|
:state,
|
1836
2149
|
:enabled_date,
|
1837
2150
|
:disabled_date)
|
2151
|
+
SENSITIVE = []
|
1838
2152
|
include Aws::Structure
|
1839
2153
|
end
|
1840
2154
|
|
@@ -1847,6 +2161,7 @@ module Aws::WorkMail
|
|
1847
2161
|
#
|
1848
2162
|
class NameAvailabilityException < Struct.new(
|
1849
2163
|
:message)
|
2164
|
+
SENSITIVE = []
|
1850
2165
|
include Aws::Structure
|
1851
2166
|
end
|
1852
2167
|
|
@@ -1860,6 +2175,7 @@ module Aws::WorkMail
|
|
1860
2175
|
#
|
1861
2176
|
class OrganizationNotFoundException < Struct.new(
|
1862
2177
|
:message)
|
2178
|
+
SENSITIVE = []
|
1863
2179
|
include Aws::Structure
|
1864
2180
|
end
|
1865
2181
|
|
@@ -1873,6 +2189,7 @@ module Aws::WorkMail
|
|
1873
2189
|
#
|
1874
2190
|
class OrganizationStateException < Struct.new(
|
1875
2191
|
:message)
|
2192
|
+
SENSITIVE = []
|
1876
2193
|
include Aws::Structure
|
1877
2194
|
end
|
1878
2195
|
|
@@ -1904,6 +2221,7 @@ module Aws::WorkMail
|
|
1904
2221
|
:alias,
|
1905
2222
|
:error_message,
|
1906
2223
|
:state)
|
2224
|
+
SENSITIVE = []
|
1907
2225
|
include Aws::Structure
|
1908
2226
|
end
|
1909
2227
|
|
@@ -1935,6 +2253,7 @@ module Aws::WorkMail
|
|
1935
2253
|
:grantee_id,
|
1936
2254
|
:grantee_type,
|
1937
2255
|
:permission_values)
|
2256
|
+
SENSITIVE = []
|
1938
2257
|
include Aws::Structure
|
1939
2258
|
end
|
1940
2259
|
|
@@ -2011,6 +2330,7 @@ module Aws::WorkMail
|
|
2011
2330
|
:user_ids,
|
2012
2331
|
:not_user_ids,
|
2013
2332
|
:organization_id)
|
2333
|
+
SENSITIVE = []
|
2014
2334
|
include Aws::Structure
|
2015
2335
|
end
|
2016
2336
|
|
@@ -2060,6 +2380,7 @@ module Aws::WorkMail
|
|
2060
2380
|
:entity_id,
|
2061
2381
|
:grantee_id,
|
2062
2382
|
:permission_values)
|
2383
|
+
SENSITIVE = []
|
2063
2384
|
include Aws::Structure
|
2064
2385
|
end
|
2065
2386
|
|
@@ -2112,6 +2433,7 @@ module Aws::WorkMail
|
|
2112
2433
|
:name,
|
2113
2434
|
:description,
|
2114
2435
|
:folder_configurations)
|
2436
|
+
SENSITIVE = [:description]
|
2115
2437
|
include Aws::Structure
|
2116
2438
|
end
|
2117
2439
|
|
@@ -2147,6 +2469,7 @@ module Aws::WorkMail
|
|
2147
2469
|
:organization_id,
|
2148
2470
|
:entity_id,
|
2149
2471
|
:email)
|
2472
|
+
SENSITIVE = []
|
2150
2473
|
include Aws::Structure
|
2151
2474
|
end
|
2152
2475
|
|
@@ -2163,6 +2486,7 @@ module Aws::WorkMail
|
|
2163
2486
|
#
|
2164
2487
|
class ReservedNameException < Struct.new(
|
2165
2488
|
:message)
|
2489
|
+
SENSITIVE = []
|
2166
2490
|
include Aws::Structure
|
2167
2491
|
end
|
2168
2492
|
|
@@ -2194,6 +2518,7 @@ module Aws::WorkMail
|
|
2194
2518
|
:organization_id,
|
2195
2519
|
:user_id,
|
2196
2520
|
:password)
|
2521
|
+
SENSITIVE = [:password]
|
2197
2522
|
include Aws::Structure
|
2198
2523
|
end
|
2199
2524
|
|
@@ -2244,6 +2569,7 @@ module Aws::WorkMail
|
|
2244
2569
|
:state,
|
2245
2570
|
:enabled_date,
|
2246
2571
|
:disabled_date)
|
2572
|
+
SENSITIVE = []
|
2247
2573
|
include Aws::Structure
|
2248
2574
|
end
|
2249
2575
|
|
@@ -2256,6 +2582,85 @@ module Aws::WorkMail
|
|
2256
2582
|
#
|
2257
2583
|
class ResourceNotFoundException < Struct.new(
|
2258
2584
|
:message)
|
2585
|
+
SENSITIVE = []
|
2586
|
+
include Aws::Structure
|
2587
|
+
end
|
2588
|
+
|
2589
|
+
# @note When making an API call, you may pass StartMailboxExportJobRequest
|
2590
|
+
# data as a hash:
|
2591
|
+
#
|
2592
|
+
# {
|
2593
|
+
# client_token: "IdempotencyClientToken", # required
|
2594
|
+
# organization_id: "OrganizationId", # required
|
2595
|
+
# entity_id: "WorkMailIdentifier", # required
|
2596
|
+
# description: "Description",
|
2597
|
+
# role_arn: "RoleArn", # required
|
2598
|
+
# kms_key_arn: "KmsKeyArn", # required
|
2599
|
+
# s3_bucket_name: "S3BucketName", # required
|
2600
|
+
# s3_prefix: "S3ObjectKey", # required
|
2601
|
+
# }
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] client_token
|
2604
|
+
# The idempotency token for the client request.
|
2605
|
+
#
|
2606
|
+
# **A suitable default value is auto-generated.** You should normally
|
2607
|
+
# not need to pass this option.
|
2608
|
+
# @return [String]
|
2609
|
+
#
|
2610
|
+
# @!attribute [rw] organization_id
|
2611
|
+
# The identifier associated with the organization.
|
2612
|
+
# @return [String]
|
2613
|
+
#
|
2614
|
+
# @!attribute [rw] entity_id
|
2615
|
+
# The identifier of the user or resource associated with the mailbox.
|
2616
|
+
# @return [String]
|
2617
|
+
#
|
2618
|
+
# @!attribute [rw] description
|
2619
|
+
# The mailbox export job description.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2622
|
+
# @!attribute [rw] role_arn
|
2623
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
2624
|
+
# grants write permission to the S3 bucket.
|
2625
|
+
# @return [String]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] kms_key_arn
|
2628
|
+
# The Amazon Resource Name (ARN) of the symmetric AWS Key Management
|
2629
|
+
# Service (AWS KMS) key that encrypts the exported mailbox content.
|
2630
|
+
# @return [String]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] s3_bucket_name
|
2633
|
+
# The name of the S3 bucket.
|
2634
|
+
# @return [String]
|
2635
|
+
#
|
2636
|
+
# @!attribute [rw] s3_prefix
|
2637
|
+
# The S3 bucket prefix.
|
2638
|
+
# @return [String]
|
2639
|
+
#
|
2640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJobRequest AWS API Documentation
|
2641
|
+
#
|
2642
|
+
class StartMailboxExportJobRequest < Struct.new(
|
2643
|
+
:client_token,
|
2644
|
+
:organization_id,
|
2645
|
+
:entity_id,
|
2646
|
+
:description,
|
2647
|
+
:role_arn,
|
2648
|
+
:kms_key_arn,
|
2649
|
+
:s3_bucket_name,
|
2650
|
+
:s3_prefix)
|
2651
|
+
SENSITIVE = []
|
2652
|
+
include Aws::Structure
|
2653
|
+
end
|
2654
|
+
|
2655
|
+
# @!attribute [rw] job_id
|
2656
|
+
# The job ID.
|
2657
|
+
# @return [String]
|
2658
|
+
#
|
2659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJobResponse AWS API Documentation
|
2660
|
+
#
|
2661
|
+
class StartMailboxExportJobResponse < Struct.new(
|
2662
|
+
:job_id)
|
2663
|
+
SENSITIVE = []
|
2259
2664
|
include Aws::Structure
|
2260
2665
|
end
|
2261
2666
|
|
@@ -2282,6 +2687,7 @@ module Aws::WorkMail
|
|
2282
2687
|
class Tag < Struct.new(
|
2283
2688
|
:key,
|
2284
2689
|
:value)
|
2690
|
+
SENSITIVE = []
|
2285
2691
|
include Aws::Structure
|
2286
2692
|
end
|
2287
2693
|
|
@@ -2311,6 +2717,7 @@ module Aws::WorkMail
|
|
2311
2717
|
class TagResourceRequest < Struct.new(
|
2312
2718
|
:resource_arn,
|
2313
2719
|
:tags)
|
2720
|
+
SENSITIVE = []
|
2314
2721
|
include Aws::Structure
|
2315
2722
|
end
|
2316
2723
|
|
@@ -2327,6 +2734,7 @@ module Aws::WorkMail
|
|
2327
2734
|
#
|
2328
2735
|
class TooManyTagsException < Struct.new(
|
2329
2736
|
:message)
|
2737
|
+
SENSITIVE = []
|
2330
2738
|
include Aws::Structure
|
2331
2739
|
end
|
2332
2740
|
|
@@ -2339,6 +2747,7 @@ module Aws::WorkMail
|
|
2339
2747
|
#
|
2340
2748
|
class UnsupportedOperationException < Struct.new(
|
2341
2749
|
:message)
|
2750
|
+
SENSITIVE = []
|
2342
2751
|
include Aws::Structure
|
2343
2752
|
end
|
2344
2753
|
|
@@ -2363,6 +2772,7 @@ module Aws::WorkMail
|
|
2363
2772
|
class UntagResourceRequest < Struct.new(
|
2364
2773
|
:resource_arn,
|
2365
2774
|
:tag_keys)
|
2775
|
+
SENSITIVE = []
|
2366
2776
|
include Aws::Structure
|
2367
2777
|
end
|
2368
2778
|
|
@@ -2398,6 +2808,7 @@ module Aws::WorkMail
|
|
2398
2808
|
:organization_id,
|
2399
2809
|
:user_id,
|
2400
2810
|
:mailbox_quota)
|
2811
|
+
SENSITIVE = []
|
2401
2812
|
include Aws::Structure
|
2402
2813
|
end
|
2403
2814
|
|
@@ -2433,6 +2844,7 @@ module Aws::WorkMail
|
|
2433
2844
|
:organization_id,
|
2434
2845
|
:entity_id,
|
2435
2846
|
:email)
|
2847
|
+
SENSITIVE = []
|
2436
2848
|
include Aws::Structure
|
2437
2849
|
end
|
2438
2850
|
|
@@ -2478,6 +2890,7 @@ module Aws::WorkMail
|
|
2478
2890
|
:resource_id,
|
2479
2891
|
:name,
|
2480
2892
|
:booking_options)
|
2893
|
+
SENSITIVE = []
|
2481
2894
|
include Aws::Structure
|
2482
2895
|
end
|
2483
2896
|
|
@@ -2532,6 +2945,7 @@ module Aws::WorkMail
|
|
2532
2945
|
:user_role,
|
2533
2946
|
:enabled_date,
|
2534
2947
|
:disabled_date)
|
2948
|
+
SENSITIVE = []
|
2535
2949
|
include Aws::Structure
|
2536
2950
|
end
|
2537
2951
|
|