aws-sdk-workmail 1.51.0 → 1.53.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/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-workmail/client.rb +20 -3
- data/lib/aws-sdk-workmail/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-workmail/endpoint_provider.rb +51 -0
- data/lib/aws-sdk-workmail/endpoints.rb +1135 -0
- data/lib/aws-sdk-workmail/plugins/endpoints.rb +228 -0
- data/lib/aws-sdk-workmail/types.rb +0 -862
- data/lib/aws-sdk-workmail.rb +5 -1
- metadata +8 -4
@@ -88,15 +88,6 @@ module Aws::WorkMail
|
|
88
88
|
include Aws::Structure
|
89
89
|
end
|
90
90
|
|
91
|
-
# @note When making an API call, you may pass AssociateDelegateToResourceRequest
|
92
|
-
# data as a hash:
|
93
|
-
#
|
94
|
-
# {
|
95
|
-
# organization_id: "OrganizationId", # required
|
96
|
-
# resource_id: "ResourceId", # required
|
97
|
-
# entity_id: "WorkMailIdentifier", # required
|
98
|
-
# }
|
99
|
-
#
|
100
91
|
# @!attribute [rw] organization_id
|
101
92
|
# The organization under which the resource exists.
|
102
93
|
# @return [String]
|
@@ -123,15 +114,6 @@ module Aws::WorkMail
|
|
123
114
|
#
|
124
115
|
class AssociateDelegateToResourceResponse < Aws::EmptyStructure; end
|
125
116
|
|
126
|
-
# @note When making an API call, you may pass AssociateMemberToGroupRequest
|
127
|
-
# data as a hash:
|
128
|
-
#
|
129
|
-
# {
|
130
|
-
# organization_id: "OrganizationId", # required
|
131
|
-
# group_id: "WorkMailIdentifier", # required
|
132
|
-
# member_id: "WorkMailIdentifier", # required
|
133
|
-
# }
|
134
|
-
#
|
135
117
|
# @!attribute [rw] organization_id
|
136
118
|
# The organization under which the group exists.
|
137
119
|
# @return [String]
|
@@ -158,14 +140,6 @@ module Aws::WorkMail
|
|
158
140
|
#
|
159
141
|
class AssociateMemberToGroupResponse < Aws::EmptyStructure; end
|
160
142
|
|
161
|
-
# @note When making an API call, you may pass AssumeImpersonationRoleRequest
|
162
|
-
# data as a hash:
|
163
|
-
#
|
164
|
-
# {
|
165
|
-
# organization_id: "OrganizationId", # required
|
166
|
-
# impersonation_role_id: "ImpersonationRoleId", # required
|
167
|
-
# }
|
168
|
-
#
|
169
143
|
# @!attribute [rw] organization_id
|
170
144
|
# The WorkMail organization under which the impersonation role will be
|
171
145
|
# assumed.
|
@@ -248,15 +222,6 @@ module Aws::WorkMail
|
|
248
222
|
# At least one delegate must be associated to the resource to disable
|
249
223
|
# automatic replies from the resource.
|
250
224
|
#
|
251
|
-
# @note When making an API call, you may pass BookingOptions
|
252
|
-
# data as a hash:
|
253
|
-
#
|
254
|
-
# {
|
255
|
-
# auto_accept_requests: false,
|
256
|
-
# auto_decline_recurring_requests: false,
|
257
|
-
# auto_decline_conflicting_requests: false,
|
258
|
-
# }
|
259
|
-
#
|
260
225
|
# @!attribute [rw] auto_accept_requests
|
261
226
|
# The resource's ability to automatically reply to requests. If
|
262
227
|
# disabled, delegates must be associated to the resource.
|
@@ -282,15 +247,6 @@ module Aws::WorkMail
|
|
282
247
|
include Aws::Structure
|
283
248
|
end
|
284
249
|
|
285
|
-
# @note When making an API call, you may pass CancelMailboxExportJobRequest
|
286
|
-
# data as a hash:
|
287
|
-
#
|
288
|
-
# {
|
289
|
-
# client_token: "IdempotencyClientToken", # required
|
290
|
-
# job_id: "MailboxExportJobId", # required
|
291
|
-
# organization_id: "OrganizationId", # required
|
292
|
-
# }
|
293
|
-
#
|
294
250
|
# @!attribute [rw] client_token
|
295
251
|
# The idempotency token for the client request.
|
296
252
|
#
|
@@ -320,15 +276,6 @@ module Aws::WorkMail
|
|
320
276
|
#
|
321
277
|
class CancelMailboxExportJobResponse < Aws::EmptyStructure; end
|
322
278
|
|
323
|
-
# @note When making an API call, you may pass CreateAliasRequest
|
324
|
-
# data as a hash:
|
325
|
-
#
|
326
|
-
# {
|
327
|
-
# organization_id: "OrganizationId", # required
|
328
|
-
# entity_id: "WorkMailIdentifier", # required
|
329
|
-
# alias: "EmailAddress", # required
|
330
|
-
# }
|
331
|
-
#
|
332
279
|
# @!attribute [rw] organization_id
|
333
280
|
# The organization under which the member (user or group) exists.
|
334
281
|
# @return [String]
|
@@ -355,23 +302,6 @@ module Aws::WorkMail
|
|
355
302
|
#
|
356
303
|
class CreateAliasResponse < Aws::EmptyStructure; end
|
357
304
|
|
358
|
-
# @note When making an API call, you may pass CreateAvailabilityConfigurationRequest
|
359
|
-
# data as a hash:
|
360
|
-
#
|
361
|
-
# {
|
362
|
-
# client_token: "IdempotencyClientToken",
|
363
|
-
# organization_id: "OrganizationId", # required
|
364
|
-
# domain_name: "DomainName", # required
|
365
|
-
# ews_provider: {
|
366
|
-
# ews_endpoint: "Url", # required
|
367
|
-
# ews_username: "ExternalUserName", # required
|
368
|
-
# ews_password: "Password", # required
|
369
|
-
# },
|
370
|
-
# lambda_provider: {
|
371
|
-
# lambda_arn: "LambdaArn", # required
|
372
|
-
# },
|
373
|
-
# }
|
374
|
-
#
|
375
305
|
# @!attribute [rw] client_token
|
376
306
|
# An idempotent token that ensures that an API request is executed
|
377
307
|
# only once.
|
@@ -417,14 +347,6 @@ module Aws::WorkMail
|
|
417
347
|
#
|
418
348
|
class CreateAvailabilityConfigurationResponse < Aws::EmptyStructure; end
|
419
349
|
|
420
|
-
# @note When making an API call, you may pass CreateGroupRequest
|
421
|
-
# data as a hash:
|
422
|
-
#
|
423
|
-
# {
|
424
|
-
# organization_id: "OrganizationId", # required
|
425
|
-
# name: "GroupName", # required
|
426
|
-
# }
|
427
|
-
#
|
428
350
|
# @!attribute [rw] organization_id
|
429
351
|
# The organization under which the group is to be created.
|
430
352
|
# @return [String]
|
@@ -454,27 +376,6 @@ module Aws::WorkMail
|
|
454
376
|
include Aws::Structure
|
455
377
|
end
|
456
378
|
|
457
|
-
# @note When making an API call, you may pass CreateImpersonationRoleRequest
|
458
|
-
# data as a hash:
|
459
|
-
#
|
460
|
-
# {
|
461
|
-
# client_token: "IdempotencyClientToken",
|
462
|
-
# organization_id: "OrganizationId", # required
|
463
|
-
# name: "ImpersonationRoleName", # required
|
464
|
-
# type: "FULL_ACCESS", # required, accepts FULL_ACCESS, READ_ONLY
|
465
|
-
# description: "ImpersonationRoleDescription",
|
466
|
-
# rules: [ # required
|
467
|
-
# {
|
468
|
-
# impersonation_rule_id: "ImpersonationRuleId", # required
|
469
|
-
# name: "ImpersonationRuleName",
|
470
|
-
# description: "ImpersonationRuleDescription",
|
471
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
472
|
-
# target_users: ["EntityIdentifier"],
|
473
|
-
# not_target_users: ["EntityIdentifier"],
|
474
|
-
# },
|
475
|
-
# ],
|
476
|
-
# }
|
477
|
-
#
|
478
379
|
# @!attribute [rw] client_token
|
479
380
|
# The idempotency token for the client request.
|
480
381
|
#
|
@@ -529,25 +430,6 @@ module Aws::WorkMail
|
|
529
430
|
include Aws::Structure
|
530
431
|
end
|
531
432
|
|
532
|
-
# @note When making an API call, you may pass CreateMobileDeviceAccessRuleRequest
|
533
|
-
# data as a hash:
|
534
|
-
#
|
535
|
-
# {
|
536
|
-
# organization_id: "OrganizationId", # required
|
537
|
-
# client_token: "IdempotencyClientToken",
|
538
|
-
# name: "MobileDeviceAccessRuleName", # required
|
539
|
-
# description: "MobileDeviceAccessRuleDescription",
|
540
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
541
|
-
# device_types: ["DeviceType"],
|
542
|
-
# not_device_types: ["DeviceType"],
|
543
|
-
# device_models: ["DeviceModel"],
|
544
|
-
# not_device_models: ["DeviceModel"],
|
545
|
-
# device_operating_systems: ["DeviceOperatingSystem"],
|
546
|
-
# not_device_operating_systems: ["DeviceOperatingSystem"],
|
547
|
-
# device_user_agents: ["DeviceUserAgent"],
|
548
|
-
# not_device_user_agents: ["DeviceUserAgent"],
|
549
|
-
# }
|
550
|
-
#
|
551
433
|
# @!attribute [rw] organization_id
|
552
434
|
# The WorkMail organization under which the rule will be created.
|
553
435
|
# @return [String]
|
@@ -640,23 +522,6 @@ module Aws::WorkMail
|
|
640
522
|
include Aws::Structure
|
641
523
|
end
|
642
524
|
|
643
|
-
# @note When making an API call, you may pass CreateOrganizationRequest
|
644
|
-
# data as a hash:
|
645
|
-
#
|
646
|
-
# {
|
647
|
-
# directory_id: "DirectoryId",
|
648
|
-
# alias: "OrganizationName", # required
|
649
|
-
# client_token: "IdempotencyClientToken",
|
650
|
-
# domains: [
|
651
|
-
# {
|
652
|
-
# domain_name: "DomainName",
|
653
|
-
# hosted_zone_id: "HostedZoneId",
|
654
|
-
# },
|
655
|
-
# ],
|
656
|
-
# kms_key_arn: "KmsKeyArn",
|
657
|
-
# enable_interoperability: false,
|
658
|
-
# }
|
659
|
-
#
|
660
525
|
# @!attribute [rw] directory_id
|
661
526
|
# The AWS Directory Service directory ID.
|
662
527
|
# @return [String]
|
@@ -712,15 +577,6 @@ module Aws::WorkMail
|
|
712
577
|
include Aws::Structure
|
713
578
|
end
|
714
579
|
|
715
|
-
# @note When making an API call, you may pass CreateResourceRequest
|
716
|
-
# data as a hash:
|
717
|
-
#
|
718
|
-
# {
|
719
|
-
# organization_id: "OrganizationId", # required
|
720
|
-
# name: "ResourceName", # required
|
721
|
-
# type: "ROOM", # required, accepts ROOM, EQUIPMENT
|
722
|
-
# }
|
723
|
-
#
|
724
580
|
# @!attribute [rw] organization_id
|
725
581
|
# The identifier associated with the organization for which the
|
726
582
|
# resource is created.
|
@@ -757,16 +613,6 @@ module Aws::WorkMail
|
|
757
613
|
include Aws::Structure
|
758
614
|
end
|
759
615
|
|
760
|
-
# @note When making an API call, you may pass CreateUserRequest
|
761
|
-
# data as a hash:
|
762
|
-
#
|
763
|
-
# {
|
764
|
-
# organization_id: "OrganizationId", # required
|
765
|
-
# name: "UserName", # required
|
766
|
-
# display_name: "String", # required
|
767
|
-
# password: "Password", # required
|
768
|
-
# }
|
769
|
-
#
|
770
616
|
# @!attribute [rw] organization_id
|
771
617
|
# The identifier of the organization for which the user is created.
|
772
618
|
# @return [String]
|
@@ -828,14 +674,6 @@ module Aws::WorkMail
|
|
828
674
|
include Aws::Structure
|
829
675
|
end
|
830
676
|
|
831
|
-
# @note When making an API call, you may pass DeleteAccessControlRuleRequest
|
832
|
-
# data as a hash:
|
833
|
-
#
|
834
|
-
# {
|
835
|
-
# organization_id: "OrganizationId", # required
|
836
|
-
# name: "AccessControlRuleName", # required
|
837
|
-
# }
|
838
|
-
#
|
839
677
|
# @!attribute [rw] organization_id
|
840
678
|
# The identifier for the organization.
|
841
679
|
# @return [String]
|
@@ -857,15 +695,6 @@ module Aws::WorkMail
|
|
857
695
|
#
|
858
696
|
class DeleteAccessControlRuleResponse < Aws::EmptyStructure; end
|
859
697
|
|
860
|
-
# @note When making an API call, you may pass DeleteAliasRequest
|
861
|
-
# data as a hash:
|
862
|
-
#
|
863
|
-
# {
|
864
|
-
# organization_id: "OrganizationId", # required
|
865
|
-
# entity_id: "WorkMailIdentifier", # required
|
866
|
-
# alias: "EmailAddress", # required
|
867
|
-
# }
|
868
|
-
#
|
869
698
|
# @!attribute [rw] organization_id
|
870
699
|
# The identifier for the organization under which the user exists.
|
871
700
|
# @return [String]
|
@@ -895,14 +724,6 @@ module Aws::WorkMail
|
|
895
724
|
#
|
896
725
|
class DeleteAliasResponse < Aws::EmptyStructure; end
|
897
726
|
|
898
|
-
# @note When making an API call, you may pass DeleteAvailabilityConfigurationRequest
|
899
|
-
# data as a hash:
|
900
|
-
#
|
901
|
-
# {
|
902
|
-
# organization_id: "OrganizationId", # required
|
903
|
-
# domain_name: "DomainName", # required
|
904
|
-
# }
|
905
|
-
#
|
906
727
|
# @!attribute [rw] organization_id
|
907
728
|
# The WorkMail organization for which the `AvailabilityConfiguration`
|
908
729
|
# will be deleted.
|
@@ -926,13 +747,6 @@ module Aws::WorkMail
|
|
926
747
|
#
|
927
748
|
class DeleteAvailabilityConfigurationResponse < Aws::EmptyStructure; end
|
928
749
|
|
929
|
-
# @note When making an API call, you may pass DeleteEmailMonitoringConfigurationRequest
|
930
|
-
# data as a hash:
|
931
|
-
#
|
932
|
-
# {
|
933
|
-
# organization_id: "OrganizationId", # required
|
934
|
-
# }
|
935
|
-
#
|
936
750
|
# @!attribute [rw] organization_id
|
937
751
|
# The ID of the organization from which the email monitoring
|
938
752
|
# configuration is deleted.
|
@@ -950,14 +764,6 @@ module Aws::WorkMail
|
|
950
764
|
#
|
951
765
|
class DeleteEmailMonitoringConfigurationResponse < Aws::EmptyStructure; end
|
952
766
|
|
953
|
-
# @note When making an API call, you may pass DeleteGroupRequest
|
954
|
-
# data as a hash:
|
955
|
-
#
|
956
|
-
# {
|
957
|
-
# organization_id: "OrganizationId", # required
|
958
|
-
# group_id: "WorkMailIdentifier", # required
|
959
|
-
# }
|
960
|
-
#
|
961
767
|
# @!attribute [rw] organization_id
|
962
768
|
# The organization that contains the group.
|
963
769
|
# @return [String]
|
@@ -979,14 +785,6 @@ module Aws::WorkMail
|
|
979
785
|
#
|
980
786
|
class DeleteGroupResponse < Aws::EmptyStructure; end
|
981
787
|
|
982
|
-
# @note When making an API call, you may pass DeleteImpersonationRoleRequest
|
983
|
-
# data as a hash:
|
984
|
-
#
|
985
|
-
# {
|
986
|
-
# organization_id: "OrganizationId", # required
|
987
|
-
# impersonation_role_id: "ImpersonationRoleId", # required
|
988
|
-
# }
|
989
|
-
#
|
990
788
|
# @!attribute [rw] organization_id
|
991
789
|
# The WorkMail organization from which to delete the impersonation
|
992
790
|
# role.
|
@@ -1009,15 +807,6 @@ module Aws::WorkMail
|
|
1009
807
|
#
|
1010
808
|
class DeleteImpersonationRoleResponse < Aws::EmptyStructure; end
|
1011
809
|
|
1012
|
-
# @note When making an API call, you may pass DeleteMailboxPermissionsRequest
|
1013
|
-
# data as a hash:
|
1014
|
-
#
|
1015
|
-
# {
|
1016
|
-
# organization_id: "OrganizationId", # required
|
1017
|
-
# entity_id: "WorkMailIdentifier", # required
|
1018
|
-
# grantee_id: "WorkMailIdentifier", # required
|
1019
|
-
# }
|
1020
|
-
#
|
1021
810
|
# @!attribute [rw] organization_id
|
1022
811
|
# The identifier of the organization under which the member (user or
|
1023
812
|
# group) exists.
|
@@ -1046,15 +835,6 @@ module Aws::WorkMail
|
|
1046
835
|
#
|
1047
836
|
class DeleteMailboxPermissionsResponse < Aws::EmptyStructure; end
|
1048
837
|
|
1049
|
-
# @note When making an API call, you may pass DeleteMobileDeviceAccessOverrideRequest
|
1050
|
-
# data as a hash:
|
1051
|
-
#
|
1052
|
-
# {
|
1053
|
-
# organization_id: "OrganizationId", # required
|
1054
|
-
# user_id: "EntityIdentifier", # required
|
1055
|
-
# device_id: "DeviceId", # required
|
1056
|
-
# }
|
1057
|
-
#
|
1058
838
|
# @!attribute [rw] organization_id
|
1059
839
|
# The WorkMail organization for which the access override will be
|
1060
840
|
# deleted.
|
@@ -1091,14 +871,6 @@ module Aws::WorkMail
|
|
1091
871
|
#
|
1092
872
|
class DeleteMobileDeviceAccessOverrideResponse < Aws::EmptyStructure; end
|
1093
873
|
|
1094
|
-
# @note When making an API call, you may pass DeleteMobileDeviceAccessRuleRequest
|
1095
|
-
# data as a hash:
|
1096
|
-
#
|
1097
|
-
# {
|
1098
|
-
# organization_id: "OrganizationId", # required
|
1099
|
-
# mobile_device_access_rule_id: "MobileDeviceAccessRuleId", # required
|
1100
|
-
# }
|
1101
|
-
#
|
1102
874
|
# @!attribute [rw] organization_id
|
1103
875
|
# The WorkMail organization under which the rule will be deleted.
|
1104
876
|
# @return [String]
|
@@ -1120,15 +892,6 @@ module Aws::WorkMail
|
|
1120
892
|
#
|
1121
893
|
class DeleteMobileDeviceAccessRuleResponse < Aws::EmptyStructure; end
|
1122
894
|
|
1123
|
-
# @note When making an API call, you may pass DeleteOrganizationRequest
|
1124
|
-
# data as a hash:
|
1125
|
-
#
|
1126
|
-
# {
|
1127
|
-
# client_token: "IdempotencyClientToken",
|
1128
|
-
# organization_id: "OrganizationId", # required
|
1129
|
-
# delete_directory: false, # required
|
1130
|
-
# }
|
1131
|
-
#
|
1132
895
|
# @!attribute [rw] client_token
|
1133
896
|
# The idempotency token associated with the request.
|
1134
897
|
#
|
@@ -1172,14 +935,6 @@ module Aws::WorkMail
|
|
1172
935
|
include Aws::Structure
|
1173
936
|
end
|
1174
937
|
|
1175
|
-
# @note When making an API call, you may pass DeleteResourceRequest
|
1176
|
-
# data as a hash:
|
1177
|
-
#
|
1178
|
-
# {
|
1179
|
-
# organization_id: "OrganizationId", # required
|
1180
|
-
# resource_id: "ResourceId", # required
|
1181
|
-
# }
|
1182
|
-
#
|
1183
938
|
# @!attribute [rw] organization_id
|
1184
939
|
# The identifier associated with the organization from which the
|
1185
940
|
# resource is deleted.
|
@@ -1202,14 +957,6 @@ module Aws::WorkMail
|
|
1202
957
|
#
|
1203
958
|
class DeleteResourceResponse < Aws::EmptyStructure; end
|
1204
959
|
|
1205
|
-
# @note When making an API call, you may pass DeleteRetentionPolicyRequest
|
1206
|
-
# data as a hash:
|
1207
|
-
#
|
1208
|
-
# {
|
1209
|
-
# organization_id: "OrganizationId", # required
|
1210
|
-
# id: "ShortString", # required
|
1211
|
-
# }
|
1212
|
-
#
|
1213
960
|
# @!attribute [rw] organization_id
|
1214
961
|
# The organization ID.
|
1215
962
|
# @return [String]
|
@@ -1231,14 +978,6 @@ module Aws::WorkMail
|
|
1231
978
|
#
|
1232
979
|
class DeleteRetentionPolicyResponse < Aws::EmptyStructure; end
|
1233
980
|
|
1234
|
-
# @note When making an API call, you may pass DeleteUserRequest
|
1235
|
-
# data as a hash:
|
1236
|
-
#
|
1237
|
-
# {
|
1238
|
-
# organization_id: "OrganizationId", # required
|
1239
|
-
# user_id: "WorkMailIdentifier", # required
|
1240
|
-
# }
|
1241
|
-
#
|
1242
981
|
# @!attribute [rw] organization_id
|
1243
982
|
# The organization that contains the user to be deleted.
|
1244
983
|
# @return [String]
|
@@ -1260,14 +999,6 @@ module Aws::WorkMail
|
|
1260
999
|
#
|
1261
1000
|
class DeleteUserResponse < Aws::EmptyStructure; end
|
1262
1001
|
|
1263
|
-
# @note When making an API call, you may pass DeregisterFromWorkMailRequest
|
1264
|
-
# data as a hash:
|
1265
|
-
#
|
1266
|
-
# {
|
1267
|
-
# organization_id: "OrganizationId", # required
|
1268
|
-
# entity_id: "WorkMailIdentifier", # required
|
1269
|
-
# }
|
1270
|
-
#
|
1271
1002
|
# @!attribute [rw] organization_id
|
1272
1003
|
# The identifier for the organization under which the WorkMail entity
|
1273
1004
|
# exists.
|
@@ -1290,14 +1021,6 @@ module Aws::WorkMail
|
|
1290
1021
|
#
|
1291
1022
|
class DeregisterFromWorkMailResponse < Aws::EmptyStructure; end
|
1292
1023
|
|
1293
|
-
# @note When making an API call, you may pass DeregisterMailDomainRequest
|
1294
|
-
# data as a hash:
|
1295
|
-
#
|
1296
|
-
# {
|
1297
|
-
# organization_id: "OrganizationId", # required
|
1298
|
-
# domain_name: "WorkMailDomainName", # required
|
1299
|
-
# }
|
1300
|
-
#
|
1301
1024
|
# @!attribute [rw] organization_id
|
1302
1025
|
# The WorkMail organization for which the domain will be deregistered.
|
1303
1026
|
# @return [String]
|
@@ -1319,13 +1042,6 @@ module Aws::WorkMail
|
|
1319
1042
|
#
|
1320
1043
|
class DeregisterMailDomainResponse < Aws::EmptyStructure; end
|
1321
1044
|
|
1322
|
-
# @note When making an API call, you may pass DescribeEmailMonitoringConfigurationRequest
|
1323
|
-
# data as a hash:
|
1324
|
-
#
|
1325
|
-
# {
|
1326
|
-
# organization_id: "OrganizationId", # required
|
1327
|
-
# }
|
1328
|
-
#
|
1329
1045
|
# @!attribute [rw] organization_id
|
1330
1046
|
# The ID of the organization for which the email monitoring
|
1331
1047
|
# configuration is described.
|
@@ -1358,14 +1074,6 @@ module Aws::WorkMail
|
|
1358
1074
|
include Aws::Structure
|
1359
1075
|
end
|
1360
1076
|
|
1361
|
-
# @note When making an API call, you may pass DescribeGroupRequest
|
1362
|
-
# data as a hash:
|
1363
|
-
#
|
1364
|
-
# {
|
1365
|
-
# organization_id: "OrganizationId", # required
|
1366
|
-
# group_id: "WorkMailIdentifier", # required
|
1367
|
-
# }
|
1368
|
-
#
|
1369
1077
|
# @!attribute [rw] organization_id
|
1370
1078
|
# The identifier for the organization under which the group exists.
|
1371
1079
|
# @return [String]
|
@@ -1423,13 +1131,6 @@ module Aws::WorkMail
|
|
1423
1131
|
include Aws::Structure
|
1424
1132
|
end
|
1425
1133
|
|
1426
|
-
# @note When making an API call, you may pass DescribeInboundDmarcSettingsRequest
|
1427
|
-
# data as a hash:
|
1428
|
-
#
|
1429
|
-
# {
|
1430
|
-
# organization_id: "OrganizationId", # required
|
1431
|
-
# }
|
1432
|
-
#
|
1433
1134
|
# @!attribute [rw] organization_id
|
1434
1135
|
# Lists the ID of the given organization.
|
1435
1136
|
# @return [String]
|
@@ -1454,14 +1155,6 @@ module Aws::WorkMail
|
|
1454
1155
|
include Aws::Structure
|
1455
1156
|
end
|
1456
1157
|
|
1457
|
-
# @note When making an API call, you may pass DescribeMailboxExportJobRequest
|
1458
|
-
# data as a hash:
|
1459
|
-
#
|
1460
|
-
# {
|
1461
|
-
# job_id: "MailboxExportJobId", # required
|
1462
|
-
# organization_id: "OrganizationId", # required
|
1463
|
-
# }
|
1464
|
-
#
|
1465
1158
|
# @!attribute [rw] job_id
|
1466
1159
|
# The mailbox export job ID.
|
1467
1160
|
# @return [String]
|
@@ -1551,13 +1244,6 @@ module Aws::WorkMail
|
|
1551
1244
|
include Aws::Structure
|
1552
1245
|
end
|
1553
1246
|
|
1554
|
-
# @note When making an API call, you may pass DescribeOrganizationRequest
|
1555
|
-
# data as a hash:
|
1556
|
-
#
|
1557
|
-
# {
|
1558
|
-
# organization_id: "OrganizationId", # required
|
1559
|
-
# }
|
1560
|
-
#
|
1561
1247
|
# @!attribute [rw] organization_id
|
1562
1248
|
# The identifier for the organization to be described.
|
1563
1249
|
# @return [String]
|
@@ -1625,14 +1311,6 @@ module Aws::WorkMail
|
|
1625
1311
|
include Aws::Structure
|
1626
1312
|
end
|
1627
1313
|
|
1628
|
-
# @note When making an API call, you may pass DescribeResourceRequest
|
1629
|
-
# data as a hash:
|
1630
|
-
#
|
1631
|
-
# {
|
1632
|
-
# organization_id: "OrganizationId", # required
|
1633
|
-
# resource_id: "ResourceId", # required
|
1634
|
-
# }
|
1635
|
-
#
|
1636
1314
|
# @!attribute [rw] organization_id
|
1637
1315
|
# The identifier associated with the organization for which the
|
1638
1316
|
# resource is described.
|
@@ -1701,14 +1379,6 @@ module Aws::WorkMail
|
|
1701
1379
|
include Aws::Structure
|
1702
1380
|
end
|
1703
1381
|
|
1704
|
-
# @note When making an API call, you may pass DescribeUserRequest
|
1705
|
-
# data as a hash:
|
1706
|
-
#
|
1707
|
-
# {
|
1708
|
-
# organization_id: "OrganizationId", # required
|
1709
|
-
# user_id: "WorkMailIdentifier", # required
|
1710
|
-
# }
|
1711
|
-
#
|
1712
1382
|
# @!attribute [rw] organization_id
|
1713
1383
|
# The identifier for the organization under which the user exists.
|
1714
1384
|
# @return [String]
|
@@ -1824,15 +1494,6 @@ module Aws::WorkMail
|
|
1824
1494
|
include Aws::Structure
|
1825
1495
|
end
|
1826
1496
|
|
1827
|
-
# @note When making an API call, you may pass DisassociateDelegateFromResourceRequest
|
1828
|
-
# data as a hash:
|
1829
|
-
#
|
1830
|
-
# {
|
1831
|
-
# organization_id: "OrganizationId", # required
|
1832
|
-
# resource_id: "ResourceId", # required
|
1833
|
-
# entity_id: "WorkMailIdentifier", # required
|
1834
|
-
# }
|
1835
|
-
#
|
1836
1497
|
# @!attribute [rw] organization_id
|
1837
1498
|
# The identifier for the organization under which the resource exists.
|
1838
1499
|
# @return [String]
|
@@ -1861,15 +1522,6 @@ module Aws::WorkMail
|
|
1861
1522
|
#
|
1862
1523
|
class DisassociateDelegateFromResourceResponse < Aws::EmptyStructure; end
|
1863
1524
|
|
1864
|
-
# @note When making an API call, you may pass DisassociateMemberFromGroupRequest
|
1865
|
-
# data as a hash:
|
1866
|
-
#
|
1867
|
-
# {
|
1868
|
-
# organization_id: "OrganizationId", # required
|
1869
|
-
# group_id: "WorkMailIdentifier", # required
|
1870
|
-
# member_id: "WorkMailIdentifier", # required
|
1871
|
-
# }
|
1872
|
-
#
|
1873
1525
|
# @!attribute [rw] organization_id
|
1874
1526
|
# The identifier for the organization under which the group exists.
|
1875
1527
|
# @return [String]
|
@@ -1932,14 +1584,6 @@ module Aws::WorkMail
|
|
1932
1584
|
#
|
1933
1585
|
# [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html
|
1934
1586
|
#
|
1935
|
-
# @note When making an API call, you may pass Domain
|
1936
|
-
# data as a hash:
|
1937
|
-
#
|
1938
|
-
# {
|
1939
|
-
# domain_name: "DomainName",
|
1940
|
-
# hosted_zone_id: "HostedZoneId",
|
1941
|
-
# }
|
1942
|
-
#
|
1943
1587
|
# @!attribute [rw] domain_name
|
1944
1588
|
# The fully qualified domain name.
|
1945
1589
|
# @return [String]
|
@@ -2017,15 +1661,6 @@ module Aws::WorkMail
|
|
2017
1661
|
# Describes an EWS based availability provider. This is only used as
|
2018
1662
|
# input to the service.
|
2019
1663
|
#
|
2020
|
-
# @note When making an API call, you may pass EwsAvailabilityProvider
|
2021
|
-
# data as a hash:
|
2022
|
-
#
|
2023
|
-
# {
|
2024
|
-
# ews_endpoint: "Url", # required
|
2025
|
-
# ews_username: "ExternalUserName", # required
|
2026
|
-
# ews_password: "Password", # required
|
2027
|
-
# }
|
2028
|
-
#
|
2029
1664
|
# @!attribute [rw] ews_endpoint
|
2030
1665
|
# The endpoint of the remote EWS server.
|
2031
1666
|
# @return [String]
|
@@ -2051,15 +1686,6 @@ module Aws::WorkMail
|
|
2051
1686
|
# The configuration applied to an organization's folders by its
|
2052
1687
|
# retention policy.
|
2053
1688
|
#
|
2054
|
-
# @note When making an API call, you may pass FolderConfiguration
|
2055
|
-
# data as a hash:
|
2056
|
-
#
|
2057
|
-
# {
|
2058
|
-
# name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
|
2059
|
-
# action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
|
2060
|
-
# period: 1,
|
2061
|
-
# }
|
2062
|
-
#
|
2063
1689
|
# @!attribute [rw] name
|
2064
1690
|
# The folder name.
|
2065
1691
|
# @return [String]
|
@@ -2084,17 +1710,6 @@ module Aws::WorkMail
|
|
2084
1710
|
include Aws::Structure
|
2085
1711
|
end
|
2086
1712
|
|
2087
|
-
# @note When making an API call, you may pass GetAccessControlEffectRequest
|
2088
|
-
# data as a hash:
|
2089
|
-
#
|
2090
|
-
# {
|
2091
|
-
# organization_id: "OrganizationId", # required
|
2092
|
-
# ip_address: "IpAddress", # required
|
2093
|
-
# action: "AccessControlRuleAction", # required
|
2094
|
-
# user_id: "WorkMailIdentifier",
|
2095
|
-
# impersonation_role_id: "ImpersonationRoleId",
|
2096
|
-
# }
|
2097
|
-
#
|
2098
1713
|
# @!attribute [rw] organization_id
|
2099
1714
|
# The identifier for the organization.
|
2100
1715
|
# @return [String]
|
@@ -2146,13 +1761,6 @@ module Aws::WorkMail
|
|
2146
1761
|
include Aws::Structure
|
2147
1762
|
end
|
2148
1763
|
|
2149
|
-
# @note When making an API call, you may pass GetDefaultRetentionPolicyRequest
|
2150
|
-
# data as a hash:
|
2151
|
-
#
|
2152
|
-
# {
|
2153
|
-
# organization_id: "OrganizationId", # required
|
2154
|
-
# }
|
2155
|
-
#
|
2156
1764
|
# @!attribute [rw] organization_id
|
2157
1765
|
# The organization ID.
|
2158
1766
|
# @return [String]
|
@@ -2192,15 +1800,6 @@ module Aws::WorkMail
|
|
2192
1800
|
include Aws::Structure
|
2193
1801
|
end
|
2194
1802
|
|
2195
|
-
# @note When making an API call, you may pass GetImpersonationRoleEffectRequest
|
2196
|
-
# data as a hash:
|
2197
|
-
#
|
2198
|
-
# {
|
2199
|
-
# organization_id: "OrganizationId", # required
|
2200
|
-
# impersonation_role_id: "ImpersonationRoleId", # required
|
2201
|
-
# target_user: "EntityIdentifier", # required
|
2202
|
-
# }
|
2203
|
-
#
|
2204
1803
|
# @!attribute [rw] organization_id
|
2205
1804
|
# The WorkMail organization where the impersonation role is defined.
|
2206
1805
|
# @return [String]
|
@@ -2256,14 +1855,6 @@ module Aws::WorkMail
|
|
2256
1855
|
include Aws::Structure
|
2257
1856
|
end
|
2258
1857
|
|
2259
|
-
# @note When making an API call, you may pass GetImpersonationRoleRequest
|
2260
|
-
# data as a hash:
|
2261
|
-
#
|
2262
|
-
# {
|
2263
|
-
# organization_id: "OrganizationId", # required
|
2264
|
-
# impersonation_role_id: "ImpersonationRoleId", # required
|
2265
|
-
# }
|
2266
|
-
#
|
2267
1858
|
# @!attribute [rw] organization_id
|
2268
1859
|
# The WorkMail organization from which to retrieve the impersonation
|
2269
1860
|
# role.
|
@@ -2324,14 +1915,6 @@ module Aws::WorkMail
|
|
2324
1915
|
include Aws::Structure
|
2325
1916
|
end
|
2326
1917
|
|
2327
|
-
# @note When making an API call, you may pass GetMailDomainRequest
|
2328
|
-
# data as a hash:
|
2329
|
-
#
|
2330
|
-
# {
|
2331
|
-
# organization_id: "OrganizationId", # required
|
2332
|
-
# domain_name: "WorkMailDomainName", # required
|
2333
|
-
# }
|
2334
|
-
#
|
2335
1918
|
# @!attribute [rw] organization_id
|
2336
1919
|
# The WorkMail organization for which the domain is retrieved.
|
2337
1920
|
# @return [String]
|
@@ -2386,14 +1969,6 @@ module Aws::WorkMail
|
|
2386
1969
|
include Aws::Structure
|
2387
1970
|
end
|
2388
1971
|
|
2389
|
-
# @note When making an API call, you may pass GetMailboxDetailsRequest
|
2390
|
-
# data as a hash:
|
2391
|
-
#
|
2392
|
-
# {
|
2393
|
-
# organization_id: "OrganizationId", # required
|
2394
|
-
# user_id: "WorkMailIdentifier", # required
|
2395
|
-
# }
|
2396
|
-
#
|
2397
1972
|
# @!attribute [rw] organization_id
|
2398
1973
|
# The identifier for the organization that contains the user whose
|
2399
1974
|
# mailbox details are being requested.
|
@@ -2430,17 +2005,6 @@ module Aws::WorkMail
|
|
2430
2005
|
include Aws::Structure
|
2431
2006
|
end
|
2432
2007
|
|
2433
|
-
# @note When making an API call, you may pass GetMobileDeviceAccessEffectRequest
|
2434
|
-
# data as a hash:
|
2435
|
-
#
|
2436
|
-
# {
|
2437
|
-
# organization_id: "OrganizationId", # required
|
2438
|
-
# device_type: "DeviceType",
|
2439
|
-
# device_model: "DeviceModel",
|
2440
|
-
# device_operating_system: "DeviceOperatingSystem",
|
2441
|
-
# device_user_agent: "DeviceUserAgent",
|
2442
|
-
# }
|
2443
|
-
#
|
2444
2008
|
# @!attribute [rw] organization_id
|
2445
2009
|
# The WorkMail organization to simulate the access effect for.
|
2446
2010
|
# @return [String]
|
@@ -2493,15 +2057,6 @@ module Aws::WorkMail
|
|
2493
2057
|
include Aws::Structure
|
2494
2058
|
end
|
2495
2059
|
|
2496
|
-
# @note When making an API call, you may pass GetMobileDeviceAccessOverrideRequest
|
2497
|
-
# data as a hash:
|
2498
|
-
#
|
2499
|
-
# {
|
2500
|
-
# organization_id: "OrganizationId", # required
|
2501
|
-
# user_id: "EntityIdentifier", # required
|
2502
|
-
# device_id: "DeviceId", # required
|
2503
|
-
# }
|
2504
|
-
#
|
2505
2060
|
# @!attribute [rw] organization_id
|
2506
2061
|
# The WorkMail organization to which you want to apply the override.
|
2507
2062
|
# @return [String]
|
@@ -2664,18 +2219,6 @@ module Aws::WorkMail
|
|
2664
2219
|
|
2665
2220
|
# The rules for the given impersonation role.
|
2666
2221
|
#
|
2667
|
-
# @note When making an API call, you may pass ImpersonationRule
|
2668
|
-
# data as a hash:
|
2669
|
-
#
|
2670
|
-
# {
|
2671
|
-
# impersonation_rule_id: "ImpersonationRuleId", # required
|
2672
|
-
# name: "ImpersonationRuleName",
|
2673
|
-
# description: "ImpersonationRuleDescription",
|
2674
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
2675
|
-
# target_users: ["EntityIdentifier"],
|
2676
|
-
# not_target_users: ["EntityIdentifier"],
|
2677
|
-
# }
|
2678
|
-
#
|
2679
2222
|
# @!attribute [rw] impersonation_rule_id
|
2680
2223
|
# The identifier of the rule.
|
2681
2224
|
# @return [String]
|
@@ -2778,13 +2321,6 @@ module Aws::WorkMail
|
|
2778
2321
|
|
2779
2322
|
# Describes a Lambda based availability provider.
|
2780
2323
|
#
|
2781
|
-
# @note When making an API call, you may pass LambdaAvailabilityProvider
|
2782
|
-
# data as a hash:
|
2783
|
-
#
|
2784
|
-
# {
|
2785
|
-
# lambda_arn: "LambdaArn", # required
|
2786
|
-
# }
|
2787
|
-
#
|
2788
2324
|
# @!attribute [rw] lambda_arn
|
2789
2325
|
# The Amazon Resource Name (ARN) of the Lambda that acts as the
|
2790
2326
|
# availability provider.
|
@@ -2811,13 +2347,6 @@ module Aws::WorkMail
|
|
2811
2347
|
include Aws::Structure
|
2812
2348
|
end
|
2813
2349
|
|
2814
|
-
# @note When making an API call, you may pass ListAccessControlRulesRequest
|
2815
|
-
# data as a hash:
|
2816
|
-
#
|
2817
|
-
# {
|
2818
|
-
# organization_id: "OrganizationId", # required
|
2819
|
-
# }
|
2820
|
-
#
|
2821
2350
|
# @!attribute [rw] organization_id
|
2822
2351
|
# The identifier for the organization.
|
2823
2352
|
# @return [String]
|
@@ -2842,16 +2371,6 @@ module Aws::WorkMail
|
|
2842
2371
|
include Aws::Structure
|
2843
2372
|
end
|
2844
2373
|
|
2845
|
-
# @note When making an API call, you may pass ListAliasesRequest
|
2846
|
-
# data as a hash:
|
2847
|
-
#
|
2848
|
-
# {
|
2849
|
-
# organization_id: "OrganizationId", # required
|
2850
|
-
# entity_id: "WorkMailIdentifier", # required
|
2851
|
-
# next_token: "NextToken",
|
2852
|
-
# max_results: 1,
|
2853
|
-
# }
|
2854
|
-
#
|
2855
2374
|
# @!attribute [rw] organization_id
|
2856
2375
|
# The identifier for the organization under which the entity exists.
|
2857
2376
|
# @return [String]
|
@@ -2898,15 +2417,6 @@ module Aws::WorkMail
|
|
2898
2417
|
include Aws::Structure
|
2899
2418
|
end
|
2900
2419
|
|
2901
|
-
# @note When making an API call, you may pass ListAvailabilityConfigurationsRequest
|
2902
|
-
# data as a hash:
|
2903
|
-
#
|
2904
|
-
# {
|
2905
|
-
# organization_id: "OrganizationId", # required
|
2906
|
-
# max_results: 1,
|
2907
|
-
# next_token: "NextToken",
|
2908
|
-
# }
|
2909
|
-
#
|
2910
2420
|
# @!attribute [rw] organization_id
|
2911
2421
|
# The WorkMail organization for which the
|
2912
2422
|
# `AvailabilityConfiguration`'s will be listed.
|
@@ -2950,16 +2460,6 @@ module Aws::WorkMail
|
|
2950
2460
|
include Aws::Structure
|
2951
2461
|
end
|
2952
2462
|
|
2953
|
-
# @note When making an API call, you may pass ListGroupMembersRequest
|
2954
|
-
# data as a hash:
|
2955
|
-
#
|
2956
|
-
# {
|
2957
|
-
# organization_id: "OrganizationId", # required
|
2958
|
-
# group_id: "WorkMailIdentifier", # required
|
2959
|
-
# next_token: "NextToken",
|
2960
|
-
# max_results: 1,
|
2961
|
-
# }
|
2962
|
-
#
|
2963
2463
|
# @!attribute [rw] organization_id
|
2964
2464
|
# The identifier for the organization under which the group exists.
|
2965
2465
|
# @return [String]
|
@@ -3007,15 +2507,6 @@ module Aws::WorkMail
|
|
3007
2507
|
include Aws::Structure
|
3008
2508
|
end
|
3009
2509
|
|
3010
|
-
# @note When making an API call, you may pass ListGroupsRequest
|
3011
|
-
# data as a hash:
|
3012
|
-
#
|
3013
|
-
# {
|
3014
|
-
# organization_id: "OrganizationId", # required
|
3015
|
-
# next_token: "NextToken",
|
3016
|
-
# max_results: 1,
|
3017
|
-
# }
|
3018
|
-
#
|
3019
2510
|
# @!attribute [rw] organization_id
|
3020
2511
|
# The identifier for the organization under which the groups exist.
|
3021
2512
|
# @return [String]
|
@@ -3057,15 +2548,6 @@ module Aws::WorkMail
|
|
3057
2548
|
include Aws::Structure
|
3058
2549
|
end
|
3059
2550
|
|
3060
|
-
# @note When making an API call, you may pass ListImpersonationRolesRequest
|
3061
|
-
# data as a hash:
|
3062
|
-
#
|
3063
|
-
# {
|
3064
|
-
# organization_id: "OrganizationId", # required
|
3065
|
-
# next_token: "NextToken",
|
3066
|
-
# max_results: 1,
|
3067
|
-
# }
|
3068
|
-
#
|
3069
2551
|
# @!attribute [rw] organization_id
|
3070
2552
|
# The WorkMail organization to which the listed impersonation roles
|
3071
2553
|
# belong.
|
@@ -3109,15 +2591,6 @@ module Aws::WorkMail
|
|
3109
2591
|
include Aws::Structure
|
3110
2592
|
end
|
3111
2593
|
|
3112
|
-
# @note When making an API call, you may pass ListMailDomainsRequest
|
3113
|
-
# data as a hash:
|
3114
|
-
#
|
3115
|
-
# {
|
3116
|
-
# organization_id: "OrganizationId", # required
|
3117
|
-
# max_results: 1,
|
3118
|
-
# next_token: "NextToken",
|
3119
|
-
# }
|
3120
|
-
#
|
3121
2594
|
# @!attribute [rw] organization_id
|
3122
2595
|
# The WorkMail organization for which to list domains.
|
3123
2596
|
# @return [String]
|
@@ -3161,15 +2634,6 @@ module Aws::WorkMail
|
|
3161
2634
|
include Aws::Structure
|
3162
2635
|
end
|
3163
2636
|
|
3164
|
-
# @note When making an API call, you may pass ListMailboxExportJobsRequest
|
3165
|
-
# data as a hash:
|
3166
|
-
#
|
3167
|
-
# {
|
3168
|
-
# organization_id: "OrganizationId", # required
|
3169
|
-
# next_token: "NextToken",
|
3170
|
-
# max_results: 1,
|
3171
|
-
# }
|
3172
|
-
#
|
3173
2637
|
# @!attribute [rw] organization_id
|
3174
2638
|
# The organization ID.
|
3175
2639
|
# @return [String]
|
@@ -3209,16 +2673,6 @@ module Aws::WorkMail
|
|
3209
2673
|
include Aws::Structure
|
3210
2674
|
end
|
3211
2675
|
|
3212
|
-
# @note When making an API call, you may pass ListMailboxPermissionsRequest
|
3213
|
-
# data as a hash:
|
3214
|
-
#
|
3215
|
-
# {
|
3216
|
-
# organization_id: "OrganizationId", # required
|
3217
|
-
# entity_id: "WorkMailIdentifier", # required
|
3218
|
-
# next_token: "NextToken",
|
3219
|
-
# max_results: 1,
|
3220
|
-
# }
|
3221
|
-
#
|
3222
2676
|
# @!attribute [rw] organization_id
|
3223
2677
|
# The identifier of the organization under which the user, group, or
|
3224
2678
|
# resource exists.
|
@@ -3267,17 +2721,6 @@ module Aws::WorkMail
|
|
3267
2721
|
include Aws::Structure
|
3268
2722
|
end
|
3269
2723
|
|
3270
|
-
# @note When making an API call, you may pass ListMobileDeviceAccessOverridesRequest
|
3271
|
-
# data as a hash:
|
3272
|
-
#
|
3273
|
-
# {
|
3274
|
-
# organization_id: "OrganizationId", # required
|
3275
|
-
# user_id: "EntityIdentifier",
|
3276
|
-
# device_id: "DeviceId",
|
3277
|
-
# next_token: "NextToken",
|
3278
|
-
# max_results: 1,
|
3279
|
-
# }
|
3280
|
-
#
|
3281
2724
|
# @!attribute [rw] organization_id
|
3282
2725
|
# The WorkMail organization under which to list mobile device access
|
3283
2726
|
# overrides.
|
@@ -3339,13 +2782,6 @@ module Aws::WorkMail
|
|
3339
2782
|
include Aws::Structure
|
3340
2783
|
end
|
3341
2784
|
|
3342
|
-
# @note When making an API call, you may pass ListMobileDeviceAccessRulesRequest
|
3343
|
-
# data as a hash:
|
3344
|
-
#
|
3345
|
-
# {
|
3346
|
-
# organization_id: "OrganizationId", # required
|
3347
|
-
# }
|
3348
|
-
#
|
3349
2785
|
# @!attribute [rw] organization_id
|
3350
2786
|
# The WorkMail organization for which to list the rules.
|
3351
2787
|
# @return [String]
|
@@ -3371,14 +2807,6 @@ module Aws::WorkMail
|
|
3371
2807
|
include Aws::Structure
|
3372
2808
|
end
|
3373
2809
|
|
3374
|
-
# @note When making an API call, you may pass ListOrganizationsRequest
|
3375
|
-
# data as a hash:
|
3376
|
-
#
|
3377
|
-
# {
|
3378
|
-
# next_token: "NextToken",
|
3379
|
-
# max_results: 1,
|
3380
|
-
# }
|
3381
|
-
#
|
3382
2810
|
# @!attribute [rw] next_token
|
3383
2811
|
# The token to use to retrieve the next page of results. The first
|
3384
2812
|
# call does not contain any tokens.
|
@@ -3416,16 +2844,6 @@ module Aws::WorkMail
|
|
3416
2844
|
include Aws::Structure
|
3417
2845
|
end
|
3418
2846
|
|
3419
|
-
# @note When making an API call, you may pass ListResourceDelegatesRequest
|
3420
|
-
# data as a hash:
|
3421
|
-
#
|
3422
|
-
# {
|
3423
|
-
# organization_id: "OrganizationId", # required
|
3424
|
-
# resource_id: "WorkMailIdentifier", # required
|
3425
|
-
# next_token: "NextToken",
|
3426
|
-
# max_results: 1,
|
3427
|
-
# }
|
3428
|
-
#
|
3429
2847
|
# @!attribute [rw] organization_id
|
3430
2848
|
# The identifier for the organization that contains the resource for
|
3431
2849
|
# which delegates are listed.
|
@@ -3474,15 +2892,6 @@ module Aws::WorkMail
|
|
3474
2892
|
include Aws::Structure
|
3475
2893
|
end
|
3476
2894
|
|
3477
|
-
# @note When making an API call, you may pass ListResourcesRequest
|
3478
|
-
# data as a hash:
|
3479
|
-
#
|
3480
|
-
# {
|
3481
|
-
# organization_id: "OrganizationId", # required
|
3482
|
-
# next_token: "NextToken",
|
3483
|
-
# max_results: 1,
|
3484
|
-
# }
|
3485
|
-
#
|
3486
2895
|
# @!attribute [rw] organization_id
|
3487
2896
|
# The identifier for the organization under which the resources exist.
|
3488
2897
|
# @return [String]
|
@@ -3525,13 +2934,6 @@ module Aws::WorkMail
|
|
3525
2934
|
include Aws::Structure
|
3526
2935
|
end
|
3527
2936
|
|
3528
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
3529
|
-
# data as a hash:
|
3530
|
-
#
|
3531
|
-
# {
|
3532
|
-
# resource_arn: "AmazonResourceName", # required
|
3533
|
-
# }
|
3534
|
-
#
|
3535
2937
|
# @!attribute [rw] resource_arn
|
3536
2938
|
# The resource ARN.
|
3537
2939
|
# @return [String]
|
@@ -3556,15 +2958,6 @@ module Aws::WorkMail
|
|
3556
2958
|
include Aws::Structure
|
3557
2959
|
end
|
3558
2960
|
|
3559
|
-
# @note When making an API call, you may pass ListUsersRequest
|
3560
|
-
# data as a hash:
|
3561
|
-
#
|
3562
|
-
# {
|
3563
|
-
# organization_id: "OrganizationId", # required
|
3564
|
-
# next_token: "NextToken",
|
3565
|
-
# max_results: 1,
|
3566
|
-
# }
|
3567
|
-
#
|
3568
2961
|
# @!attribute [rw] organization_id
|
3569
2962
|
# The identifier for the organization under which the users exist.
|
3570
2963
|
# @return [String]
|
@@ -4015,24 +3408,6 @@ module Aws::WorkMail
|
|
4015
3408
|
include Aws::Structure
|
4016
3409
|
end
|
4017
3410
|
|
4018
|
-
# @note When making an API call, you may pass PutAccessControlRuleRequest
|
4019
|
-
# data as a hash:
|
4020
|
-
#
|
4021
|
-
# {
|
4022
|
-
# name: "AccessControlRuleName", # required
|
4023
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
4024
|
-
# description: "AccessControlRuleDescription", # required
|
4025
|
-
# ip_ranges: ["IpRange"],
|
4026
|
-
# not_ip_ranges: ["IpRange"],
|
4027
|
-
# actions: ["AccessControlRuleAction"],
|
4028
|
-
# not_actions: ["AccessControlRuleAction"],
|
4029
|
-
# user_ids: ["WorkMailIdentifier"],
|
4030
|
-
# not_user_ids: ["WorkMailIdentifier"],
|
4031
|
-
# organization_id: "OrganizationId", # required
|
4032
|
-
# impersonation_role_ids: ["ImpersonationRoleId"],
|
4033
|
-
# not_impersonation_role_ids: ["ImpersonationRoleId"],
|
4034
|
-
# }
|
4035
|
-
#
|
4036
3411
|
# @!attribute [rw] name
|
4037
3412
|
# The rule name.
|
4038
3413
|
# @return [String]
|
@@ -4108,15 +3483,6 @@ module Aws::WorkMail
|
|
4108
3483
|
#
|
4109
3484
|
class PutAccessControlRuleResponse < Aws::EmptyStructure; end
|
4110
3485
|
|
4111
|
-
# @note When making an API call, you may pass PutEmailMonitoringConfigurationRequest
|
4112
|
-
# data as a hash:
|
4113
|
-
#
|
4114
|
-
# {
|
4115
|
-
# organization_id: "OrganizationId", # required
|
4116
|
-
# role_arn: "RoleArn", # required
|
4117
|
-
# log_group_arn: "LogGroupArn", # required
|
4118
|
-
# }
|
4119
|
-
#
|
4120
3486
|
# @!attribute [rw] organization_id
|
4121
3487
|
# The ID of the organization for which the email monitoring
|
4122
3488
|
# configuration is set.
|
@@ -4146,14 +3512,6 @@ module Aws::WorkMail
|
|
4146
3512
|
#
|
4147
3513
|
class PutEmailMonitoringConfigurationResponse < Aws::EmptyStructure; end
|
4148
3514
|
|
4149
|
-
# @note When making an API call, you may pass PutInboundDmarcSettingsRequest
|
4150
|
-
# data as a hash:
|
4151
|
-
#
|
4152
|
-
# {
|
4153
|
-
# organization_id: "OrganizationId", # required
|
4154
|
-
# enforced: false, # required
|
4155
|
-
# }
|
4156
|
-
#
|
4157
3515
|
# @!attribute [rw] organization_id
|
4158
3516
|
# The ID of the organization that you are applying the DMARC policy
|
4159
3517
|
# to.
|
@@ -4176,16 +3534,6 @@ module Aws::WorkMail
|
|
4176
3534
|
#
|
4177
3535
|
class PutInboundDmarcSettingsResponse < Aws::EmptyStructure; end
|
4178
3536
|
|
4179
|
-
# @note When making an API call, you may pass PutMailboxPermissionsRequest
|
4180
|
-
# data as a hash:
|
4181
|
-
#
|
4182
|
-
# {
|
4183
|
-
# organization_id: "OrganizationId", # required
|
4184
|
-
# entity_id: "WorkMailIdentifier", # required
|
4185
|
-
# grantee_id: "WorkMailIdentifier", # required
|
4186
|
-
# permission_values: ["FULL_ACCESS"], # required, accepts FULL_ACCESS, SEND_AS, SEND_ON_BEHALF
|
4187
|
-
# }
|
4188
|
-
#
|
4189
3537
|
# @!attribute [rw] organization_id
|
4190
3538
|
# The identifier of the organization under which the user, group, or
|
4191
3539
|
# resource exists.
|
@@ -4226,17 +3574,6 @@ module Aws::WorkMail
|
|
4226
3574
|
#
|
4227
3575
|
class PutMailboxPermissionsResponse < Aws::EmptyStructure; end
|
4228
3576
|
|
4229
|
-
# @note When making an API call, you may pass PutMobileDeviceAccessOverrideRequest
|
4230
|
-
# data as a hash:
|
4231
|
-
#
|
4232
|
-
# {
|
4233
|
-
# organization_id: "OrganizationId", # required
|
4234
|
-
# user_id: "EntityIdentifier", # required
|
4235
|
-
# device_id: "DeviceId", # required
|
4236
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
4237
|
-
# description: "MobileDeviceAccessRuleDescription",
|
4238
|
-
# }
|
4239
|
-
#
|
4240
3577
|
# @!attribute [rw] organization_id
|
4241
3578
|
# Identifies the WorkMail organization for which you create the
|
4242
3579
|
# override.
|
@@ -4283,23 +3620,6 @@ module Aws::WorkMail
|
|
4283
3620
|
#
|
4284
3621
|
class PutMobileDeviceAccessOverrideResponse < Aws::EmptyStructure; end
|
4285
3622
|
|
4286
|
-
# @note When making an API call, you may pass PutRetentionPolicyRequest
|
4287
|
-
# data as a hash:
|
4288
|
-
#
|
4289
|
-
# {
|
4290
|
-
# organization_id: "OrganizationId", # required
|
4291
|
-
# id: "ShortString",
|
4292
|
-
# name: "ShortString", # required
|
4293
|
-
# description: "PolicyDescription",
|
4294
|
-
# folder_configurations: [ # required
|
4295
|
-
# {
|
4296
|
-
# name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
|
4297
|
-
# action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
|
4298
|
-
# period: 1,
|
4299
|
-
# },
|
4300
|
-
# ],
|
4301
|
-
# }
|
4302
|
-
#
|
4303
3623
|
# @!attribute [rw] organization_id
|
4304
3624
|
# The organization ID.
|
4305
3625
|
# @return [String]
|
@@ -4356,15 +3676,6 @@ module Aws::WorkMail
|
|
4356
3676
|
include Aws::Structure
|
4357
3677
|
end
|
4358
3678
|
|
4359
|
-
# @note When making an API call, you may pass RegisterMailDomainRequest
|
4360
|
-
# data as a hash:
|
4361
|
-
#
|
4362
|
-
# {
|
4363
|
-
# client_token: "IdempotencyClientToken",
|
4364
|
-
# organization_id: "OrganizationId", # required
|
4365
|
-
# domain_name: "WorkMailDomainName", # required
|
4366
|
-
# }
|
4367
|
-
#
|
4368
3679
|
# @!attribute [rw] client_token
|
4369
3680
|
# Idempotency token used when retrying requests.
|
4370
3681
|
#
|
@@ -4394,15 +3705,6 @@ module Aws::WorkMail
|
|
4394
3705
|
#
|
4395
3706
|
class RegisterMailDomainResponse < Aws::EmptyStructure; end
|
4396
3707
|
|
4397
|
-
# @note When making an API call, you may pass RegisterToWorkMailRequest
|
4398
|
-
# data as a hash:
|
4399
|
-
#
|
4400
|
-
# {
|
4401
|
-
# organization_id: "OrganizationId", # required
|
4402
|
-
# entity_id: "WorkMailIdentifier", # required
|
4403
|
-
# email: "EmailAddress", # required
|
4404
|
-
# }
|
4405
|
-
#
|
4406
3708
|
# @!attribute [rw] organization_id
|
4407
3709
|
# The identifier for the organization under which the user, group, or
|
4408
3710
|
# resource exists.
|
@@ -4443,15 +3745,6 @@ module Aws::WorkMail
|
|
4443
3745
|
include Aws::Structure
|
4444
3746
|
end
|
4445
3747
|
|
4446
|
-
# @note When making an API call, you may pass ResetPasswordRequest
|
4447
|
-
# data as a hash:
|
4448
|
-
#
|
4449
|
-
# {
|
4450
|
-
# organization_id: "OrganizationId", # required
|
4451
|
-
# user_id: "WorkMailIdentifier", # required
|
4452
|
-
# password: "Password", # required
|
4453
|
-
# }
|
4454
|
-
#
|
4455
3748
|
# @!attribute [rw] organization_id
|
4456
3749
|
# The identifier of the organization that contains the user for which
|
4457
3750
|
# the password is reset.
|
@@ -4538,20 +3831,6 @@ module Aws::WorkMail
|
|
4538
3831
|
include Aws::Structure
|
4539
3832
|
end
|
4540
3833
|
|
4541
|
-
# @note When making an API call, you may pass StartMailboxExportJobRequest
|
4542
|
-
# data as a hash:
|
4543
|
-
#
|
4544
|
-
# {
|
4545
|
-
# client_token: "IdempotencyClientToken", # required
|
4546
|
-
# organization_id: "OrganizationId", # required
|
4547
|
-
# entity_id: "WorkMailIdentifier", # required
|
4548
|
-
# description: "Description",
|
4549
|
-
# role_arn: "RoleArn", # required
|
4550
|
-
# kms_key_arn: "KmsKeyArn", # required
|
4551
|
-
# s3_bucket_name: "S3BucketName", # required
|
4552
|
-
# s3_prefix: "S3ObjectKey", # required
|
4553
|
-
# }
|
4554
|
-
#
|
4555
3834
|
# @!attribute [rw] client_token
|
4556
3835
|
# The idempotency token for the client request.
|
4557
3836
|
#
|
@@ -4618,14 +3897,6 @@ module Aws::WorkMail
|
|
4618
3897
|
|
4619
3898
|
# Describes a tag applied to a resource.
|
4620
3899
|
#
|
4621
|
-
# @note When making an API call, you may pass Tag
|
4622
|
-
# data as a hash:
|
4623
|
-
#
|
4624
|
-
# {
|
4625
|
-
# key: "TagKey", # required
|
4626
|
-
# value: "TagValue", # required
|
4627
|
-
# }
|
4628
|
-
#
|
4629
3900
|
# @!attribute [rw] key
|
4630
3901
|
# The key of the tag.
|
4631
3902
|
# @return [String]
|
@@ -4643,19 +3914,6 @@ module Aws::WorkMail
|
|
4643
3914
|
include Aws::Structure
|
4644
3915
|
end
|
4645
3916
|
|
4646
|
-
# @note When making an API call, you may pass TagResourceRequest
|
4647
|
-
# data as a hash:
|
4648
|
-
#
|
4649
|
-
# {
|
4650
|
-
# resource_arn: "AmazonResourceName", # required
|
4651
|
-
# tags: [ # required
|
4652
|
-
# {
|
4653
|
-
# key: "TagKey", # required
|
4654
|
-
# value: "TagValue", # required
|
4655
|
-
# },
|
4656
|
-
# ],
|
4657
|
-
# }
|
4658
|
-
#
|
4659
3917
|
# @!attribute [rw] resource_arn
|
4660
3918
|
# The resource ARN.
|
4661
3919
|
# @return [String]
|
@@ -4677,22 +3935,6 @@ module Aws::WorkMail
|
|
4677
3935
|
#
|
4678
3936
|
class TagResourceResponse < Aws::EmptyStructure; end
|
4679
3937
|
|
4680
|
-
# @note When making an API call, you may pass TestAvailabilityConfigurationRequest
|
4681
|
-
# data as a hash:
|
4682
|
-
#
|
4683
|
-
# {
|
4684
|
-
# organization_id: "OrganizationId", # required
|
4685
|
-
# domain_name: "DomainName",
|
4686
|
-
# ews_provider: {
|
4687
|
-
# ews_endpoint: "Url", # required
|
4688
|
-
# ews_username: "ExternalUserName", # required
|
4689
|
-
# ews_password: "Password", # required
|
4690
|
-
# },
|
4691
|
-
# lambda_provider: {
|
4692
|
-
# lambda_arn: "LambdaArn", # required
|
4693
|
-
# },
|
4694
|
-
# }
|
4695
|
-
#
|
4696
3938
|
# @!attribute [rw] organization_id
|
4697
3939
|
# The WorkMail organization where the availability provider will be
|
4698
3940
|
# tested.
|
@@ -4768,14 +4010,6 @@ module Aws::WorkMail
|
|
4768
4010
|
include Aws::Structure
|
4769
4011
|
end
|
4770
4012
|
|
4771
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
4772
|
-
# data as a hash:
|
4773
|
-
#
|
4774
|
-
# {
|
4775
|
-
# resource_arn: "AmazonResourceName", # required
|
4776
|
-
# tag_keys: ["TagKey"], # required
|
4777
|
-
# }
|
4778
|
-
#
|
4779
4013
|
# @!attribute [rw] resource_arn
|
4780
4014
|
# The resource ARN.
|
4781
4015
|
# @return [String]
|
@@ -4797,22 +4031,6 @@ module Aws::WorkMail
|
|
4797
4031
|
#
|
4798
4032
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4799
4033
|
|
4800
|
-
# @note When making an API call, you may pass UpdateAvailabilityConfigurationRequest
|
4801
|
-
# data as a hash:
|
4802
|
-
#
|
4803
|
-
# {
|
4804
|
-
# organization_id: "OrganizationId", # required
|
4805
|
-
# domain_name: "DomainName", # required
|
4806
|
-
# ews_provider: {
|
4807
|
-
# ews_endpoint: "Url", # required
|
4808
|
-
# ews_username: "ExternalUserName", # required
|
4809
|
-
# ews_password: "Password", # required
|
4810
|
-
# },
|
4811
|
-
# lambda_provider: {
|
4812
|
-
# lambda_arn: "LambdaArn", # required
|
4813
|
-
# },
|
4814
|
-
# }
|
4815
|
-
#
|
4816
4034
|
# @!attribute [rw] organization_id
|
4817
4035
|
# The WorkMail organization for which the `AvailabilityConfiguration`
|
4818
4036
|
# will be updated.
|
@@ -4852,14 +4070,6 @@ module Aws::WorkMail
|
|
4852
4070
|
#
|
4853
4071
|
class UpdateAvailabilityConfigurationResponse < Aws::EmptyStructure; end
|
4854
4072
|
|
4855
|
-
# @note When making an API call, you may pass UpdateDefaultMailDomainRequest
|
4856
|
-
# data as a hash:
|
4857
|
-
#
|
4858
|
-
# {
|
4859
|
-
# organization_id: "OrganizationId", # required
|
4860
|
-
# domain_name: "WorkMailDomainName", # required
|
4861
|
-
# }
|
4862
|
-
#
|
4863
4073
|
# @!attribute [rw] organization_id
|
4864
4074
|
# The WorkMail organization for which to list domains.
|
4865
4075
|
# @return [String]
|
@@ -4881,27 +4091,6 @@ module Aws::WorkMail
|
|
4881
4091
|
#
|
4882
4092
|
class UpdateDefaultMailDomainResponse < Aws::EmptyStructure; end
|
4883
4093
|
|
4884
|
-
# @note When making an API call, you may pass UpdateImpersonationRoleRequest
|
4885
|
-
# data as a hash:
|
4886
|
-
#
|
4887
|
-
# {
|
4888
|
-
# organization_id: "OrganizationId", # required
|
4889
|
-
# impersonation_role_id: "ImpersonationRoleId", # required
|
4890
|
-
# name: "ImpersonationRoleName", # required
|
4891
|
-
# type: "FULL_ACCESS", # required, accepts FULL_ACCESS, READ_ONLY
|
4892
|
-
# description: "ImpersonationRoleDescription",
|
4893
|
-
# rules: [ # required
|
4894
|
-
# {
|
4895
|
-
# impersonation_rule_id: "ImpersonationRuleId", # required
|
4896
|
-
# name: "ImpersonationRuleName",
|
4897
|
-
# description: "ImpersonationRuleDescription",
|
4898
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
4899
|
-
# target_users: ["EntityIdentifier"],
|
4900
|
-
# not_target_users: ["EntityIdentifier"],
|
4901
|
-
# },
|
4902
|
-
# ],
|
4903
|
-
# }
|
4904
|
-
#
|
4905
4094
|
# @!attribute [rw] organization_id
|
4906
4095
|
# The WorkMail organization that contains the impersonation role to
|
4907
4096
|
# update.
|
@@ -4944,15 +4133,6 @@ module Aws::WorkMail
|
|
4944
4133
|
#
|
4945
4134
|
class UpdateImpersonationRoleResponse < Aws::EmptyStructure; end
|
4946
4135
|
|
4947
|
-
# @note When making an API call, you may pass UpdateMailboxQuotaRequest
|
4948
|
-
# data as a hash:
|
4949
|
-
#
|
4950
|
-
# {
|
4951
|
-
# organization_id: "OrganizationId", # required
|
4952
|
-
# user_id: "WorkMailIdentifier", # required
|
4953
|
-
# mailbox_quota: 1, # required
|
4954
|
-
# }
|
4955
|
-
#
|
4956
4136
|
# @!attribute [rw] organization_id
|
4957
4137
|
# The identifier for the organization that contains the user for whom
|
4958
4138
|
# to update the mailbox quota.
|
@@ -4980,25 +4160,6 @@ module Aws::WorkMail
|
|
4980
4160
|
#
|
4981
4161
|
class UpdateMailboxQuotaResponse < Aws::EmptyStructure; end
|
4982
4162
|
|
4983
|
-
# @note When making an API call, you may pass UpdateMobileDeviceAccessRuleRequest
|
4984
|
-
# data as a hash:
|
4985
|
-
#
|
4986
|
-
# {
|
4987
|
-
# organization_id: "OrganizationId", # required
|
4988
|
-
# mobile_device_access_rule_id: "MobileDeviceAccessRuleId", # required
|
4989
|
-
# name: "MobileDeviceAccessRuleName", # required
|
4990
|
-
# description: "MobileDeviceAccessRuleDescription",
|
4991
|
-
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
4992
|
-
# device_types: ["DeviceType"],
|
4993
|
-
# not_device_types: ["DeviceType"],
|
4994
|
-
# device_models: ["DeviceModel"],
|
4995
|
-
# not_device_models: ["DeviceModel"],
|
4996
|
-
# device_operating_systems: ["DeviceOperatingSystem"],
|
4997
|
-
# not_device_operating_systems: ["DeviceOperatingSystem"],
|
4998
|
-
# device_user_agents: ["DeviceUserAgent"],
|
4999
|
-
# not_device_user_agents: ["DeviceUserAgent"],
|
5000
|
-
# }
|
5001
|
-
#
|
5002
4163
|
# @!attribute [rw] organization_id
|
5003
4164
|
# The WorkMail organization under which the rule will be updated.
|
5004
4165
|
# @return [String]
|
@@ -5080,15 +4241,6 @@ module Aws::WorkMail
|
|
5080
4241
|
#
|
5081
4242
|
class UpdateMobileDeviceAccessRuleResponse < Aws::EmptyStructure; end
|
5082
4243
|
|
5083
|
-
# @note When making an API call, you may pass UpdatePrimaryEmailAddressRequest
|
5084
|
-
# data as a hash:
|
5085
|
-
#
|
5086
|
-
# {
|
5087
|
-
# organization_id: "OrganizationId", # required
|
5088
|
-
# entity_id: "WorkMailIdentifier", # required
|
5089
|
-
# email: "EmailAddress", # required
|
5090
|
-
# }
|
5091
|
-
#
|
5092
4244
|
# @!attribute [rw] organization_id
|
5093
4245
|
# The organization that contains the user, group, or resource to
|
5094
4246
|
# update.
|
@@ -5116,20 +4268,6 @@ module Aws::WorkMail
|
|
5116
4268
|
#
|
5117
4269
|
class UpdatePrimaryEmailAddressResponse < Aws::EmptyStructure; end
|
5118
4270
|
|
5119
|
-
# @note When making an API call, you may pass UpdateResourceRequest
|
5120
|
-
# data as a hash:
|
5121
|
-
#
|
5122
|
-
# {
|
5123
|
-
# organization_id: "OrganizationId", # required
|
5124
|
-
# resource_id: "ResourceId", # required
|
5125
|
-
# name: "ResourceName",
|
5126
|
-
# booking_options: {
|
5127
|
-
# auto_accept_requests: false,
|
5128
|
-
# auto_decline_recurring_requests: false,
|
5129
|
-
# auto_decline_conflicting_requests: false,
|
5130
|
-
# },
|
5131
|
-
# }
|
5132
|
-
#
|
5133
4271
|
# @!attribute [rw] organization_id
|
5134
4272
|
# The identifier associated with the organization for which the
|
5135
4273
|
# resource is updated.
|