aws-sdk-workmail 1.42.0 → 1.43.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workmail/client.rb +203 -1
- data/lib/aws-sdk-workmail/client_api.rb +144 -0
- data/lib/aws-sdk-workmail/errors.rb +32 -0
- data/lib/aws-sdk-workmail/types.rb +292 -4
- data/lib/aws-sdk-workmail.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 743bf8c207d2ac98d6ac53d14e995e72babf67413c1ba322ce7cf357538eb712
|
4
|
+
data.tar.gz: d918fa3d86fe232a1a116102fd3e1cd2687fe9b33a14b24df450ff9bbfeead92
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 882f50437cc5549e51c2a921b8e82ebcf074a7f245877b7024239433b362e8ee3167e2b275f1c4b06a888d2b839dbdcbcf53aa9d3a74bac1bccc780f67c4517a
|
7
|
+
data.tar.gz: 4d53b5feb9ca2101683ab619a63b428aa1804e37d802fe3e524f43b527842f5f23897a42d16abf36e0d550e9900705bdc6c780fb27336c4ac5aa4e17e96d3f37
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.43.0
|
@@ -751,6 +751,12 @@ module Aws::WorkMail
|
|
751
751
|
# Deletes an access control rule for the specified WorkMail
|
752
752
|
# organization.
|
753
753
|
#
|
754
|
+
# <note markdown="1"> Deleting already deleted and non-existing rules does not produce an
|
755
|
+
# error. In those cases, the service sends back an HTTP 200 response
|
756
|
+
# with an empty HTTP body.
|
757
|
+
#
|
758
|
+
# </note>
|
759
|
+
#
|
754
760
|
# @option params [required, String] :organization_id
|
755
761
|
# The identifier for the organization.
|
756
762
|
#
|
@@ -870,6 +876,12 @@ module Aws::WorkMail
|
|
870
876
|
# Deletes the mobile device access override for the given WorkMail
|
871
877
|
# organization, user, and device.
|
872
878
|
#
|
879
|
+
# <note markdown="1"> Deleting already deleted and non-existing overrides does not produce
|
880
|
+
# an error. In those cases, the service sends back an HTTP 200 response
|
881
|
+
# with an empty HTTP body.
|
882
|
+
#
|
883
|
+
# </note>
|
884
|
+
#
|
873
885
|
# @option params [required, String] :organization_id
|
874
886
|
# The Amazon WorkMail organization for which the access override will be
|
875
887
|
# deleted.
|
@@ -911,6 +923,12 @@ module Aws::WorkMail
|
|
911
923
|
# Deletes a mobile device access rule for the specified Amazon WorkMail
|
912
924
|
# organization.
|
913
925
|
#
|
926
|
+
# <note markdown="1"> Deleting already deleted and non-existing rules does not produce an
|
927
|
+
# error. In those cases, the service sends back an HTTP 200 response
|
928
|
+
# with an empty HTTP body.
|
929
|
+
#
|
930
|
+
# </note>
|
931
|
+
#
|
914
932
|
# @option params [required, String] :organization_id
|
915
933
|
# The Amazon WorkMail organization under which the rule will be deleted.
|
916
934
|
#
|
@@ -1100,6 +1118,37 @@ module Aws::WorkMail
|
|
1100
1118
|
req.send_request(options)
|
1101
1119
|
end
|
1102
1120
|
|
1121
|
+
# Removes a domain from Amazon WorkMail, stops email routing to
|
1122
|
+
# WorkMail, and removes the authorization allowing WorkMail use. SES
|
1123
|
+
# keeps the domain because other applications may use it. You must first
|
1124
|
+
# remove any email address used by WorkMail entities before you remove
|
1125
|
+
# the domain.
|
1126
|
+
#
|
1127
|
+
# @option params [required, String] :organization_id
|
1128
|
+
# The Amazon WorkMail organization for which the domain will be
|
1129
|
+
# deregistered.
|
1130
|
+
#
|
1131
|
+
# @option params [required, String] :domain_name
|
1132
|
+
# The domain to deregister in WorkMail and SES.
|
1133
|
+
#
|
1134
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1135
|
+
#
|
1136
|
+
# @example Request syntax with placeholder values
|
1137
|
+
#
|
1138
|
+
# resp = client.deregister_mail_domain({
|
1139
|
+
# organization_id: "OrganizationId", # required
|
1140
|
+
# domain_name: "WorkMailDomainName", # required
|
1141
|
+
# })
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterMailDomain AWS API Documentation
|
1144
|
+
#
|
1145
|
+
# @overload deregister_mail_domain(params = {})
|
1146
|
+
# @param [Hash] params ({})
|
1147
|
+
def deregister_mail_domain(params = {}, options = {})
|
1148
|
+
req = build_request(:deregister_mail_domain, params)
|
1149
|
+
req.send_request(options)
|
1150
|
+
end
|
1151
|
+
|
1103
1152
|
# Returns the data available for the group.
|
1104
1153
|
#
|
1105
1154
|
# @option params [required, String] :organization_id
|
@@ -1510,6 +1559,50 @@ module Aws::WorkMail
|
|
1510
1559
|
req.send_request(options)
|
1511
1560
|
end
|
1512
1561
|
|
1562
|
+
# Gets details for a mail domain, including domain records required to
|
1563
|
+
# configure your domain with recommended security.
|
1564
|
+
#
|
1565
|
+
# @option params [required, String] :organization_id
|
1566
|
+
# The Amazon WorkMail organization for which the domain is retrieved.
|
1567
|
+
#
|
1568
|
+
# @option params [required, String] :domain_name
|
1569
|
+
# The domain from which you want to retrieve details.
|
1570
|
+
#
|
1571
|
+
# @return [Types::GetMailDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1572
|
+
#
|
1573
|
+
# * {Types::GetMailDomainResponse#records #records} => Array<Types::DnsRecord>
|
1574
|
+
# * {Types::GetMailDomainResponse#is_test_domain #is_test_domain} => Boolean
|
1575
|
+
# * {Types::GetMailDomainResponse#is_default #is_default} => Boolean
|
1576
|
+
# * {Types::GetMailDomainResponse#ownership_verification_status #ownership_verification_status} => String
|
1577
|
+
# * {Types::GetMailDomainResponse#dkim_verification_status #dkim_verification_status} => String
|
1578
|
+
#
|
1579
|
+
# @example Request syntax with placeholder values
|
1580
|
+
#
|
1581
|
+
# resp = client.get_mail_domain({
|
1582
|
+
# organization_id: "OrganizationId", # required
|
1583
|
+
# domain_name: "WorkMailDomainName", # required
|
1584
|
+
# })
|
1585
|
+
#
|
1586
|
+
# @example Response structure
|
1587
|
+
#
|
1588
|
+
# resp.records #=> Array
|
1589
|
+
# resp.records[0].type #=> String
|
1590
|
+
# resp.records[0].hostname #=> String
|
1591
|
+
# resp.records[0].value #=> String
|
1592
|
+
# resp.is_test_domain #=> Boolean
|
1593
|
+
# resp.is_default #=> Boolean
|
1594
|
+
# resp.ownership_verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED"
|
1595
|
+
# resp.dkim_verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED"
|
1596
|
+
#
|
1597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailDomain AWS API Documentation
|
1598
|
+
#
|
1599
|
+
# @overload get_mail_domain(params = {})
|
1600
|
+
# @param [Hash] params ({})
|
1601
|
+
def get_mail_domain(params = {}, options = {})
|
1602
|
+
req = build_request(:get_mail_domain, params)
|
1603
|
+
req.send_request(options)
|
1604
|
+
end
|
1605
|
+
|
1513
1606
|
# Requests a user's mailbox details for a specified organization and
|
1514
1607
|
# user.
|
1515
1608
|
#
|
@@ -1846,6 +1939,49 @@ module Aws::WorkMail
|
|
1846
1939
|
req.send_request(options)
|
1847
1940
|
end
|
1848
1941
|
|
1942
|
+
# Lists the mail domains in a given Amazon WorkMail organization.
|
1943
|
+
#
|
1944
|
+
# @option params [required, String] :organization_id
|
1945
|
+
# The Amazon WorkMail organization for which to list domains.
|
1946
|
+
#
|
1947
|
+
# @option params [Integer] :max_results
|
1948
|
+
# The maximum number of results to return in a single call.
|
1949
|
+
#
|
1950
|
+
# @option params [String] :next_token
|
1951
|
+
# The token to use to retrieve the next page of results. The first call
|
1952
|
+
# does not require a token.
|
1953
|
+
#
|
1954
|
+
# @return [Types::ListMailDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1955
|
+
#
|
1956
|
+
# * {Types::ListMailDomainsResponse#mail_domains #mail_domains} => Array<Types::MailDomainSummary>
|
1957
|
+
# * {Types::ListMailDomainsResponse#next_token #next_token} => String
|
1958
|
+
#
|
1959
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1960
|
+
#
|
1961
|
+
# @example Request syntax with placeholder values
|
1962
|
+
#
|
1963
|
+
# resp = client.list_mail_domains({
|
1964
|
+
# organization_id: "OrganizationId", # required
|
1965
|
+
# max_results: 1,
|
1966
|
+
# next_token: "NextToken",
|
1967
|
+
# })
|
1968
|
+
#
|
1969
|
+
# @example Response structure
|
1970
|
+
#
|
1971
|
+
# resp.mail_domains #=> Array
|
1972
|
+
# resp.mail_domains[0].domain_name #=> String
|
1973
|
+
# resp.mail_domains[0].default_domain #=> Boolean
|
1974
|
+
# resp.next_token #=> String
|
1975
|
+
#
|
1976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailDomains AWS API Documentation
|
1977
|
+
#
|
1978
|
+
# @overload list_mail_domains(params = {})
|
1979
|
+
# @param [Hash] params ({})
|
1980
|
+
def list_mail_domains(params = {}, options = {})
|
1981
|
+
req = build_request(:list_mail_domains, params)
|
1982
|
+
req.send_request(options)
|
1983
|
+
end
|
1984
|
+
|
1849
1985
|
# Lists the mailbox export jobs started for the specified organization
|
1850
1986
|
# within the last seven days.
|
1851
1987
|
#
|
@@ -2510,6 +2646,44 @@ module Aws::WorkMail
|
|
2510
2646
|
req.send_request(options)
|
2511
2647
|
end
|
2512
2648
|
|
2649
|
+
# Registers a new domain in Amazon WorkMail and SES, and configures it
|
2650
|
+
# for use by WorkMail. Emails received by SES for this domain are routed
|
2651
|
+
# to the specified WorkMail organization, and WorkMail has permanent
|
2652
|
+
# permission to use the specified domain for sending your users'
|
2653
|
+
# emails.
|
2654
|
+
#
|
2655
|
+
# @option params [String] :client_token
|
2656
|
+
# Idempotency token used when retrying requests.
|
2657
|
+
#
|
2658
|
+
# **A suitable default value is auto-generated.** You should normally
|
2659
|
+
# not need to pass this option.**
|
2660
|
+
#
|
2661
|
+
# @option params [required, String] :organization_id
|
2662
|
+
# The Amazon WorkMail organization under which you're creating the
|
2663
|
+
# domain.
|
2664
|
+
#
|
2665
|
+
# @option params [required, String] :domain_name
|
2666
|
+
# The name of the mail domain to create in Amazon WorkMail and SES.
|
2667
|
+
#
|
2668
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2669
|
+
#
|
2670
|
+
# @example Request syntax with placeholder values
|
2671
|
+
#
|
2672
|
+
# resp = client.register_mail_domain({
|
2673
|
+
# client_token: "IdempotencyClientToken",
|
2674
|
+
# organization_id: "OrganizationId", # required
|
2675
|
+
# domain_name: "WorkMailDomainName", # required
|
2676
|
+
# })
|
2677
|
+
#
|
2678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterMailDomain AWS API Documentation
|
2679
|
+
#
|
2680
|
+
# @overload register_mail_domain(params = {})
|
2681
|
+
# @param [Hash] params ({})
|
2682
|
+
def register_mail_domain(params = {}, options = {})
|
2683
|
+
req = build_request(:register_mail_domain, params)
|
2684
|
+
req.send_request(options)
|
2685
|
+
end
|
2686
|
+
|
2513
2687
|
# Registers an existing and disabled user, group, or resource for Amazon
|
2514
2688
|
# WorkMail use by associating a mailbox and calendaring capabilities. It
|
2515
2689
|
# performs no change if the user, group, or resource is enabled and
|
@@ -2714,6 +2888,34 @@ module Aws::WorkMail
|
|
2714
2888
|
req.send_request(options)
|
2715
2889
|
end
|
2716
2890
|
|
2891
|
+
# Updates the default mail domain for an organization. The default mail
|
2892
|
+
# domain is used by the WorkMail AWS Console to suggest an email address
|
2893
|
+
# when enabling a mail user. You can only have one default domain.
|
2894
|
+
#
|
2895
|
+
# @option params [required, String] :organization_id
|
2896
|
+
# The Amazon WorkMail organization for which to list domains.
|
2897
|
+
#
|
2898
|
+
# @option params [required, String] :domain_name
|
2899
|
+
# The domain name that will become the default domain.
|
2900
|
+
#
|
2901
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2902
|
+
#
|
2903
|
+
# @example Request syntax with placeholder values
|
2904
|
+
#
|
2905
|
+
# resp = client.update_default_mail_domain({
|
2906
|
+
# organization_id: "OrganizationId", # required
|
2907
|
+
# domain_name: "WorkMailDomainName", # required
|
2908
|
+
# })
|
2909
|
+
#
|
2910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateDefaultMailDomain AWS API Documentation
|
2911
|
+
#
|
2912
|
+
# @overload update_default_mail_domain(params = {})
|
2913
|
+
# @param [Hash] params ({})
|
2914
|
+
def update_default_mail_domain(params = {}, options = {})
|
2915
|
+
req = build_request(:update_default_mail_domain, params)
|
2916
|
+
req.send_request(options)
|
2917
|
+
end
|
2918
|
+
|
2717
2919
|
# Updates a user's current mailbox quota for a specified organization
|
2718
2920
|
# and user.
|
2719
2921
|
#
|
@@ -2910,7 +3112,7 @@ module Aws::WorkMail
|
|
2910
3112
|
params: params,
|
2911
3113
|
config: config)
|
2912
3114
|
context[:gem_name] = 'aws-sdk-workmail'
|
2913
|
-
context[:gem_version] = '1.
|
3115
|
+
context[:gem_version] = '1.43.0'
|
2914
3116
|
Seahorse::Client::Request.new(handlers, context)
|
2915
3117
|
end
|
2916
3118
|
|
@@ -67,6 +67,8 @@ module Aws::WorkMail
|
|
67
67
|
DeleteUserResponse = Shapes::StructureShape.new(name: 'DeleteUserResponse')
|
68
68
|
DeregisterFromWorkMailRequest = Shapes::StructureShape.new(name: 'DeregisterFromWorkMailRequest')
|
69
69
|
DeregisterFromWorkMailResponse = Shapes::StructureShape.new(name: 'DeregisterFromWorkMailResponse')
|
70
|
+
DeregisterMailDomainRequest = Shapes::StructureShape.new(name: 'DeregisterMailDomainRequest')
|
71
|
+
DeregisterMailDomainResponse = Shapes::StructureShape.new(name: 'DeregisterMailDomainResponse')
|
70
72
|
DescribeGroupRequest = Shapes::StructureShape.new(name: 'DescribeGroupRequest')
|
71
73
|
DescribeGroupResponse = Shapes::StructureShape.new(name: 'DescribeGroupResponse')
|
72
74
|
DescribeInboundDmarcSettingsRequest = Shapes::StructureShape.new(name: 'DescribeInboundDmarcSettingsRequest')
|
@@ -97,6 +99,9 @@ module Aws::WorkMail
|
|
97
99
|
DisassociateDelegateFromResourceResponse = Shapes::StructureShape.new(name: 'DisassociateDelegateFromResourceResponse')
|
98
100
|
DisassociateMemberFromGroupRequest = Shapes::StructureShape.new(name: 'DisassociateMemberFromGroupRequest')
|
99
101
|
DisassociateMemberFromGroupResponse = Shapes::StructureShape.new(name: 'DisassociateMemberFromGroupResponse')
|
102
|
+
DnsRecord = Shapes::StructureShape.new(name: 'DnsRecord')
|
103
|
+
DnsRecordVerificationStatus = Shapes::StringShape.new(name: 'DnsRecordVerificationStatus')
|
104
|
+
DnsRecords = Shapes::ListShape.new(name: 'DnsRecords')
|
100
105
|
Domain = Shapes::StructureShape.new(name: 'Domain')
|
101
106
|
DomainName = Shapes::StringShape.new(name: 'DomainName')
|
102
107
|
Domains = Shapes::ListShape.new(name: 'Domains')
|
@@ -114,6 +119,8 @@ module Aws::WorkMail
|
|
114
119
|
GetAccessControlEffectResponse = Shapes::StructureShape.new(name: 'GetAccessControlEffectResponse')
|
115
120
|
GetDefaultRetentionPolicyRequest = Shapes::StructureShape.new(name: 'GetDefaultRetentionPolicyRequest')
|
116
121
|
GetDefaultRetentionPolicyResponse = Shapes::StructureShape.new(name: 'GetDefaultRetentionPolicyResponse')
|
122
|
+
GetMailDomainRequest = Shapes::StructureShape.new(name: 'GetMailDomainRequest')
|
123
|
+
GetMailDomainResponse = Shapes::StructureShape.new(name: 'GetMailDomainResponse')
|
117
124
|
GetMailboxDetailsRequest = Shapes::StructureShape.new(name: 'GetMailboxDetailsRequest')
|
118
125
|
GetMailboxDetailsResponse = Shapes::StructureShape.new(name: 'GetMailboxDetailsResponse')
|
119
126
|
GetMobileDeviceAccessEffectRequest = Shapes::StructureShape.new(name: 'GetMobileDeviceAccessEffectRequest')
|
@@ -126,6 +133,7 @@ module Aws::WorkMail
|
|
126
133
|
HostedZoneId = Shapes::StringShape.new(name: 'HostedZoneId')
|
127
134
|
IdempotencyClientToken = Shapes::StringShape.new(name: 'IdempotencyClientToken')
|
128
135
|
InvalidConfigurationException = Shapes::StructureShape.new(name: 'InvalidConfigurationException')
|
136
|
+
InvalidCustomSesConfigurationException = Shapes::StructureShape.new(name: 'InvalidCustomSesConfigurationException')
|
129
137
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
130
138
|
InvalidPasswordException = Shapes::StructureShape.new(name: 'InvalidPasswordException')
|
131
139
|
IpAddress = Shapes::StringShape.new(name: 'IpAddress')
|
@@ -142,6 +150,8 @@ module Aws::WorkMail
|
|
142
150
|
ListGroupMembersResponse = Shapes::StructureShape.new(name: 'ListGroupMembersResponse')
|
143
151
|
ListGroupsRequest = Shapes::StructureShape.new(name: 'ListGroupsRequest')
|
144
152
|
ListGroupsResponse = Shapes::StructureShape.new(name: 'ListGroupsResponse')
|
153
|
+
ListMailDomainsRequest = Shapes::StructureShape.new(name: 'ListMailDomainsRequest')
|
154
|
+
ListMailDomainsResponse = Shapes::StructureShape.new(name: 'ListMailDomainsResponse')
|
145
155
|
ListMailboxExportJobsRequest = Shapes::StructureShape.new(name: 'ListMailboxExportJobsRequest')
|
146
156
|
ListMailboxExportJobsResponse = Shapes::StructureShape.new(name: 'ListMailboxExportJobsResponse')
|
147
157
|
ListMailboxPermissionsRequest = Shapes::StructureShape.new(name: 'ListMailboxPermissionsRequest')
|
@@ -160,8 +170,11 @@ module Aws::WorkMail
|
|
160
170
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
161
171
|
ListUsersRequest = Shapes::StructureShape.new(name: 'ListUsersRequest')
|
162
172
|
ListUsersResponse = Shapes::StructureShape.new(name: 'ListUsersResponse')
|
173
|
+
MailDomainInUseException = Shapes::StructureShape.new(name: 'MailDomainInUseException')
|
163
174
|
MailDomainNotFoundException = Shapes::StructureShape.new(name: 'MailDomainNotFoundException')
|
164
175
|
MailDomainStateException = Shapes::StructureShape.new(name: 'MailDomainStateException')
|
176
|
+
MailDomainSummary = Shapes::StructureShape.new(name: 'MailDomainSummary')
|
177
|
+
MailDomains = Shapes::ListShape.new(name: 'MailDomains')
|
165
178
|
MailboxExportErrorInfo = Shapes::StringShape.new(name: 'MailboxExportErrorInfo')
|
166
179
|
MailboxExportJob = Shapes::StructureShape.new(name: 'MailboxExportJob')
|
167
180
|
MailboxExportJobId = Shapes::StringShape.new(name: 'MailboxExportJobId')
|
@@ -207,6 +220,8 @@ module Aws::WorkMail
|
|
207
220
|
PutMobileDeviceAccessOverrideResponse = Shapes::StructureShape.new(name: 'PutMobileDeviceAccessOverrideResponse')
|
208
221
|
PutRetentionPolicyRequest = Shapes::StructureShape.new(name: 'PutRetentionPolicyRequest')
|
209
222
|
PutRetentionPolicyResponse = Shapes::StructureShape.new(name: 'PutRetentionPolicyResponse')
|
223
|
+
RegisterMailDomainRequest = Shapes::StructureShape.new(name: 'RegisterMailDomainRequest')
|
224
|
+
RegisterMailDomainResponse = Shapes::StructureShape.new(name: 'RegisterMailDomainResponse')
|
210
225
|
RegisterToWorkMailRequest = Shapes::StructureShape.new(name: 'RegisterToWorkMailRequest')
|
211
226
|
RegisterToWorkMailResponse = Shapes::StructureShape.new(name: 'RegisterToWorkMailResponse')
|
212
227
|
ReservedNameException = Shapes::StructureShape.new(name: 'ReservedNameException')
|
@@ -240,6 +255,8 @@ module Aws::WorkMail
|
|
240
255
|
UnsupportedOperationException = Shapes::StructureShape.new(name: 'UnsupportedOperationException')
|
241
256
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
242
257
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
258
|
+
UpdateDefaultMailDomainRequest = Shapes::StructureShape.new(name: 'UpdateDefaultMailDomainRequest')
|
259
|
+
UpdateDefaultMailDomainResponse = Shapes::StructureShape.new(name: 'UpdateDefaultMailDomainResponse')
|
243
260
|
UpdateMailboxQuotaRequest = Shapes::StructureShape.new(name: 'UpdateMailboxQuotaRequest')
|
244
261
|
UpdateMailboxQuotaResponse = Shapes::StructureShape.new(name: 'UpdateMailboxQuotaResponse')
|
245
262
|
UpdateMobileDeviceAccessRuleRequest = Shapes::StructureShape.new(name: 'UpdateMobileDeviceAccessRuleRequest')
|
@@ -253,6 +270,7 @@ module Aws::WorkMail
|
|
253
270
|
UserName = Shapes::StringShape.new(name: 'UserName')
|
254
271
|
UserRole = Shapes::StringShape.new(name: 'UserRole')
|
255
272
|
Users = Shapes::ListShape.new(name: 'Users')
|
273
|
+
WorkMailDomainName = Shapes::StringShape.new(name: 'WorkMailDomainName')
|
256
274
|
WorkMailIdentifier = Shapes::StringShape.new(name: 'WorkMailIdentifier')
|
257
275
|
|
258
276
|
AccessControlRule.add_member(:name, Shapes::ShapeRef.new(shape: AccessControlRuleName, location_name: "Name"))
|
@@ -438,6 +456,12 @@ module Aws::WorkMail
|
|
438
456
|
|
439
457
|
DeregisterFromWorkMailResponse.struct_class = Types::DeregisterFromWorkMailResponse
|
440
458
|
|
459
|
+
DeregisterMailDomainRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
460
|
+
DeregisterMailDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: WorkMailDomainName, required: true, location_name: "DomainName"))
|
461
|
+
DeregisterMailDomainRequest.struct_class = Types::DeregisterMailDomainRequest
|
462
|
+
|
463
|
+
DeregisterMailDomainResponse.struct_class = Types::DeregisterMailDomainResponse
|
464
|
+
|
441
465
|
DescribeGroupRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
442
466
|
DescribeGroupRequest.add_member(:group_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "GroupId"))
|
443
467
|
DescribeGroupRequest.struct_class = Types::DescribeGroupRequest
|
@@ -547,6 +571,13 @@ module Aws::WorkMail
|
|
547
571
|
|
548
572
|
DisassociateMemberFromGroupResponse.struct_class = Types::DisassociateMemberFromGroupResponse
|
549
573
|
|
574
|
+
DnsRecord.add_member(:type, Shapes::ShapeRef.new(shape: String, location_name: "Type"))
|
575
|
+
DnsRecord.add_member(:hostname, Shapes::ShapeRef.new(shape: String, location_name: "Hostname"))
|
576
|
+
DnsRecord.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
|
577
|
+
DnsRecord.struct_class = Types::DnsRecord
|
578
|
+
|
579
|
+
DnsRecords.member = Shapes::ShapeRef.new(shape: DnsRecord)
|
580
|
+
|
550
581
|
Domain.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location_name: "DomainName"))
|
551
582
|
Domain.add_member(:hosted_zone_id, Shapes::ShapeRef.new(shape: HostedZoneId, location_name: "HostedZoneId"))
|
552
583
|
Domain.struct_class = Types::Domain
|
@@ -591,6 +622,17 @@ module Aws::WorkMail
|
|
591
622
|
GetDefaultRetentionPolicyResponse.add_member(:folder_configurations, Shapes::ShapeRef.new(shape: FolderConfigurations, location_name: "FolderConfigurations"))
|
592
623
|
GetDefaultRetentionPolicyResponse.struct_class = Types::GetDefaultRetentionPolicyResponse
|
593
624
|
|
625
|
+
GetMailDomainRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
626
|
+
GetMailDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: WorkMailDomainName, required: true, location_name: "DomainName"))
|
627
|
+
GetMailDomainRequest.struct_class = Types::GetMailDomainRequest
|
628
|
+
|
629
|
+
GetMailDomainResponse.add_member(:records, Shapes::ShapeRef.new(shape: DnsRecords, location_name: "Records"))
|
630
|
+
GetMailDomainResponse.add_member(:is_test_domain, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsTestDomain"))
|
631
|
+
GetMailDomainResponse.add_member(:is_default, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsDefault"))
|
632
|
+
GetMailDomainResponse.add_member(:ownership_verification_status, Shapes::ShapeRef.new(shape: DnsRecordVerificationStatus, location_name: "OwnershipVerificationStatus"))
|
633
|
+
GetMailDomainResponse.add_member(:dkim_verification_status, Shapes::ShapeRef.new(shape: DnsRecordVerificationStatus, location_name: "DkimVerificationStatus"))
|
634
|
+
GetMailDomainResponse.struct_class = Types::GetMailDomainResponse
|
635
|
+
|
594
636
|
GetMailboxDetailsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
595
637
|
GetMailboxDetailsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "UserId"))
|
596
638
|
GetMailboxDetailsRequest.struct_class = Types::GetMailboxDetailsRequest
|
@@ -636,6 +678,9 @@ module Aws::WorkMail
|
|
636
678
|
InvalidConfigurationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
637
679
|
InvalidConfigurationException.struct_class = Types::InvalidConfigurationException
|
638
680
|
|
681
|
+
InvalidCustomSesConfigurationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
682
|
+
InvalidCustomSesConfigurationException.struct_class = Types::InvalidCustomSesConfigurationException
|
683
|
+
|
639
684
|
InvalidParameterException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
640
685
|
InvalidParameterException.struct_class = Types::InvalidParameterException
|
641
686
|
|
@@ -684,6 +729,15 @@ module Aws::WorkMail
|
|
684
729
|
ListGroupsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
685
730
|
ListGroupsResponse.struct_class = Types::ListGroupsResponse
|
686
731
|
|
732
|
+
ListMailDomainsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
733
|
+
ListMailDomainsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
734
|
+
ListMailDomainsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
735
|
+
ListMailDomainsRequest.struct_class = Types::ListMailDomainsRequest
|
736
|
+
|
737
|
+
ListMailDomainsResponse.add_member(:mail_domains, Shapes::ShapeRef.new(shape: MailDomains, location_name: "MailDomains"))
|
738
|
+
ListMailDomainsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
739
|
+
ListMailDomainsResponse.struct_class = Types::ListMailDomainsResponse
|
740
|
+
|
687
741
|
ListMailboxExportJobsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
688
742
|
ListMailboxExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
689
743
|
ListMailboxExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
@@ -762,12 +816,21 @@ module Aws::WorkMail
|
|
762
816
|
ListUsersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
763
817
|
ListUsersResponse.struct_class = Types::ListUsersResponse
|
764
818
|
|
819
|
+
MailDomainInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
820
|
+
MailDomainInUseException.struct_class = Types::MailDomainInUseException
|
821
|
+
|
765
822
|
MailDomainNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
766
823
|
MailDomainNotFoundException.struct_class = Types::MailDomainNotFoundException
|
767
824
|
|
768
825
|
MailDomainStateException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
769
826
|
MailDomainStateException.struct_class = Types::MailDomainStateException
|
770
827
|
|
828
|
+
MailDomainSummary.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location_name: "DomainName"))
|
829
|
+
MailDomainSummary.add_member(:default_domain, Shapes::ShapeRef.new(shape: Boolean, location_name: "DefaultDomain"))
|
830
|
+
MailDomainSummary.struct_class = Types::MailDomainSummary
|
831
|
+
|
832
|
+
MailDomains.member = Shapes::ShapeRef.new(shape: MailDomainSummary)
|
833
|
+
|
771
834
|
MailboxExportJob.add_member(:job_id, Shapes::ShapeRef.new(shape: MailboxExportJobId, location_name: "JobId"))
|
772
835
|
MailboxExportJob.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, location_name: "EntityId"))
|
773
836
|
MailboxExportJob.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
@@ -896,6 +959,13 @@ module Aws::WorkMail
|
|
896
959
|
|
897
960
|
PutRetentionPolicyResponse.struct_class = Types::PutRetentionPolicyResponse
|
898
961
|
|
962
|
+
RegisterMailDomainRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
963
|
+
RegisterMailDomainRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
964
|
+
RegisterMailDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: WorkMailDomainName, required: true, location_name: "DomainName"))
|
965
|
+
RegisterMailDomainRequest.struct_class = Types::RegisterMailDomainRequest
|
966
|
+
|
967
|
+
RegisterMailDomainResponse.struct_class = Types::RegisterMailDomainResponse
|
968
|
+
|
899
969
|
RegisterToWorkMailRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
900
970
|
RegisterToWorkMailRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "EntityId"))
|
901
971
|
RegisterToWorkMailRequest.add_member(:email, Shapes::ShapeRef.new(shape: EmailAddress, required: true, location_name: "Email"))
|
@@ -968,6 +1038,12 @@ module Aws::WorkMail
|
|
968
1038
|
|
969
1039
|
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
970
1040
|
|
1041
|
+
UpdateDefaultMailDomainRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
1042
|
+
UpdateDefaultMailDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: WorkMailDomainName, required: true, location_name: "DomainName"))
|
1043
|
+
UpdateDefaultMailDomainRequest.struct_class = Types::UpdateDefaultMailDomainRequest
|
1044
|
+
|
1045
|
+
UpdateDefaultMailDomainResponse.struct_class = Types::UpdateDefaultMailDomainResponse
|
1046
|
+
|
971
1047
|
UpdateMailboxQuotaRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
972
1048
|
UpdateMailboxQuotaRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "UserId"))
|
973
1049
|
UpdateMailboxQuotaRequest.add_member(:mailbox_quota, Shapes::ShapeRef.new(shape: MailboxQuota, required: true, location_name: "MailboxQuota"))
|
@@ -1306,6 +1382,19 @@ module Aws::WorkMail
|
|
1306
1382
|
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1307
1383
|
end)
|
1308
1384
|
|
1385
|
+
api.add_operation(:deregister_mail_domain, Seahorse::Model::Operation.new.tap do |o|
|
1386
|
+
o.name = "DeregisterMailDomain"
|
1387
|
+
o.http_method = "POST"
|
1388
|
+
o.http_request_uri = "/"
|
1389
|
+
o.input = Shapes::ShapeRef.new(shape: DeregisterMailDomainRequest)
|
1390
|
+
o.output = Shapes::ShapeRef.new(shape: DeregisterMailDomainResponse)
|
1391
|
+
o.errors << Shapes::ShapeRef.new(shape: MailDomainInUseException)
|
1392
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1393
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1394
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1395
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidCustomSesConfigurationException)
|
1396
|
+
end)
|
1397
|
+
|
1309
1398
|
api.add_operation(:describe_group, Seahorse::Model::Operation.new.tap do |o|
|
1310
1399
|
o.name = "DescribeGroup"
|
1311
1400
|
o.http_method = "POST"
|
@@ -1427,6 +1516,18 @@ module Aws::WorkMail
|
|
1427
1516
|
o.errors << Shapes::ShapeRef.new(shape: EntityNotFoundException)
|
1428
1517
|
end)
|
1429
1518
|
|
1519
|
+
api.add_operation(:get_mail_domain, Seahorse::Model::Operation.new.tap do |o|
|
1520
|
+
o.name = "GetMailDomain"
|
1521
|
+
o.http_method = "POST"
|
1522
|
+
o.http_request_uri = "/"
|
1523
|
+
o.input = Shapes::ShapeRef.new(shape: GetMailDomainRequest)
|
1524
|
+
o.output = Shapes::ShapeRef.new(shape: GetMailDomainResponse)
|
1525
|
+
o.errors << Shapes::ShapeRef.new(shape: MailDomainNotFoundException)
|
1526
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1527
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1528
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1529
|
+
end)
|
1530
|
+
|
1430
1531
|
api.add_operation(:get_mailbox_details, Seahorse::Model::Operation.new.tap do |o|
|
1431
1532
|
o.name = "GetMailboxDetails"
|
1432
1533
|
o.http_method = "POST"
|
@@ -1528,6 +1629,23 @@ module Aws::WorkMail
|
|
1528
1629
|
)
|
1529
1630
|
end)
|
1530
1631
|
|
1632
|
+
api.add_operation(:list_mail_domains, Seahorse::Model::Operation.new.tap do |o|
|
1633
|
+
o.name = "ListMailDomains"
|
1634
|
+
o.http_method = "POST"
|
1635
|
+
o.http_request_uri = "/"
|
1636
|
+
o.input = Shapes::ShapeRef.new(shape: ListMailDomainsRequest)
|
1637
|
+
o.output = Shapes::ShapeRef.new(shape: ListMailDomainsResponse)
|
1638
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1639
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1640
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1641
|
+
o[:pager] = Aws::Pager.new(
|
1642
|
+
limit_key: "max_results",
|
1643
|
+
tokens: {
|
1644
|
+
"next_token" => "next_token"
|
1645
|
+
}
|
1646
|
+
)
|
1647
|
+
end)
|
1648
|
+
|
1531
1649
|
api.add_operation(:list_mailbox_export_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1532
1650
|
o.name = "ListMailboxExportJobs"
|
1533
1651
|
o.http_method = "POST"
|
@@ -1730,6 +1848,19 @@ module Aws::WorkMail
|
|
1730
1848
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1731
1849
|
end)
|
1732
1850
|
|
1851
|
+
api.add_operation(:register_mail_domain, Seahorse::Model::Operation.new.tap do |o|
|
1852
|
+
o.name = "RegisterMailDomain"
|
1853
|
+
o.http_method = "POST"
|
1854
|
+
o.http_request_uri = "/"
|
1855
|
+
o.input = Shapes::ShapeRef.new(shape: RegisterMailDomainRequest)
|
1856
|
+
o.output = Shapes::ShapeRef.new(shape: RegisterMailDomainResponse)
|
1857
|
+
o.errors << Shapes::ShapeRef.new(shape: MailDomainInUseException)
|
1858
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1859
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1860
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1861
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1862
|
+
end)
|
1863
|
+
|
1733
1864
|
api.add_operation(:register_to_work_mail, Seahorse::Model::Operation.new.tap do |o|
|
1734
1865
|
o.name = "RegisterToWorkMail"
|
1735
1866
|
o.http_method = "POST"
|
@@ -1799,6 +1930,19 @@ module Aws::WorkMail
|
|
1799
1930
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1800
1931
|
end)
|
1801
1932
|
|
1933
|
+
api.add_operation(:update_default_mail_domain, Seahorse::Model::Operation.new.tap do |o|
|
1934
|
+
o.name = "UpdateDefaultMailDomain"
|
1935
|
+
o.http_method = "POST"
|
1936
|
+
o.http_request_uri = "/"
|
1937
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateDefaultMailDomainRequest)
|
1938
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateDefaultMailDomainResponse)
|
1939
|
+
o.errors << Shapes::ShapeRef.new(shape: MailDomainNotFoundException)
|
1940
|
+
o.errors << Shapes::ShapeRef.new(shape: MailDomainStateException)
|
1941
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1942
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1943
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1944
|
+
end)
|
1945
|
+
|
1802
1946
|
api.add_operation(:update_mailbox_quota, Seahorse::Model::Operation.new.tap do |o|
|
1803
1947
|
o.name = "UpdateMailboxQuota"
|
1804
1948
|
o.http_method = "POST"
|
@@ -35,9 +35,11 @@ module Aws::WorkMail
|
|
35
35
|
# * {EntityNotFoundException}
|
36
36
|
# * {EntityStateException}
|
37
37
|
# * {InvalidConfigurationException}
|
38
|
+
# * {InvalidCustomSesConfigurationException}
|
38
39
|
# * {InvalidParameterException}
|
39
40
|
# * {InvalidPasswordException}
|
40
41
|
# * {LimitExceededException}
|
42
|
+
# * {MailDomainInUseException}
|
41
43
|
# * {MailDomainNotFoundException}
|
42
44
|
# * {MailDomainStateException}
|
43
45
|
# * {NameAvailabilityException}
|
@@ -174,6 +176,21 @@ module Aws::WorkMail
|
|
174
176
|
end
|
175
177
|
end
|
176
178
|
|
179
|
+
class InvalidCustomSesConfigurationException < ServiceError
|
180
|
+
|
181
|
+
# @param [Seahorse::Client::RequestContext] context
|
182
|
+
# @param [String] message
|
183
|
+
# @param [Aws::WorkMail::Types::InvalidCustomSesConfigurationException] data
|
184
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
185
|
+
super(context, message, data)
|
186
|
+
end
|
187
|
+
|
188
|
+
# @return [String]
|
189
|
+
def message
|
190
|
+
@message || @data[:message]
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
177
194
|
class InvalidParameterException < ServiceError
|
178
195
|
|
179
196
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -219,6 +236,21 @@ module Aws::WorkMail
|
|
219
236
|
end
|
220
237
|
end
|
221
238
|
|
239
|
+
class MailDomainInUseException < ServiceError
|
240
|
+
|
241
|
+
# @param [Seahorse::Client::RequestContext] context
|
242
|
+
# @param [String] message
|
243
|
+
# @param [Aws::WorkMail::Types::MailDomainInUseException] data
|
244
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
245
|
+
super(context, message, data)
|
246
|
+
end
|
247
|
+
|
248
|
+
# @return [String]
|
249
|
+
def message
|
250
|
+
@message || @data[:message]
|
251
|
+
end
|
252
|
+
end
|
253
|
+
|
222
254
|
class MailDomainNotFoundException < ServiceError
|
223
255
|
|
224
256
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -973,6 +973,36 @@ module Aws::WorkMail
|
|
973
973
|
#
|
974
974
|
class DeregisterFromWorkMailResponse < Aws::EmptyStructure; end
|
975
975
|
|
976
|
+
# @note When making an API call, you may pass DeregisterMailDomainRequest
|
977
|
+
# data as a hash:
|
978
|
+
#
|
979
|
+
# {
|
980
|
+
# organization_id: "OrganizationId", # required
|
981
|
+
# domain_name: "WorkMailDomainName", # required
|
982
|
+
# }
|
983
|
+
#
|
984
|
+
# @!attribute [rw] organization_id
|
985
|
+
# The Amazon WorkMail organization for which the domain will be
|
986
|
+
# deregistered.
|
987
|
+
# @return [String]
|
988
|
+
#
|
989
|
+
# @!attribute [rw] domain_name
|
990
|
+
# The domain to deregister in WorkMail and SES.
|
991
|
+
# @return [String]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterMailDomainRequest AWS API Documentation
|
994
|
+
#
|
995
|
+
class DeregisterMailDomainRequest < Struct.new(
|
996
|
+
:organization_id,
|
997
|
+
:domain_name)
|
998
|
+
SENSITIVE = []
|
999
|
+
include Aws::Structure
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterMailDomainResponse AWS API Documentation
|
1003
|
+
#
|
1004
|
+
class DeregisterMailDomainResponse < Aws::EmptyStructure; end
|
1005
|
+
|
976
1006
|
# @note When making an API call, you may pass DescribeGroupRequest
|
977
1007
|
# data as a hash:
|
978
1008
|
#
|
@@ -1511,6 +1541,31 @@ module Aws::WorkMail
|
|
1511
1541
|
#
|
1512
1542
|
class DisassociateMemberFromGroupResponse < Aws::EmptyStructure; end
|
1513
1543
|
|
1544
|
+
# A DNS record uploaded to your DNS provider.
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] type
|
1547
|
+
# The RFC 1035 record type. Possible values: `CNAME`, `A`, `MX`.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] hostname
|
1551
|
+
# The DNS hostname.- For example, `domain.example.com`.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] value
|
1555
|
+
# The value returned by the DNS for a query to that hostname and
|
1556
|
+
# record type.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DnsRecord AWS API Documentation
|
1560
|
+
#
|
1561
|
+
class DnsRecord < Struct.new(
|
1562
|
+
:type,
|
1563
|
+
:hostname,
|
1564
|
+
:value)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1514
1569
|
# The domain to associate with an Amazon WorkMail organization.
|
1515
1570
|
#
|
1516
1571
|
# When you configure a domain hosted in Amazon Route 53 (Route 53), all
|
@@ -1626,8 +1681,8 @@ module Aws::WorkMail
|
|
1626
1681
|
# @return [String]
|
1627
1682
|
#
|
1628
1683
|
# @!attribute [rw] period
|
1629
|
-
# The
|
1630
|
-
#
|
1684
|
+
# The number of days for which the folder-configuration action
|
1685
|
+
# applies.
|
1631
1686
|
# @return [Integer]
|
1632
1687
|
#
|
1633
1688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/FolderConfiguration AWS API Documentation
|
@@ -1742,6 +1797,68 @@ module Aws::WorkMail
|
|
1742
1797
|
include Aws::Structure
|
1743
1798
|
end
|
1744
1799
|
|
1800
|
+
# @note When making an API call, you may pass GetMailDomainRequest
|
1801
|
+
# data as a hash:
|
1802
|
+
#
|
1803
|
+
# {
|
1804
|
+
# organization_id: "OrganizationId", # required
|
1805
|
+
# domain_name: "WorkMailDomainName", # required
|
1806
|
+
# }
|
1807
|
+
#
|
1808
|
+
# @!attribute [rw] organization_id
|
1809
|
+
# The Amazon WorkMail organization for which the domain is retrieved.
|
1810
|
+
# @return [String]
|
1811
|
+
#
|
1812
|
+
# @!attribute [rw] domain_name
|
1813
|
+
# The domain from which you want to retrieve details.
|
1814
|
+
# @return [String]
|
1815
|
+
#
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailDomainRequest AWS API Documentation
|
1817
|
+
#
|
1818
|
+
class GetMailDomainRequest < Struct.new(
|
1819
|
+
:organization_id,
|
1820
|
+
:domain_name)
|
1821
|
+
SENSITIVE = []
|
1822
|
+
include Aws::Structure
|
1823
|
+
end
|
1824
|
+
|
1825
|
+
# @!attribute [rw] records
|
1826
|
+
# A list of the DNS records that Amazon WorkMail recommends adding in
|
1827
|
+
# your DNS provider for the best user experience. The records
|
1828
|
+
# configure your domain with DMARC, SPF, DKIM, and direct incoming
|
1829
|
+
# email traffic to SES. See admin guide for more details.
|
1830
|
+
# @return [Array<Types::DnsRecord>]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] is_test_domain
|
1833
|
+
# Specifies whether the domain is a test domain provided by WorkMail,
|
1834
|
+
# or a custom domain.
|
1835
|
+
# @return [Boolean]
|
1836
|
+
#
|
1837
|
+
# @!attribute [rw] is_default
|
1838
|
+
# Specifies whether the domain is the default domain for your
|
1839
|
+
# organization.
|
1840
|
+
# @return [Boolean]
|
1841
|
+
#
|
1842
|
+
# @!attribute [rw] ownership_verification_status
|
1843
|
+
# Indicates the status of the domain ownership verification.
|
1844
|
+
# @return [String]
|
1845
|
+
#
|
1846
|
+
# @!attribute [rw] dkim_verification_status
|
1847
|
+
# Indicates the status of a DKIM verification.
|
1848
|
+
# @return [String]
|
1849
|
+
#
|
1850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailDomainResponse AWS API Documentation
|
1851
|
+
#
|
1852
|
+
class GetMailDomainResponse < Struct.new(
|
1853
|
+
:records,
|
1854
|
+
:is_test_domain,
|
1855
|
+
:is_default,
|
1856
|
+
:ownership_verification_status,
|
1857
|
+
:dkim_verification_status)
|
1858
|
+
SENSITIVE = []
|
1859
|
+
include Aws::Structure
|
1860
|
+
end
|
1861
|
+
|
1745
1862
|
# @note When making an API call, you may pass GetMailboxDetailsRequest
|
1746
1863
|
# data as a hash:
|
1747
1864
|
#
|
@@ -1983,6 +2100,25 @@ module Aws::WorkMail
|
|
1983
2100
|
include Aws::Structure
|
1984
2101
|
end
|
1985
2102
|
|
2103
|
+
# You SES configuration has customizations that Amazon WorkMail cannot
|
2104
|
+
# save. The error message lists the invalid setting. For examples of
|
2105
|
+
# invalid settings, refer to [CreateReceiptRule][1].
|
2106
|
+
#
|
2107
|
+
#
|
2108
|
+
#
|
2109
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] message
|
2112
|
+
# @return [String]
|
2113
|
+
#
|
2114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/InvalidCustomSesConfigurationException AWS API Documentation
|
2115
|
+
#
|
2116
|
+
class InvalidCustomSesConfigurationException < Struct.new(
|
2117
|
+
:message)
|
2118
|
+
SENSITIVE = []
|
2119
|
+
include Aws::Structure
|
2120
|
+
end
|
2121
|
+
|
1986
2122
|
# One or more of the input parameters don't match the service's
|
1987
2123
|
# restrictions.
|
1988
2124
|
#
|
@@ -2218,6 +2354,58 @@ module Aws::WorkMail
|
|
2218
2354
|
include Aws::Structure
|
2219
2355
|
end
|
2220
2356
|
|
2357
|
+
# @note When making an API call, you may pass ListMailDomainsRequest
|
2358
|
+
# data as a hash:
|
2359
|
+
#
|
2360
|
+
# {
|
2361
|
+
# organization_id: "OrganizationId", # required
|
2362
|
+
# max_results: 1,
|
2363
|
+
# next_token: "NextToken",
|
2364
|
+
# }
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] organization_id
|
2367
|
+
# The Amazon WorkMail organization for which to list domains.
|
2368
|
+
# @return [String]
|
2369
|
+
#
|
2370
|
+
# @!attribute [rw] max_results
|
2371
|
+
# The maximum number of results to return in a single call.
|
2372
|
+
# @return [Integer]
|
2373
|
+
#
|
2374
|
+
# @!attribute [rw] next_token
|
2375
|
+
# The token to use to retrieve the next page of results. The first
|
2376
|
+
# call does not require a token.
|
2377
|
+
# @return [String]
|
2378
|
+
#
|
2379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailDomainsRequest AWS API Documentation
|
2380
|
+
#
|
2381
|
+
class ListMailDomainsRequest < Struct.new(
|
2382
|
+
:organization_id,
|
2383
|
+
:max_results,
|
2384
|
+
:next_token)
|
2385
|
+
SENSITIVE = []
|
2386
|
+
include Aws::Structure
|
2387
|
+
end
|
2388
|
+
|
2389
|
+
# @!attribute [rw] mail_domains
|
2390
|
+
# The list of mail domain summaries, specifying domains that exist in
|
2391
|
+
# the specified Amazon WorkMail organization, along with the
|
2392
|
+
# information about whether the domain is or isn't the default.
|
2393
|
+
# @return [Array<Types::MailDomainSummary>]
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] next_token
|
2396
|
+
# The token to use to retrieve the next page of results. The value
|
2397
|
+
# becomes `null` when there are no more results to return.
|
2398
|
+
# @return [String]
|
2399
|
+
#
|
2400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailDomainsResponse AWS API Documentation
|
2401
|
+
#
|
2402
|
+
class ListMailDomainsResponse < Struct.new(
|
2403
|
+
:mail_domains,
|
2404
|
+
:next_token)
|
2405
|
+
SENSITIVE = []
|
2406
|
+
include Aws::Structure
|
2407
|
+
end
|
2408
|
+
|
2221
2409
|
# @note When making an API call, you may pass ListMailboxExportJobsRequest
|
2222
2410
|
# data as a hash:
|
2223
2411
|
#
|
@@ -2663,8 +2851,21 @@ module Aws::WorkMail
|
|
2663
2851
|
include Aws::Structure
|
2664
2852
|
end
|
2665
2853
|
|
2666
|
-
#
|
2667
|
-
#
|
2854
|
+
# The domain you're trying to change is in use by another user or
|
2855
|
+
# organization in your account. See the error message for details.
|
2856
|
+
#
|
2857
|
+
# @!attribute [rw] message
|
2858
|
+
# @return [String]
|
2859
|
+
#
|
2860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/MailDomainInUseException AWS API Documentation
|
2861
|
+
#
|
2862
|
+
class MailDomainInUseException < Struct.new(
|
2863
|
+
:message)
|
2864
|
+
SENSITIVE = []
|
2865
|
+
include Aws::Structure
|
2866
|
+
end
|
2867
|
+
|
2868
|
+
# The domain specified is not found in your organization.
|
2668
2869
|
#
|
2669
2870
|
# @!attribute [rw] message
|
2670
2871
|
# @return [String]
|
@@ -2691,6 +2892,25 @@ module Aws::WorkMail
|
|
2691
2892
|
include Aws::Structure
|
2692
2893
|
end
|
2693
2894
|
|
2895
|
+
# The data for a given domain.
|
2896
|
+
#
|
2897
|
+
# @!attribute [rw] domain_name
|
2898
|
+
# The domain name.
|
2899
|
+
# @return [String]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] default_domain
|
2902
|
+
# Whether the domain is default or not.
|
2903
|
+
# @return [Boolean]
|
2904
|
+
#
|
2905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/MailDomainSummary AWS API Documentation
|
2906
|
+
#
|
2907
|
+
class MailDomainSummary < Struct.new(
|
2908
|
+
:domain_name,
|
2909
|
+
:default_domain)
|
2910
|
+
SENSITIVE = []
|
2911
|
+
include Aws::Structure
|
2912
|
+
end
|
2913
|
+
|
2694
2914
|
# The details of a mailbox export job, including the user or resource ID
|
2695
2915
|
# associated with the mailbox and the S3 bucket that the mailbox
|
2696
2916
|
# contents are exported to.
|
@@ -3314,6 +3534,45 @@ module Aws::WorkMail
|
|
3314
3534
|
#
|
3315
3535
|
class PutRetentionPolicyResponse < Aws::EmptyStructure; end
|
3316
3536
|
|
3537
|
+
# @note When making an API call, you may pass RegisterMailDomainRequest
|
3538
|
+
# data as a hash:
|
3539
|
+
#
|
3540
|
+
# {
|
3541
|
+
# client_token: "IdempotencyClientToken",
|
3542
|
+
# organization_id: "OrganizationId", # required
|
3543
|
+
# domain_name: "WorkMailDomainName", # required
|
3544
|
+
# }
|
3545
|
+
#
|
3546
|
+
# @!attribute [rw] client_token
|
3547
|
+
# Idempotency token used when retrying requests.
|
3548
|
+
#
|
3549
|
+
# **A suitable default value is auto-generated.** You should normally
|
3550
|
+
# not need to pass this option.
|
3551
|
+
# @return [String]
|
3552
|
+
#
|
3553
|
+
# @!attribute [rw] organization_id
|
3554
|
+
# The Amazon WorkMail organization under which you're creating the
|
3555
|
+
# domain.
|
3556
|
+
# @return [String]
|
3557
|
+
#
|
3558
|
+
# @!attribute [rw] domain_name
|
3559
|
+
# The name of the mail domain to create in Amazon WorkMail and SES.
|
3560
|
+
# @return [String]
|
3561
|
+
#
|
3562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterMailDomainRequest AWS API Documentation
|
3563
|
+
#
|
3564
|
+
class RegisterMailDomainRequest < Struct.new(
|
3565
|
+
:client_token,
|
3566
|
+
:organization_id,
|
3567
|
+
:domain_name)
|
3568
|
+
SENSITIVE = []
|
3569
|
+
include Aws::Structure
|
3570
|
+
end
|
3571
|
+
|
3572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterMailDomainResponse AWS API Documentation
|
3573
|
+
#
|
3574
|
+
class RegisterMailDomainResponse < Aws::EmptyStructure; end
|
3575
|
+
|
3317
3576
|
# @note When making an API call, you may pass RegisterToWorkMailRequest
|
3318
3577
|
# data as a hash:
|
3319
3578
|
#
|
@@ -3653,6 +3912,35 @@ module Aws::WorkMail
|
|
3653
3912
|
#
|
3654
3913
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3655
3914
|
|
3915
|
+
# @note When making an API call, you may pass UpdateDefaultMailDomainRequest
|
3916
|
+
# data as a hash:
|
3917
|
+
#
|
3918
|
+
# {
|
3919
|
+
# organization_id: "OrganizationId", # required
|
3920
|
+
# domain_name: "WorkMailDomainName", # required
|
3921
|
+
# }
|
3922
|
+
#
|
3923
|
+
# @!attribute [rw] organization_id
|
3924
|
+
# The Amazon WorkMail organization for which to list domains.
|
3925
|
+
# @return [String]
|
3926
|
+
#
|
3927
|
+
# @!attribute [rw] domain_name
|
3928
|
+
# The domain name that will become the default domain.
|
3929
|
+
# @return [String]
|
3930
|
+
#
|
3931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateDefaultMailDomainRequest AWS API Documentation
|
3932
|
+
#
|
3933
|
+
class UpdateDefaultMailDomainRequest < Struct.new(
|
3934
|
+
:organization_id,
|
3935
|
+
:domain_name)
|
3936
|
+
SENSITIVE = []
|
3937
|
+
include Aws::Structure
|
3938
|
+
end
|
3939
|
+
|
3940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateDefaultMailDomainResponse AWS API Documentation
|
3941
|
+
#
|
3942
|
+
class UpdateDefaultMailDomainResponse < Aws::EmptyStructure; end
|
3943
|
+
|
3656
3944
|
# @note When making an API call, you may pass UpdateMailboxQuotaRequest
|
3657
3945
|
# data as a hash:
|
3658
3946
|
#
|
data/lib/aws-sdk-workmail.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-workmail
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.43.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-10-
|
11
|
+
date: 2021-10-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|