aws-sdk-workmail 1.50.0 → 1.52.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 +457 -96
- data/lib/aws-sdk-workmail/client_api.rb +231 -1
- data/lib/aws-sdk-workmail/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-workmail/endpoint_provider.rb +111 -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 +611 -97
- data/lib/aws-sdk-workmail.rb +5 -1
- metadata +8 -4
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::WorkMail
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# A rule that controls access to an
|
13
|
+
# A rule that controls access to an WorkMail organization.
|
14
14
|
#
|
15
15
|
# @!attribute [rw] name
|
16
16
|
# The rule name.
|
@@ -60,6 +60,14 @@ module Aws::WorkMail
|
|
60
60
|
# The date that the rule was modified.
|
61
61
|
# @return [Time]
|
62
62
|
#
|
63
|
+
# @!attribute [rw] impersonation_role_ids
|
64
|
+
# Impersonation role IDs to include in the rule.
|
65
|
+
# @return [Array<String>]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] not_impersonation_role_ids
|
68
|
+
# Impersonation role IDs to exclude from the rule.
|
69
|
+
# @return [Array<String>]
|
70
|
+
#
|
63
71
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AccessControlRule AWS API Documentation
|
64
72
|
#
|
65
73
|
class AccessControlRule < Struct.new(
|
@@ -73,7 +81,9 @@ module Aws::WorkMail
|
|
73
81
|
:user_ids,
|
74
82
|
:not_user_ids,
|
75
83
|
:date_created,
|
76
|
-
:date_modified
|
84
|
+
:date_modified,
|
85
|
+
:impersonation_role_ids,
|
86
|
+
:not_impersonation_role_ids)
|
77
87
|
SENSITIVE = []
|
78
88
|
include Aws::Structure
|
79
89
|
end
|
@@ -148,6 +158,49 @@ module Aws::WorkMail
|
|
148
158
|
#
|
149
159
|
class AssociateMemberToGroupResponse < Aws::EmptyStructure; end
|
150
160
|
|
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
|
+
# @!attribute [rw] organization_id
|
170
|
+
# The WorkMail organization under which the impersonation role will be
|
171
|
+
# assumed.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] impersonation_role_id
|
175
|
+
# The impersonation role ID to assume.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssumeImpersonationRoleRequest AWS API Documentation
|
179
|
+
#
|
180
|
+
class AssumeImpersonationRoleRequest < Struct.new(
|
181
|
+
:organization_id,
|
182
|
+
:impersonation_role_id)
|
183
|
+
SENSITIVE = []
|
184
|
+
include Aws::Structure
|
185
|
+
end
|
186
|
+
|
187
|
+
# @!attribute [rw] token
|
188
|
+
# The authentication token for the impersonation role.
|
189
|
+
# @return [String]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] expires_in
|
192
|
+
# The authentication token's validity, in seconds.
|
193
|
+
# @return [Integer]
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssumeImpersonationRoleResponse AWS API Documentation
|
196
|
+
#
|
197
|
+
class AssumeImpersonationRoleResponse < Struct.new(
|
198
|
+
:token,
|
199
|
+
:expires_in)
|
200
|
+
SENSITIVE = []
|
201
|
+
include Aws::Structure
|
202
|
+
end
|
203
|
+
|
151
204
|
# List all the `AvailabilityConfiguration`'s for the given WorkMail
|
152
205
|
# organization.
|
153
206
|
#
|
@@ -161,7 +214,7 @@ module Aws::WorkMail
|
|
161
214
|
#
|
162
215
|
# @!attribute [rw] ews_provider
|
163
216
|
# If `ProviderType` is `EWS`, then this field contains
|
164
|
-
# `RedactedEwsAvailabilityProvider`. Otherwise, it is not
|
217
|
+
# `RedactedEwsAvailabilityProvider`. Otherwise, it is not required.
|
165
218
|
# @return [Types::RedactedEwsAvailabilityProvider]
|
166
219
|
#
|
167
220
|
# @!attribute [rw] lambda_provider
|
@@ -328,8 +381,8 @@ module Aws::WorkMail
|
|
328
381
|
# @return [String]
|
329
382
|
#
|
330
383
|
# @!attribute [rw] organization_id
|
331
|
-
# The
|
332
|
-
#
|
384
|
+
# The WorkMail organization for which the `AvailabilityConfiguration`
|
385
|
+
# will be created.
|
333
386
|
# @return [String]
|
334
387
|
#
|
335
388
|
# @!attribute [rw] domain_name
|
@@ -401,6 +454,81 @@ module Aws::WorkMail
|
|
401
454
|
include Aws::Structure
|
402
455
|
end
|
403
456
|
|
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
|
+
# @!attribute [rw] client_token
|
479
|
+
# The idempotency token for the client request.
|
480
|
+
#
|
481
|
+
# **A suitable default value is auto-generated.** You should normally
|
482
|
+
# not need to pass this option.
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @!attribute [rw] organization_id
|
486
|
+
# The WorkMail organization to create the new impersonation role
|
487
|
+
# within.
|
488
|
+
# @return [String]
|
489
|
+
#
|
490
|
+
# @!attribute [rw] name
|
491
|
+
# The name of the new impersonation role.
|
492
|
+
# @return [String]
|
493
|
+
#
|
494
|
+
# @!attribute [rw] type
|
495
|
+
# The impersonation role's type. The available impersonation role
|
496
|
+
# types are `READ_ONLY` or `FULL_ACCESS`.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] description
|
500
|
+
# The description of the new impersonation role.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] rules
|
504
|
+
# The list of rules for the impersonation role.
|
505
|
+
# @return [Array<Types::ImpersonationRule>]
|
506
|
+
#
|
507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateImpersonationRoleRequest AWS API Documentation
|
508
|
+
#
|
509
|
+
class CreateImpersonationRoleRequest < Struct.new(
|
510
|
+
:client_token,
|
511
|
+
:organization_id,
|
512
|
+
:name,
|
513
|
+
:type,
|
514
|
+
:description,
|
515
|
+
:rules)
|
516
|
+
SENSITIVE = []
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
520
|
+
# @!attribute [rw] impersonation_role_id
|
521
|
+
# The new impersonation role ID.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateImpersonationRoleResponse AWS API Documentation
|
525
|
+
#
|
526
|
+
class CreateImpersonationRoleResponse < Struct.new(
|
527
|
+
:impersonation_role_id)
|
528
|
+
SENSITIVE = []
|
529
|
+
include Aws::Structure
|
530
|
+
end
|
531
|
+
|
404
532
|
# @note When making an API call, you may pass CreateMobileDeviceAccessRuleRequest
|
405
533
|
# data as a hash:
|
406
534
|
#
|
@@ -421,8 +549,7 @@ module Aws::WorkMail
|
|
421
549
|
# }
|
422
550
|
#
|
423
551
|
# @!attribute [rw] organization_id
|
424
|
-
# The
|
425
|
-
# created.
|
552
|
+
# The WorkMail organization under which the rule will be created.
|
426
553
|
# @return [String]
|
427
554
|
#
|
428
555
|
# @!attribute [rw] client_token
|
@@ -550,14 +677,14 @@ module Aws::WorkMail
|
|
550
677
|
# @return [Array<Types::Domain>]
|
551
678
|
#
|
552
679
|
# @!attribute [rw] kms_key_arn
|
553
|
-
# The Amazon Resource Name (ARN) of a customer managed
|
554
|
-
#
|
680
|
+
# The Amazon Resource Name (ARN) of a customer managed key from AWS
|
681
|
+
# KMS.
|
555
682
|
# @return [String]
|
556
683
|
#
|
557
684
|
# @!attribute [rw] enable_interoperability
|
558
|
-
# When `true`, allows organization interoperability between
|
559
|
-
#
|
560
|
-
#
|
685
|
+
# When `true`, allows organization interoperability between WorkMail
|
686
|
+
# and Microsoft Exchange. If `true`, you must include a AD Connector
|
687
|
+
# directory ID in the request.
|
561
688
|
# @return [Boolean]
|
562
689
|
#
|
563
690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganizationRequest AWS API Documentation
|
@@ -777,8 +904,8 @@ module Aws::WorkMail
|
|
777
904
|
# }
|
778
905
|
#
|
779
906
|
# @!attribute [rw] organization_id
|
780
|
-
# The
|
781
|
-
#
|
907
|
+
# The WorkMail organization for which the `AvailabilityConfiguration`
|
908
|
+
# will be deleted.
|
782
909
|
# @return [String]
|
783
910
|
#
|
784
911
|
# @!attribute [rw] domain_name
|
@@ -852,6 +979,36 @@ module Aws::WorkMail
|
|
852
979
|
#
|
853
980
|
class DeleteGroupResponse < Aws::EmptyStructure; end
|
854
981
|
|
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
|
+
# @!attribute [rw] organization_id
|
991
|
+
# The WorkMail organization from which to delete the impersonation
|
992
|
+
# role.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] impersonation_role_id
|
996
|
+
# The ID of the impersonation role to delete.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteImpersonationRoleRequest AWS API Documentation
|
1000
|
+
#
|
1001
|
+
class DeleteImpersonationRoleRequest < Struct.new(
|
1002
|
+
:organization_id,
|
1003
|
+
:impersonation_role_id)
|
1004
|
+
SENSITIVE = []
|
1005
|
+
include Aws::Structure
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteImpersonationRoleResponse AWS API Documentation
|
1009
|
+
#
|
1010
|
+
class DeleteImpersonationRoleResponse < Aws::EmptyStructure; end
|
1011
|
+
|
855
1012
|
# @note When making an API call, you may pass DeleteMailboxPermissionsRequest
|
856
1013
|
# data as a hash:
|
857
1014
|
#
|
@@ -899,8 +1056,8 @@ module Aws::WorkMail
|
|
899
1056
|
# }
|
900
1057
|
#
|
901
1058
|
# @!attribute [rw] organization_id
|
902
|
-
# The
|
903
|
-
#
|
1059
|
+
# The WorkMail organization for which the access override will be
|
1060
|
+
# deleted.
|
904
1061
|
# @return [String]
|
905
1062
|
#
|
906
1063
|
# @!attribute [rw] user_id
|
@@ -943,8 +1100,7 @@ module Aws::WorkMail
|
|
943
1100
|
# }
|
944
1101
|
#
|
945
1102
|
# @!attribute [rw] organization_id
|
946
|
-
# The
|
947
|
-
# deleted.
|
1103
|
+
# The WorkMail organization under which the rule will be deleted.
|
948
1104
|
# @return [String]
|
949
1105
|
#
|
950
1106
|
# @!attribute [rw] mobile_device_access_rule_id
|
@@ -1113,8 +1269,8 @@ module Aws::WorkMail
|
|
1113
1269
|
# }
|
1114
1270
|
#
|
1115
1271
|
# @!attribute [rw] organization_id
|
1116
|
-
# The identifier for the organization under which the
|
1117
|
-
#
|
1272
|
+
# The identifier for the organization under which the WorkMail entity
|
1273
|
+
# exists.
|
1118
1274
|
# @return [String]
|
1119
1275
|
#
|
1120
1276
|
# @!attribute [rw] entity_id
|
@@ -1143,8 +1299,7 @@ module Aws::WorkMail
|
|
1143
1299
|
# }
|
1144
1300
|
#
|
1145
1301
|
# @!attribute [rw] organization_id
|
1146
|
-
# The
|
1147
|
-
# deregistered.
|
1302
|
+
# The WorkMail organization for which the domain will be deregistered.
|
1148
1303
|
# @return [String]
|
1149
1304
|
#
|
1150
1305
|
# @!attribute [rw] domain_name
|
@@ -1241,8 +1396,8 @@ module Aws::WorkMail
|
|
1241
1396
|
# @return [String]
|
1242
1397
|
#
|
1243
1398
|
# @!attribute [rw] state
|
1244
|
-
# The state of the user: enabled (registered to
|
1245
|
-
#
|
1399
|
+
# The state of the user: enabled (registered to WorkMail) or disabled
|
1400
|
+
# (deregistered or never registered to WorkMail).
|
1246
1401
|
# @return [String]
|
1247
1402
|
#
|
1248
1403
|
# @!attribute [rw] enabled_date
|
@@ -1428,7 +1583,7 @@ module Aws::WorkMail
|
|
1428
1583
|
# @return [String]
|
1429
1584
|
#
|
1430
1585
|
# @!attribute [rw] directory_id
|
1431
|
-
# The identifier for the directory associated with an
|
1586
|
+
# The identifier for the directory associated with an WorkMail
|
1432
1587
|
# organization.
|
1433
1588
|
# @return [String]
|
1434
1589
|
#
|
@@ -1517,7 +1672,7 @@ module Aws::WorkMail
|
|
1517
1672
|
# @return [Types::BookingOptions]
|
1518
1673
|
#
|
1519
1674
|
# @!attribute [rw] state
|
1520
|
-
# The state of the resource: enabled (registered to
|
1675
|
+
# The state of the resource: enabled (registered to WorkMail),
|
1521
1676
|
# disabled (deregistered or never registered to WorkMail), or deleted.
|
1522
1677
|
# @return [String]
|
1523
1678
|
#
|
@@ -1588,28 +1743,28 @@ module Aws::WorkMail
|
|
1588
1743
|
# @return [String]
|
1589
1744
|
#
|
1590
1745
|
# @!attribute [rw] state
|
1591
|
-
# The state of a user: enabled (registered to
|
1592
|
-
#
|
1746
|
+
# The state of a user: enabled (registered to WorkMail) or disabled
|
1747
|
+
# (deregistered or never registered to WorkMail).
|
1593
1748
|
# @return [String]
|
1594
1749
|
#
|
1595
1750
|
# @!attribute [rw] user_role
|
1596
1751
|
# In certain cases, other entities are modeled as users. If
|
1597
|
-
# interoperability is enabled, resources are imported into
|
1598
|
-
#
|
1599
|
-
#
|
1752
|
+
# interoperability is enabled, resources are imported into WorkMail as
|
1753
|
+
# users. Because different WorkMail organizations rely on different
|
1754
|
+
# directory types, administrators can distinguish between an
|
1600
1755
|
# unregistered user (account is disabled and has a user role) and the
|
1601
1756
|
# directory administrators. The values are USER, RESOURCE, and
|
1602
1757
|
# SYSTEM\_USER.
|
1603
1758
|
# @return [String]
|
1604
1759
|
#
|
1605
1760
|
# @!attribute [rw] enabled_date
|
1606
|
-
# The date and time at which the user was enabled for
|
1607
|
-
#
|
1761
|
+
# The date and time at which the user was enabled for WorkMailusage,
|
1762
|
+
# in UNIX epoch time format.
|
1608
1763
|
# @return [Time]
|
1609
1764
|
#
|
1610
1765
|
# @!attribute [rw] disabled_date
|
1611
|
-
# The date and time at which the user was disabled for
|
1612
|
-
#
|
1766
|
+
# The date and time at which the user was disabled for WorkMail usage,
|
1767
|
+
# in UNIX epoch time format.
|
1613
1768
|
# @return [Time]
|
1614
1769
|
#
|
1615
1770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserResponse AWS API Documentation
|
@@ -1766,12 +1921,12 @@ module Aws::WorkMail
|
|
1766
1921
|
include Aws::Structure
|
1767
1922
|
end
|
1768
1923
|
|
1769
|
-
# The domain to associate with an
|
1924
|
+
# The domain to associate with an WorkMail organization.
|
1770
1925
|
#
|
1771
1926
|
# When you configure a domain hosted in Amazon Route 53 (Route 53), all
|
1772
1927
|
# recommended DNS records are added to the organization when you create
|
1773
|
-
# it. For more information, see [Adding a domain][1] in the *
|
1774
|
-
#
|
1928
|
+
# it. For more information, see [Adding a domain][1] in the *WorkMail
|
1929
|
+
# Administrator Guide*.
|
1775
1930
|
#
|
1776
1931
|
#
|
1777
1932
|
#
|
@@ -1936,7 +2091,8 @@ module Aws::WorkMail
|
|
1936
2091
|
# organization_id: "OrganizationId", # required
|
1937
2092
|
# ip_address: "IpAddress", # required
|
1938
2093
|
# action: "AccessControlRuleAction", # required
|
1939
|
-
# user_id: "WorkMailIdentifier",
|
2094
|
+
# user_id: "WorkMailIdentifier",
|
2095
|
+
# impersonation_role_id: "ImpersonationRoleId",
|
1940
2096
|
# }
|
1941
2097
|
#
|
1942
2098
|
# @!attribute [rw] organization_id
|
@@ -1957,13 +2113,18 @@ module Aws::WorkMail
|
|
1957
2113
|
# The user ID.
|
1958
2114
|
# @return [String]
|
1959
2115
|
#
|
2116
|
+
# @!attribute [rw] impersonation_role_id
|
2117
|
+
# The impersonation role ID.
|
2118
|
+
# @return [String]
|
2119
|
+
#
|
1960
2120
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetAccessControlEffectRequest AWS API Documentation
|
1961
2121
|
#
|
1962
2122
|
class GetAccessControlEffectRequest < Struct.new(
|
1963
2123
|
:organization_id,
|
1964
2124
|
:ip_address,
|
1965
2125
|
:action,
|
1966
|
-
:user_id
|
2126
|
+
:user_id,
|
2127
|
+
:impersonation_role_id)
|
1967
2128
|
SENSITIVE = []
|
1968
2129
|
include Aws::Structure
|
1969
2130
|
end
|
@@ -2031,6 +2192,138 @@ module Aws::WorkMail
|
|
2031
2192
|
include Aws::Structure
|
2032
2193
|
end
|
2033
2194
|
|
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
|
+
# @!attribute [rw] organization_id
|
2205
|
+
# The WorkMail organization where the impersonation role is defined.
|
2206
|
+
# @return [String]
|
2207
|
+
#
|
2208
|
+
# @!attribute [rw] impersonation_role_id
|
2209
|
+
# The impersonation role ID to test.
|
2210
|
+
# @return [String]
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] target_user
|
2213
|
+
# The WorkMail organization user chosen to test the impersonation
|
2214
|
+
# role. The following identity formats are available:
|
2215
|
+
#
|
2216
|
+
# * User ID: `12345678-1234-1234-1234-123456789012` or
|
2217
|
+
# `S-1-1-12-1234567890-123456789-123456789-1234`
|
2218
|
+
#
|
2219
|
+
# * Email address: `user@domain.tld`
|
2220
|
+
#
|
2221
|
+
# * User name: `user`
|
2222
|
+
# @return [String]
|
2223
|
+
#
|
2224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRoleEffectRequest AWS API Documentation
|
2225
|
+
#
|
2226
|
+
class GetImpersonationRoleEffectRequest < Struct.new(
|
2227
|
+
:organization_id,
|
2228
|
+
:impersonation_role_id,
|
2229
|
+
:target_user)
|
2230
|
+
SENSITIVE = []
|
2231
|
+
include Aws::Structure
|
2232
|
+
end
|
2233
|
+
|
2234
|
+
# @!attribute [rw] type
|
2235
|
+
# The impersonation role type.
|
2236
|
+
# @return [String]
|
2237
|
+
#
|
2238
|
+
# @!attribute [rw] effect
|
2239
|
+
# `Effect of the impersonation role on the target user based on its
|
2240
|
+
# rules. Available effects are ALLOW or DENY.</p>
|
2241
|
+
# `
|
2242
|
+
# @return [String]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] matched_rules
|
2245
|
+
# A list of the rules that match the input and produce the configured
|
2246
|
+
# effect.
|
2247
|
+
# @return [Array<Types::ImpersonationMatchedRule>]
|
2248
|
+
#
|
2249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRoleEffectResponse AWS API Documentation
|
2250
|
+
#
|
2251
|
+
class GetImpersonationRoleEffectResponse < Struct.new(
|
2252
|
+
:type,
|
2253
|
+
:effect,
|
2254
|
+
:matched_rules)
|
2255
|
+
SENSITIVE = []
|
2256
|
+
include Aws::Structure
|
2257
|
+
end
|
2258
|
+
|
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
|
+
# @!attribute [rw] organization_id
|
2268
|
+
# The WorkMail organization from which to retrieve the impersonation
|
2269
|
+
# role.
|
2270
|
+
# @return [String]
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] impersonation_role_id
|
2273
|
+
# The impersonation role ID to retrieve.
|
2274
|
+
# @return [String]
|
2275
|
+
#
|
2276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRoleRequest AWS API Documentation
|
2277
|
+
#
|
2278
|
+
class GetImpersonationRoleRequest < Struct.new(
|
2279
|
+
:organization_id,
|
2280
|
+
:impersonation_role_id)
|
2281
|
+
SENSITIVE = []
|
2282
|
+
include Aws::Structure
|
2283
|
+
end
|
2284
|
+
|
2285
|
+
# @!attribute [rw] impersonation_role_id
|
2286
|
+
# The impersonation role ID.
|
2287
|
+
# @return [String]
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] name
|
2290
|
+
# The impersonation role name.
|
2291
|
+
# @return [String]
|
2292
|
+
#
|
2293
|
+
# @!attribute [rw] type
|
2294
|
+
# The impersonation role type.
|
2295
|
+
# @return [String]
|
2296
|
+
#
|
2297
|
+
# @!attribute [rw] description
|
2298
|
+
# The impersonation role description.
|
2299
|
+
# @return [String]
|
2300
|
+
#
|
2301
|
+
# @!attribute [rw] rules
|
2302
|
+
# The list of rules for the given impersonation role.
|
2303
|
+
# @return [Array<Types::ImpersonationRule>]
|
2304
|
+
#
|
2305
|
+
# @!attribute [rw] date_created
|
2306
|
+
# The date when the impersonation role was created.
|
2307
|
+
# @return [Time]
|
2308
|
+
#
|
2309
|
+
# @!attribute [rw] date_modified
|
2310
|
+
# The date when the impersonation role was last modified.
|
2311
|
+
# @return [Time]
|
2312
|
+
#
|
2313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRoleResponse AWS API Documentation
|
2314
|
+
#
|
2315
|
+
class GetImpersonationRoleResponse < Struct.new(
|
2316
|
+
:impersonation_role_id,
|
2317
|
+
:name,
|
2318
|
+
:type,
|
2319
|
+
:description,
|
2320
|
+
:rules,
|
2321
|
+
:date_created,
|
2322
|
+
:date_modified)
|
2323
|
+
SENSITIVE = []
|
2324
|
+
include Aws::Structure
|
2325
|
+
end
|
2326
|
+
|
2034
2327
|
# @note When making an API call, you may pass GetMailDomainRequest
|
2035
2328
|
# data as a hash:
|
2036
2329
|
#
|
@@ -2040,7 +2333,7 @@ module Aws::WorkMail
|
|
2040
2333
|
# }
|
2041
2334
|
#
|
2042
2335
|
# @!attribute [rw] organization_id
|
2043
|
-
# The
|
2336
|
+
# The WorkMail organization for which the domain is retrieved.
|
2044
2337
|
# @return [String]
|
2045
2338
|
#
|
2046
2339
|
# @!attribute [rw] domain_name
|
@@ -2057,10 +2350,10 @@ module Aws::WorkMail
|
|
2057
2350
|
end
|
2058
2351
|
|
2059
2352
|
# @!attribute [rw] records
|
2060
|
-
# A list of the DNS records that
|
2061
|
-
#
|
2062
|
-
#
|
2063
|
-
#
|
2353
|
+
# A list of the DNS records that WorkMail recommends adding in your
|
2354
|
+
# DNS provider for the best user experience. The records configure
|
2355
|
+
# your domain with DMARC, SPF, DKIM, and direct incoming email traffic
|
2356
|
+
# to SES. See admin guide for more details.
|
2064
2357
|
# @return [Array<Types::DnsRecord>]
|
2065
2358
|
#
|
2066
2359
|
# @!attribute [rw] is_test_domain
|
@@ -2149,7 +2442,7 @@ module Aws::WorkMail
|
|
2149
2442
|
# }
|
2150
2443
|
#
|
2151
2444
|
# @!attribute [rw] organization_id
|
2152
|
-
# The
|
2445
|
+
# The WorkMail organization to simulate the access effect for.
|
2153
2446
|
# @return [String]
|
2154
2447
|
#
|
2155
2448
|
# @!attribute [rw] device_type
|
@@ -2182,8 +2475,8 @@ module Aws::WorkMail
|
|
2182
2475
|
|
2183
2476
|
# @!attribute [rw] effect
|
2184
2477
|
# The effect of the simulated access, `ALLOW` or `DENY`, after
|
2185
|
-
# evaluating mobile device access rules in the
|
2186
|
-
#
|
2478
|
+
# evaluating mobile device access rules in the WorkMail organization
|
2479
|
+
# for the simulated user parameters.
|
2187
2480
|
# @return [String]
|
2188
2481
|
#
|
2189
2482
|
# @!attribute [rw] matched_rules
|
@@ -2210,8 +2503,7 @@ module Aws::WorkMail
|
|
2210
2503
|
# }
|
2211
2504
|
#
|
2212
2505
|
# @!attribute [rw] organization_id
|
2213
|
-
# The
|
2214
|
-
# override.
|
2506
|
+
# The WorkMail organization to which you want to apply the override.
|
2215
2507
|
# @return [String]
|
2216
2508
|
#
|
2217
2509
|
# @!attribute [rw] user_id
|
@@ -2278,7 +2570,7 @@ module Aws::WorkMail
|
|
2278
2570
|
include Aws::Structure
|
2279
2571
|
end
|
2280
2572
|
|
2281
|
-
# The representation of an
|
2573
|
+
# The representation of an WorkMail group.
|
2282
2574
|
#
|
2283
2575
|
# @!attribute [rw] id
|
2284
2576
|
# The identifier of the group.
|
@@ -2297,13 +2589,11 @@ module Aws::WorkMail
|
|
2297
2589
|
# @return [String]
|
2298
2590
|
#
|
2299
2591
|
# @!attribute [rw] enabled_date
|
2300
|
-
# The date indicating when the group was enabled for
|
2301
|
-
# use.
|
2592
|
+
# The date indicating when the group was enabled for WorkMail use.
|
2302
2593
|
# @return [Time]
|
2303
2594
|
#
|
2304
2595
|
# @!attribute [rw] disabled_date
|
2305
|
-
# The date indicating when the group was disabled from
|
2306
|
-
# use.
|
2596
|
+
# The date indicating when the group was disabled from WorkMail use.
|
2307
2597
|
# @return [Time]
|
2308
2598
|
#
|
2309
2599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Group AWS API Documentation
|
@@ -2319,6 +2609,111 @@ module Aws::WorkMail
|
|
2319
2609
|
include Aws::Structure
|
2320
2610
|
end
|
2321
2611
|
|
2612
|
+
# The impersonation rule that matched the input.
|
2613
|
+
#
|
2614
|
+
# @!attribute [rw] impersonation_rule_id
|
2615
|
+
# The ID of the rule that matched the input
|
2616
|
+
# @return [String]
|
2617
|
+
#
|
2618
|
+
# @!attribute [rw] name
|
2619
|
+
# The name of the rule that matched the input.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ImpersonationMatchedRule AWS API Documentation
|
2623
|
+
#
|
2624
|
+
class ImpersonationMatchedRule < Struct.new(
|
2625
|
+
:impersonation_rule_id,
|
2626
|
+
:name)
|
2627
|
+
SENSITIVE = []
|
2628
|
+
include Aws::Structure
|
2629
|
+
end
|
2630
|
+
|
2631
|
+
# An impersonation role for the given WorkMail organization.
|
2632
|
+
#
|
2633
|
+
# @!attribute [rw] impersonation_role_id
|
2634
|
+
# The identifier of the impersonation role.
|
2635
|
+
# @return [String]
|
2636
|
+
#
|
2637
|
+
# @!attribute [rw] name
|
2638
|
+
# The impersonation role name.
|
2639
|
+
# @return [String]
|
2640
|
+
#
|
2641
|
+
# @!attribute [rw] type
|
2642
|
+
# The impersonation role type.
|
2643
|
+
# @return [String]
|
2644
|
+
#
|
2645
|
+
# @!attribute [rw] date_created
|
2646
|
+
# The date when the impersonation role was created.
|
2647
|
+
# @return [Time]
|
2648
|
+
#
|
2649
|
+
# @!attribute [rw] date_modified
|
2650
|
+
# The date when the impersonation role was last modified.
|
2651
|
+
# @return [Time]
|
2652
|
+
#
|
2653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ImpersonationRole AWS API Documentation
|
2654
|
+
#
|
2655
|
+
class ImpersonationRole < Struct.new(
|
2656
|
+
:impersonation_role_id,
|
2657
|
+
:name,
|
2658
|
+
:type,
|
2659
|
+
:date_created,
|
2660
|
+
:date_modified)
|
2661
|
+
SENSITIVE = []
|
2662
|
+
include Aws::Structure
|
2663
|
+
end
|
2664
|
+
|
2665
|
+
# The rules for the given impersonation role.
|
2666
|
+
#
|
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
|
+
# @!attribute [rw] impersonation_rule_id
|
2680
|
+
# The identifier of the rule.
|
2681
|
+
# @return [String]
|
2682
|
+
#
|
2683
|
+
# @!attribute [rw] name
|
2684
|
+
# The rule name.
|
2685
|
+
# @return [String]
|
2686
|
+
#
|
2687
|
+
# @!attribute [rw] description
|
2688
|
+
# The rule description.
|
2689
|
+
# @return [String]
|
2690
|
+
#
|
2691
|
+
# @!attribute [rw] effect
|
2692
|
+
# The effect of the rule when it matches the input. Allowed effect
|
2693
|
+
# values are `ALLOW` or `DENY`.
|
2694
|
+
# @return [String]
|
2695
|
+
#
|
2696
|
+
# @!attribute [rw] target_users
|
2697
|
+
# A list of user IDs that match the rule.
|
2698
|
+
# @return [Array<String>]
|
2699
|
+
#
|
2700
|
+
# @!attribute [rw] not_target_users
|
2701
|
+
# A list of user IDs that don't match the rule.
|
2702
|
+
# @return [Array<String>]
|
2703
|
+
#
|
2704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ImpersonationRule AWS API Documentation
|
2705
|
+
#
|
2706
|
+
class ImpersonationRule < Struct.new(
|
2707
|
+
:impersonation_rule_id,
|
2708
|
+
:name,
|
2709
|
+
:description,
|
2710
|
+
:effect,
|
2711
|
+
:target_users,
|
2712
|
+
:not_target_users)
|
2713
|
+
SENSITIVE = []
|
2714
|
+
include Aws::Structure
|
2715
|
+
end
|
2716
|
+
|
2322
2717
|
# The configuration for a resource isn't valid. A resource must either
|
2323
2718
|
# be able to auto-respond to requests or have at least one delegate
|
2324
2719
|
# associated that can do so on its behalf.
|
@@ -2334,9 +2729,9 @@ module Aws::WorkMail
|
|
2334
2729
|
include Aws::Structure
|
2335
2730
|
end
|
2336
2731
|
|
2337
|
-
# You SES configuration has customizations that
|
2338
|
-
#
|
2339
|
-
#
|
2732
|
+
# You SES configuration has customizations that WorkMail cannot save.
|
2733
|
+
# The error message lists the invalid setting. For examples of invalid
|
2734
|
+
# settings, refer to [CreateReceiptRule][1].
|
2340
2735
|
#
|
2341
2736
|
#
|
2342
2737
|
#
|
@@ -2513,7 +2908,7 @@ module Aws::WorkMail
|
|
2513
2908
|
# }
|
2514
2909
|
#
|
2515
2910
|
# @!attribute [rw] organization_id
|
2516
|
-
# The
|
2911
|
+
# The WorkMail organization for which the
|
2517
2912
|
# `AvailabilityConfiguration`'s will be listed.
|
2518
2913
|
# @return [String]
|
2519
2914
|
#
|
@@ -2538,7 +2933,7 @@ module Aws::WorkMail
|
|
2538
2933
|
|
2539
2934
|
# @!attribute [rw] availability_configurations
|
2540
2935
|
# The list of `AvailabilityConfiguration`'s that exist for the
|
2541
|
-
# specified
|
2936
|
+
# specified WorkMail organization.
|
2542
2937
|
# @return [Array<Types::AvailabilityConfiguration>]
|
2543
2938
|
#
|
2544
2939
|
# @!attribute [rw] next_token
|
@@ -2662,6 +3057,58 @@ module Aws::WorkMail
|
|
2662
3057
|
include Aws::Structure
|
2663
3058
|
end
|
2664
3059
|
|
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
|
+
# @!attribute [rw] organization_id
|
3070
|
+
# The WorkMail organization to which the listed impersonation roles
|
3071
|
+
# belong.
|
3072
|
+
# @return [String]
|
3073
|
+
#
|
3074
|
+
# @!attribute [rw] next_token
|
3075
|
+
# The token used to retrieve the next page of results. The first call
|
3076
|
+
# doesn't require a token.
|
3077
|
+
# @return [String]
|
3078
|
+
#
|
3079
|
+
# @!attribute [rw] max_results
|
3080
|
+
# The maximum number of results returned in a single call.
|
3081
|
+
# @return [Integer]
|
3082
|
+
#
|
3083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListImpersonationRolesRequest AWS API Documentation
|
3084
|
+
#
|
3085
|
+
class ListImpersonationRolesRequest < Struct.new(
|
3086
|
+
:organization_id,
|
3087
|
+
:next_token,
|
3088
|
+
:max_results)
|
3089
|
+
SENSITIVE = []
|
3090
|
+
include Aws::Structure
|
3091
|
+
end
|
3092
|
+
|
3093
|
+
# @!attribute [rw] roles
|
3094
|
+
# The list of impersonation roles under the given WorkMail
|
3095
|
+
# organization.
|
3096
|
+
# @return [Array<Types::ImpersonationRole>]
|
3097
|
+
#
|
3098
|
+
# @!attribute [rw] next_token
|
3099
|
+
# The token to retrieve the next page of results. The value is `null`
|
3100
|
+
# when there are no results to return.
|
3101
|
+
# @return [String]
|
3102
|
+
#
|
3103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListImpersonationRolesResponse AWS API Documentation
|
3104
|
+
#
|
3105
|
+
class ListImpersonationRolesResponse < Struct.new(
|
3106
|
+
:roles,
|
3107
|
+
:next_token)
|
3108
|
+
SENSITIVE = []
|
3109
|
+
include Aws::Structure
|
3110
|
+
end
|
3111
|
+
|
2665
3112
|
# @note When making an API call, you may pass ListMailDomainsRequest
|
2666
3113
|
# data as a hash:
|
2667
3114
|
#
|
@@ -2672,7 +3119,7 @@ module Aws::WorkMail
|
|
2672
3119
|
# }
|
2673
3120
|
#
|
2674
3121
|
# @!attribute [rw] organization_id
|
2675
|
-
# The
|
3122
|
+
# The WorkMail organization for which to list domains.
|
2676
3123
|
# @return [String]
|
2677
3124
|
#
|
2678
3125
|
# @!attribute [rw] max_results
|
@@ -2696,8 +3143,8 @@ module Aws::WorkMail
|
|
2696
3143
|
|
2697
3144
|
# @!attribute [rw] mail_domains
|
2698
3145
|
# The list of mail domain summaries, specifying domains that exist in
|
2699
|
-
# the specified
|
2700
|
-
#
|
3146
|
+
# the specified WorkMail organization, along with the information
|
3147
|
+
# about whether the domain is or isn't the default.
|
2701
3148
|
# @return [Array<Types::MailDomainSummary>]
|
2702
3149
|
#
|
2703
3150
|
# @!attribute [rw] next_token
|
@@ -2832,8 +3279,8 @@ module Aws::WorkMail
|
|
2832
3279
|
# }
|
2833
3280
|
#
|
2834
3281
|
# @!attribute [rw] organization_id
|
2835
|
-
# The
|
2836
|
-
#
|
3282
|
+
# The WorkMail organization under which to list mobile device access
|
3283
|
+
# overrides.
|
2837
3284
|
# @return [String]
|
2838
3285
|
#
|
2839
3286
|
# @!attribute [rw] user_id
|
@@ -2875,7 +3322,7 @@ module Aws::WorkMail
|
|
2875
3322
|
|
2876
3323
|
# @!attribute [rw] overrides
|
2877
3324
|
# The list of mobile device access overrides that exist for the
|
2878
|
-
# specified
|
3325
|
+
# specified WorkMail organization and user.
|
2879
3326
|
# @return [Array<Types::MobileDeviceAccessOverride>]
|
2880
3327
|
#
|
2881
3328
|
# @!attribute [rw] next_token
|
@@ -2900,7 +3347,7 @@ module Aws::WorkMail
|
|
2900
3347
|
# }
|
2901
3348
|
#
|
2902
3349
|
# @!attribute [rw] organization_id
|
2903
|
-
# The
|
3350
|
+
# The WorkMail organization for which to list the rules.
|
2904
3351
|
# @return [String]
|
2905
3352
|
#
|
2906
3353
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessRulesRequest AWS API Documentation
|
@@ -2913,7 +3360,7 @@ module Aws::WorkMail
|
|
2913
3360
|
|
2914
3361
|
# @!attribute [rw] rules
|
2915
3362
|
# The list of mobile device access rules that exist under the
|
2916
|
-
# specified
|
3363
|
+
# specified WorkMail organization.
|
2917
3364
|
# @return [Array<Types::MobileDeviceAccessRule>]
|
2918
3365
|
#
|
2919
3366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessRulesResponse AWS API Documentation
|
@@ -3296,13 +3743,11 @@ module Aws::WorkMail
|
|
3296
3743
|
# @return [String]
|
3297
3744
|
#
|
3298
3745
|
# @!attribute [rw] enabled_date
|
3299
|
-
# The date indicating when the member was enabled for
|
3300
|
-
# use.
|
3746
|
+
# The date indicating when the member was enabled for WorkMail use.
|
3301
3747
|
# @return [Time]
|
3302
3748
|
#
|
3303
3749
|
# @!attribute [rw] disabled_date
|
3304
|
-
# The date indicating when the member was disabled from
|
3305
|
-
# WorkMail use.
|
3750
|
+
# The date indicating when the member was disabled from WorkMail use.
|
3306
3751
|
# @return [Time]
|
3307
3752
|
#
|
3308
3753
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Member AWS API Documentation
|
@@ -3376,8 +3821,7 @@ module Aws::WorkMail
|
|
3376
3821
|
include Aws::Structure
|
3377
3822
|
end
|
3378
3823
|
|
3379
|
-
# A rule that controls access to mobile devices for an
|
3380
|
-
# group.
|
3824
|
+
# A rule that controls access to mobile devices for an WorkMail group.
|
3381
3825
|
#
|
3382
3826
|
# @!attribute [rw] mobile_device_access_rule_id
|
3383
3827
|
# The ID assigned to a mobile access rule.
|
@@ -3461,7 +3905,7 @@ module Aws::WorkMail
|
|
3461
3905
|
include Aws::Structure
|
3462
3906
|
end
|
3463
3907
|
|
3464
|
-
# The user, group, or resource name isn't unique in
|
3908
|
+
# The user, group, or resource name isn't unique in WorkMail.
|
3465
3909
|
#
|
3466
3910
|
# @!attribute [rw] message
|
3467
3911
|
# @return [String]
|
@@ -3585,6 +4029,8 @@ module Aws::WorkMail
|
|
3585
4029
|
# user_ids: ["WorkMailIdentifier"],
|
3586
4030
|
# not_user_ids: ["WorkMailIdentifier"],
|
3587
4031
|
# organization_id: "OrganizationId", # required
|
4032
|
+
# impersonation_role_ids: ["ImpersonationRoleId"],
|
4033
|
+
# not_impersonation_role_ids: ["ImpersonationRoleId"],
|
3588
4034
|
# }
|
3589
4035
|
#
|
3590
4036
|
# @!attribute [rw] name
|
@@ -3631,6 +4077,14 @@ module Aws::WorkMail
|
|
3631
4077
|
# The identifier of the organization.
|
3632
4078
|
# @return [String]
|
3633
4079
|
#
|
4080
|
+
# @!attribute [rw] impersonation_role_ids
|
4081
|
+
# Impersonation role IDs to include in the rule.
|
4082
|
+
# @return [Array<String>]
|
4083
|
+
#
|
4084
|
+
# @!attribute [rw] not_impersonation_role_ids
|
4085
|
+
# Impersonation role IDs to exclude from the rule.
|
4086
|
+
# @return [Array<String>]
|
4087
|
+
#
|
3634
4088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutAccessControlRuleRequest AWS API Documentation
|
3635
4089
|
#
|
3636
4090
|
class PutAccessControlRuleRequest < Struct.new(
|
@@ -3643,7 +4097,9 @@ module Aws::WorkMail
|
|
3643
4097
|
:not_actions,
|
3644
4098
|
:user_ids,
|
3645
4099
|
:not_user_ids,
|
3646
|
-
:organization_id
|
4100
|
+
:organization_id,
|
4101
|
+
:impersonation_role_ids,
|
4102
|
+
:not_impersonation_role_ids)
|
3647
4103
|
SENSITIVE = []
|
3648
4104
|
include Aws::Structure
|
3649
4105
|
end
|
@@ -3782,7 +4238,7 @@ module Aws::WorkMail
|
|
3782
4238
|
# }
|
3783
4239
|
#
|
3784
4240
|
# @!attribute [rw] organization_id
|
3785
|
-
# Identifies the
|
4241
|
+
# Identifies the WorkMail organization for which you create the
|
3786
4242
|
# override.
|
3787
4243
|
# @return [String]
|
3788
4244
|
#
|
@@ -3917,12 +4373,11 @@ module Aws::WorkMail
|
|
3917
4373
|
# @return [String]
|
3918
4374
|
#
|
3919
4375
|
# @!attribute [rw] organization_id
|
3920
|
-
# The
|
3921
|
-
# domain.
|
4376
|
+
# The WorkMail organization under which you're creating the domain.
|
3922
4377
|
# @return [String]
|
3923
4378
|
#
|
3924
4379
|
# @!attribute [rw] domain_name
|
3925
|
-
# The name of the mail domain to create in
|
4380
|
+
# The name of the mail domain to create in WorkMail and SES.
|
3926
4381
|
# @return [String]
|
3927
4382
|
#
|
3928
4383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterMailDomainRequest AWS API Documentation
|
@@ -3975,7 +4430,7 @@ module Aws::WorkMail
|
|
3975
4430
|
#
|
3976
4431
|
class RegisterToWorkMailResponse < Aws::EmptyStructure; end
|
3977
4432
|
|
3978
|
-
# This user, group, or resource name is not allowed in
|
4433
|
+
# This user, group, or resource name is not allowed in WorkMail.
|
3979
4434
|
#
|
3980
4435
|
# @!attribute [rw] message
|
3981
4436
|
# @return [String]
|
@@ -4048,13 +4503,12 @@ module Aws::WorkMail
|
|
4048
4503
|
# @return [String]
|
4049
4504
|
#
|
4050
4505
|
# @!attribute [rw] enabled_date
|
4051
|
-
# The date indicating when the resource was enabled for
|
4052
|
-
# WorkMail use.
|
4506
|
+
# The date indicating when the resource was enabled for WorkMail use.
|
4053
4507
|
# @return [Time]
|
4054
4508
|
#
|
4055
4509
|
# @!attribute [rw] disabled_date
|
4056
|
-
# The date indicating when the resource was disabled from
|
4057
|
-
#
|
4510
|
+
# The date indicating when the resource was disabled from WorkMail
|
4511
|
+
# use.
|
4058
4512
|
# @return [Time]
|
4059
4513
|
#
|
4060
4514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Resource AWS API Documentation
|
@@ -4240,8 +4694,8 @@ module Aws::WorkMail
|
|
4240
4694
|
# }
|
4241
4695
|
#
|
4242
4696
|
# @!attribute [rw] organization_id
|
4243
|
-
# The
|
4244
|
-
#
|
4697
|
+
# The WorkMail organization where the availability provider will be
|
4698
|
+
# tested.
|
4245
4699
|
# @return [String]
|
4246
4700
|
#
|
4247
4701
|
# @!attribute [rw] domain_name
|
@@ -4360,8 +4814,8 @@ module Aws::WorkMail
|
|
4360
4814
|
# }
|
4361
4815
|
#
|
4362
4816
|
# @!attribute [rw] organization_id
|
4363
|
-
# The
|
4364
|
-
#
|
4817
|
+
# The WorkMail organization for which the `AvailabilityConfiguration`
|
4818
|
+
# will be updated.
|
4365
4819
|
# @return [String]
|
4366
4820
|
#
|
4367
4821
|
# @!attribute [rw] domain_name
|
@@ -4407,7 +4861,7 @@ module Aws::WorkMail
|
|
4407
4861
|
# }
|
4408
4862
|
#
|
4409
4863
|
# @!attribute [rw] organization_id
|
4410
|
-
# The
|
4864
|
+
# The WorkMail organization for which to list domains.
|
4411
4865
|
# @return [String]
|
4412
4866
|
#
|
4413
4867
|
# @!attribute [rw] domain_name
|
@@ -4427,6 +4881,69 @@ module Aws::WorkMail
|
|
4427
4881
|
#
|
4428
4882
|
class UpdateDefaultMailDomainResponse < Aws::EmptyStructure; end
|
4429
4883
|
|
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
|
+
# @!attribute [rw] organization_id
|
4906
|
+
# The WorkMail organization that contains the impersonation role to
|
4907
|
+
# update.
|
4908
|
+
# @return [String]
|
4909
|
+
#
|
4910
|
+
# @!attribute [rw] impersonation_role_id
|
4911
|
+
# The ID of the impersonation role to update.
|
4912
|
+
# @return [String]
|
4913
|
+
#
|
4914
|
+
# @!attribute [rw] name
|
4915
|
+
# The updated impersonation role name.
|
4916
|
+
# @return [String]
|
4917
|
+
#
|
4918
|
+
# @!attribute [rw] type
|
4919
|
+
# The updated impersonation role type.
|
4920
|
+
# @return [String]
|
4921
|
+
#
|
4922
|
+
# @!attribute [rw] description
|
4923
|
+
# The updated impersonation role description.
|
4924
|
+
# @return [String]
|
4925
|
+
#
|
4926
|
+
# @!attribute [rw] rules
|
4927
|
+
# The updated list of rules.
|
4928
|
+
# @return [Array<Types::ImpersonationRule>]
|
4929
|
+
#
|
4930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateImpersonationRoleRequest AWS API Documentation
|
4931
|
+
#
|
4932
|
+
class UpdateImpersonationRoleRequest < Struct.new(
|
4933
|
+
:organization_id,
|
4934
|
+
:impersonation_role_id,
|
4935
|
+
:name,
|
4936
|
+
:type,
|
4937
|
+
:description,
|
4938
|
+
:rules)
|
4939
|
+
SENSITIVE = []
|
4940
|
+
include Aws::Structure
|
4941
|
+
end
|
4942
|
+
|
4943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateImpersonationRoleResponse AWS API Documentation
|
4944
|
+
#
|
4945
|
+
class UpdateImpersonationRoleResponse < Aws::EmptyStructure; end
|
4946
|
+
|
4430
4947
|
# @note When making an API call, you may pass UpdateMailboxQuotaRequest
|
4431
4948
|
# data as a hash:
|
4432
4949
|
#
|
@@ -4483,8 +5000,7 @@ module Aws::WorkMail
|
|
4483
5000
|
# }
|
4484
5001
|
#
|
4485
5002
|
# @!attribute [rw] organization_id
|
4486
|
-
# The
|
4487
|
-
# updated.
|
5003
|
+
# The WorkMail organization under which the rule will be updated.
|
4488
5004
|
# @return [String]
|
4489
5005
|
#
|
4490
5006
|
# @!attribute [rw] mobile_device_access_rule_id
|
@@ -4646,7 +5162,7 @@ module Aws::WorkMail
|
|
4646
5162
|
#
|
4647
5163
|
class UpdateResourceResponse < Aws::EmptyStructure; end
|
4648
5164
|
|
4649
|
-
# The representation of an
|
5165
|
+
# The representation of an WorkMail user.
|
4650
5166
|
#
|
4651
5167
|
# @!attribute [rw] id
|
4652
5168
|
# The identifier of the user.
|
@@ -4673,13 +5189,11 @@ module Aws::WorkMail
|
|
4673
5189
|
# @return [String]
|
4674
5190
|
#
|
4675
5191
|
# @!attribute [rw] enabled_date
|
4676
|
-
# The date indicating when the user was enabled for
|
4677
|
-
# use.
|
5192
|
+
# The date indicating when the user was enabled for WorkMail use.
|
4678
5193
|
# @return [Time]
|
4679
5194
|
#
|
4680
5195
|
# @!attribute [rw] disabled_date
|
4681
|
-
# The date indicating when the user was disabled from
|
4682
|
-
# use.
|
5196
|
+
# The date indicating when the user was disabled from WorkMail use.
|
4683
5197
|
# @return [Time]
|
4684
5198
|
#
|
4685
5199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/User AWS API Documentation
|