aws-sdk-workmail 1.40.0 → 1.44.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workmail/client.rb +469 -1
- data/lib/aws-sdk-workmail/client_api.rb +299 -0
- data/lib/aws-sdk-workmail/errors.rb +32 -0
- data/lib/aws-sdk-workmail/types.rb +644 -4
- data/lib/aws-sdk-workmail.rb +1 -1
- metadata +4 -4
@@ -728,6 +728,51 @@ module Aws::WorkMail
|
|
728
728
|
#
|
729
729
|
class DeleteMailboxPermissionsResponse < Aws::EmptyStructure; end
|
730
730
|
|
731
|
+
# @note When making an API call, you may pass DeleteMobileDeviceAccessOverrideRequest
|
732
|
+
# data as a hash:
|
733
|
+
#
|
734
|
+
# {
|
735
|
+
# organization_id: "OrganizationId", # required
|
736
|
+
# user_id: "EntityIdentifier", # required
|
737
|
+
# device_id: "DeviceId", # required
|
738
|
+
# }
|
739
|
+
#
|
740
|
+
# @!attribute [rw] organization_id
|
741
|
+
# The Amazon WorkMail organization for which the access override will
|
742
|
+
# be deleted.
|
743
|
+
# @return [String]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] user_id
|
746
|
+
# The WorkMail user for which you want to delete the override. Accepts
|
747
|
+
# the following types of user identities:
|
748
|
+
#
|
749
|
+
# * User ID: `12345678-1234-1234-1234-123456789012` or
|
750
|
+
# `S-1-1-12-1234567890-123456789-123456789-1234`
|
751
|
+
#
|
752
|
+
# * Email address: `user@domain.tld`
|
753
|
+
#
|
754
|
+
# * User name: `user`
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] device_id
|
758
|
+
# The mobile device for which you delete the override. `DeviceId` is
|
759
|
+
# case insensitive.
|
760
|
+
# @return [String]
|
761
|
+
#
|
762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessOverrideRequest AWS API Documentation
|
763
|
+
#
|
764
|
+
class DeleteMobileDeviceAccessOverrideRequest < Struct.new(
|
765
|
+
:organization_id,
|
766
|
+
:user_id,
|
767
|
+
:device_id)
|
768
|
+
SENSITIVE = []
|
769
|
+
include Aws::Structure
|
770
|
+
end
|
771
|
+
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessOverrideResponse AWS API Documentation
|
773
|
+
#
|
774
|
+
class DeleteMobileDeviceAccessOverrideResponse < Aws::EmptyStructure; end
|
775
|
+
|
731
776
|
# @note When making an API call, you may pass DeleteMobileDeviceAccessRuleRequest
|
732
777
|
# data as a hash:
|
733
778
|
#
|
@@ -928,6 +973,36 @@ module Aws::WorkMail
|
|
928
973
|
#
|
929
974
|
class DeregisterFromWorkMailResponse < Aws::EmptyStructure; end
|
930
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
|
+
|
931
1006
|
# @note When making an API call, you may pass DescribeGroupRequest
|
932
1007
|
# data as a hash:
|
933
1008
|
#
|
@@ -993,6 +1068,37 @@ module Aws::WorkMail
|
|
993
1068
|
include Aws::Structure
|
994
1069
|
end
|
995
1070
|
|
1071
|
+
# @note When making an API call, you may pass DescribeInboundDmarcSettingsRequest
|
1072
|
+
# data as a hash:
|
1073
|
+
#
|
1074
|
+
# {
|
1075
|
+
# organization_id: "OrganizationId", # required
|
1076
|
+
# }
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] organization_id
|
1079
|
+
# Lists the ID of the given organization.
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeInboundDmarcSettingsRequest AWS API Documentation
|
1083
|
+
#
|
1084
|
+
class DescribeInboundDmarcSettingsRequest < Struct.new(
|
1085
|
+
:organization_id)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# @!attribute [rw] enforced
|
1091
|
+
# Lists the enforcement setting of the applied policy.
|
1092
|
+
# @return [Boolean]
|
1093
|
+
#
|
1094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeInboundDmarcSettingsResponse AWS API Documentation
|
1095
|
+
#
|
1096
|
+
class DescribeInboundDmarcSettingsResponse < Struct.new(
|
1097
|
+
:enforced)
|
1098
|
+
SENSITIVE = []
|
1099
|
+
include Aws::Structure
|
1100
|
+
end
|
1101
|
+
|
996
1102
|
# @note When making an API call, you may pass DescribeMailboxExportJobRequest
|
997
1103
|
# data as a hash:
|
998
1104
|
#
|
@@ -1435,6 +1541,31 @@ module Aws::WorkMail
|
|
1435
1541
|
#
|
1436
1542
|
class DisassociateMemberFromGroupResponse < Aws::EmptyStructure; end
|
1437
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
|
+
|
1438
1569
|
# The domain to associate with an Amazon WorkMail organization.
|
1439
1570
|
#
|
1440
1571
|
# When you configure a domain hosted in Amazon Route 53 (Route 53), all
|
@@ -1550,8 +1681,8 @@ module Aws::WorkMail
|
|
1550
1681
|
# @return [String]
|
1551
1682
|
#
|
1552
1683
|
# @!attribute [rw] period
|
1553
|
-
# The
|
1554
|
-
#
|
1684
|
+
# The number of days for which the folder-configuration action
|
1685
|
+
# applies.
|
1555
1686
|
# @return [Integer]
|
1556
1687
|
#
|
1557
1688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/FolderConfiguration AWS API Documentation
|
@@ -1666,6 +1797,68 @@ module Aws::WorkMail
|
|
1666
1797
|
include Aws::Structure
|
1667
1798
|
end
|
1668
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
|
+
|
1669
1862
|
# @note When making an API call, you may pass GetMailboxDetailsRequest
|
1670
1863
|
# data as a hash:
|
1671
1864
|
#
|
@@ -1773,6 +1966,84 @@ module Aws::WorkMail
|
|
1773
1966
|
include Aws::Structure
|
1774
1967
|
end
|
1775
1968
|
|
1969
|
+
# @note When making an API call, you may pass GetMobileDeviceAccessOverrideRequest
|
1970
|
+
# data as a hash:
|
1971
|
+
#
|
1972
|
+
# {
|
1973
|
+
# organization_id: "OrganizationId", # required
|
1974
|
+
# user_id: "EntityIdentifier", # required
|
1975
|
+
# device_id: "DeviceId", # required
|
1976
|
+
# }
|
1977
|
+
#
|
1978
|
+
# @!attribute [rw] organization_id
|
1979
|
+
# The Amazon WorkMail organization to which you want to apply the
|
1980
|
+
# override.
|
1981
|
+
# @return [String]
|
1982
|
+
#
|
1983
|
+
# @!attribute [rw] user_id
|
1984
|
+
# Identifies the WorkMail user for the override. Accepts the following
|
1985
|
+
# types of user identities:
|
1986
|
+
#
|
1987
|
+
# * User ID: `12345678-1234-1234-1234-123456789012` or
|
1988
|
+
# `S-1-1-12-1234567890-123456789-123456789-1234`
|
1989
|
+
#
|
1990
|
+
# * Email address: `user@domain.tld`
|
1991
|
+
#
|
1992
|
+
# * User name: `user`
|
1993
|
+
# @return [String]
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] device_id
|
1996
|
+
# The mobile device to which the override applies. `DeviceId` is case
|
1997
|
+
# insensitive.
|
1998
|
+
# @return [String]
|
1999
|
+
#
|
2000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessOverrideRequest AWS API Documentation
|
2001
|
+
#
|
2002
|
+
class GetMobileDeviceAccessOverrideRequest < Struct.new(
|
2003
|
+
:organization_id,
|
2004
|
+
:user_id,
|
2005
|
+
:device_id)
|
2006
|
+
SENSITIVE = []
|
2007
|
+
include Aws::Structure
|
2008
|
+
end
|
2009
|
+
|
2010
|
+
# @!attribute [rw] user_id
|
2011
|
+
# The WorkMail user to which the access override applies.
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] device_id
|
2015
|
+
# The device to which the access override applies.
|
2016
|
+
# @return [String]
|
2017
|
+
#
|
2018
|
+
# @!attribute [rw] effect
|
2019
|
+
# The effect of the override, `ALLOW` or `DENY`.
|
2020
|
+
# @return [String]
|
2021
|
+
#
|
2022
|
+
# @!attribute [rw] description
|
2023
|
+
# A description of the override.
|
2024
|
+
# @return [String]
|
2025
|
+
#
|
2026
|
+
# @!attribute [rw] date_created
|
2027
|
+
# The date the override was first created.
|
2028
|
+
# @return [Time]
|
2029
|
+
#
|
2030
|
+
# @!attribute [rw] date_modified
|
2031
|
+
# The date the description was last modified.
|
2032
|
+
# @return [Time]
|
2033
|
+
#
|
2034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessOverrideResponse AWS API Documentation
|
2035
|
+
#
|
2036
|
+
class GetMobileDeviceAccessOverrideResponse < Struct.new(
|
2037
|
+
:user_id,
|
2038
|
+
:device_id,
|
2039
|
+
:effect,
|
2040
|
+
:description,
|
2041
|
+
:date_created,
|
2042
|
+
:date_modified)
|
2043
|
+
SENSITIVE = []
|
2044
|
+
include Aws::Structure
|
2045
|
+
end
|
2046
|
+
|
1776
2047
|
# The representation of an Amazon WorkMail group.
|
1777
2048
|
#
|
1778
2049
|
# @!attribute [rw] id
|
@@ -1829,6 +2100,25 @@ module Aws::WorkMail
|
|
1829
2100
|
include Aws::Structure
|
1830
2101
|
end
|
1831
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
|
+
|
1832
2122
|
# One or more of the input parameters don't match the service's
|
1833
2123
|
# restrictions.
|
1834
2124
|
#
|
@@ -2064,6 +2354,58 @@ module Aws::WorkMail
|
|
2064
2354
|
include Aws::Structure
|
2065
2355
|
end
|
2066
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
|
+
|
2067
2409
|
# @note When making an API call, you may pass ListMailboxExportJobsRequest
|
2068
2410
|
# data as a hash:
|
2069
2411
|
#
|
@@ -2170,6 +2512,78 @@ module Aws::WorkMail
|
|
2170
2512
|
include Aws::Structure
|
2171
2513
|
end
|
2172
2514
|
|
2515
|
+
# @note When making an API call, you may pass ListMobileDeviceAccessOverridesRequest
|
2516
|
+
# data as a hash:
|
2517
|
+
#
|
2518
|
+
# {
|
2519
|
+
# organization_id: "OrganizationId", # required
|
2520
|
+
# user_id: "EntityIdentifier",
|
2521
|
+
# device_id: "DeviceId",
|
2522
|
+
# next_token: "NextToken",
|
2523
|
+
# max_results: 1,
|
2524
|
+
# }
|
2525
|
+
#
|
2526
|
+
# @!attribute [rw] organization_id
|
2527
|
+
# The Amazon WorkMail organization under which to list mobile device
|
2528
|
+
# access overrides.
|
2529
|
+
# @return [String]
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] user_id
|
2532
|
+
# The WorkMail user under which you list the mobile device access
|
2533
|
+
# overrides. Accepts the following types of user identities:
|
2534
|
+
#
|
2535
|
+
# * User ID: `12345678-1234-1234-1234-123456789012` or
|
2536
|
+
# `S-1-1-12-1234567890-123456789-123456789-1234`
|
2537
|
+
#
|
2538
|
+
# * Email address: `user@domain.tld`
|
2539
|
+
#
|
2540
|
+
# * User name: `user`
|
2541
|
+
# @return [String]
|
2542
|
+
#
|
2543
|
+
# @!attribute [rw] device_id
|
2544
|
+
# The mobile device to which the access override applies.
|
2545
|
+
# @return [String]
|
2546
|
+
#
|
2547
|
+
# @!attribute [rw] next_token
|
2548
|
+
# The token to use to retrieve the next page of results. The first
|
2549
|
+
# call does not require a token.
|
2550
|
+
# @return [String]
|
2551
|
+
#
|
2552
|
+
# @!attribute [rw] max_results
|
2553
|
+
# The maximum number of results to return in a single call.
|
2554
|
+
# @return [Integer]
|
2555
|
+
#
|
2556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessOverridesRequest AWS API Documentation
|
2557
|
+
#
|
2558
|
+
class ListMobileDeviceAccessOverridesRequest < Struct.new(
|
2559
|
+
:organization_id,
|
2560
|
+
:user_id,
|
2561
|
+
:device_id,
|
2562
|
+
:next_token,
|
2563
|
+
:max_results)
|
2564
|
+
SENSITIVE = []
|
2565
|
+
include Aws::Structure
|
2566
|
+
end
|
2567
|
+
|
2568
|
+
# @!attribute [rw] overrides
|
2569
|
+
# The list of mobile device access overrides that exist for the
|
2570
|
+
# specified Amazon WorkMail organization and user.
|
2571
|
+
# @return [Array<Types::MobileDeviceAccessOverride>]
|
2572
|
+
#
|
2573
|
+
# @!attribute [rw] next_token
|
2574
|
+
# The token to use to retrieve the next page of results. The value is
|
2575
|
+
# “null” when there are no more results to return.
|
2576
|
+
# @return [String]
|
2577
|
+
#
|
2578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessOverridesResponse AWS API Documentation
|
2579
|
+
#
|
2580
|
+
class ListMobileDeviceAccessOverridesResponse < Struct.new(
|
2581
|
+
:overrides,
|
2582
|
+
:next_token)
|
2583
|
+
SENSITIVE = []
|
2584
|
+
include Aws::Structure
|
2585
|
+
end
|
2586
|
+
|
2173
2587
|
# @note When making an API call, you may pass ListMobileDeviceAccessRulesRequest
|
2174
2588
|
# data as a hash:
|
2175
2589
|
#
|
@@ -2437,8 +2851,21 @@ module Aws::WorkMail
|
|
2437
2851
|
include Aws::Structure
|
2438
2852
|
end
|
2439
2853
|
|
2440
|
-
#
|
2441
|
-
#
|
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.
|
2442
2869
|
#
|
2443
2870
|
# @!attribute [rw] message
|
2444
2871
|
# @return [String]
|
@@ -2465,6 +2892,25 @@ module Aws::WorkMail
|
|
2465
2892
|
include Aws::Structure
|
2466
2893
|
end
|
2467
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
|
+
|
2468
2914
|
# The details of a mailbox export job, including the user or resource ID
|
2469
2915
|
# associated with the mailbox and the S3 bucket that the mailbox
|
2470
2916
|
# contents are exported to.
|
@@ -2583,6 +3029,45 @@ module Aws::WorkMail
|
|
2583
3029
|
include Aws::Structure
|
2584
3030
|
end
|
2585
3031
|
|
3032
|
+
# The override object.
|
3033
|
+
#
|
3034
|
+
# @!attribute [rw] user_id
|
3035
|
+
# The WorkMail user to which the access override applies.
|
3036
|
+
# @return [String]
|
3037
|
+
#
|
3038
|
+
# @!attribute [rw] device_id
|
3039
|
+
# The device to which the override applies.
|
3040
|
+
# @return [String]
|
3041
|
+
#
|
3042
|
+
# @!attribute [rw] effect
|
3043
|
+
# The effect of the override, `ALLOW` or `DENY`.
|
3044
|
+
# @return [String]
|
3045
|
+
#
|
3046
|
+
# @!attribute [rw] description
|
3047
|
+
# A description of the override.
|
3048
|
+
# @return [String]
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] date_created
|
3051
|
+
# The date the override was first created.
|
3052
|
+
# @return [Time]
|
3053
|
+
#
|
3054
|
+
# @!attribute [rw] date_modified
|
3055
|
+
# The date the override was last modified.
|
3056
|
+
# @return [Time]
|
3057
|
+
#
|
3058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/MobileDeviceAccessOverride AWS API Documentation
|
3059
|
+
#
|
3060
|
+
class MobileDeviceAccessOverride < Struct.new(
|
3061
|
+
:user_id,
|
3062
|
+
:device_id,
|
3063
|
+
:effect,
|
3064
|
+
:description,
|
3065
|
+
:date_created,
|
3066
|
+
:date_modified)
|
3067
|
+
SENSITIVE = []
|
3068
|
+
include Aws::Structure
|
3069
|
+
end
|
3070
|
+
|
2586
3071
|
# A rule that controls access to mobile devices for an Amazon WorkMail
|
2587
3072
|
# group.
|
2588
3073
|
#
|
@@ -2859,6 +3344,36 @@ module Aws::WorkMail
|
|
2859
3344
|
#
|
2860
3345
|
class PutAccessControlRuleResponse < Aws::EmptyStructure; end
|
2861
3346
|
|
3347
|
+
# @note When making an API call, you may pass PutInboundDmarcSettingsRequest
|
3348
|
+
# data as a hash:
|
3349
|
+
#
|
3350
|
+
# {
|
3351
|
+
# organization_id: "OrganizationId", # required
|
3352
|
+
# enforced: false, # required
|
3353
|
+
# }
|
3354
|
+
#
|
3355
|
+
# @!attribute [rw] organization_id
|
3356
|
+
# The ID of the organization that you are applying the DMARC policy
|
3357
|
+
# to.
|
3358
|
+
# @return [String]
|
3359
|
+
#
|
3360
|
+
# @!attribute [rw] enforced
|
3361
|
+
# Enforces or suspends a policy after it's applied.
|
3362
|
+
# @return [Boolean]
|
3363
|
+
#
|
3364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutInboundDmarcSettingsRequest AWS API Documentation
|
3365
|
+
#
|
3366
|
+
class PutInboundDmarcSettingsRequest < Struct.new(
|
3367
|
+
:organization_id,
|
3368
|
+
:enforced)
|
3369
|
+
SENSITIVE = []
|
3370
|
+
include Aws::Structure
|
3371
|
+
end
|
3372
|
+
|
3373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutInboundDmarcSettingsResponse AWS API Documentation
|
3374
|
+
#
|
3375
|
+
class PutInboundDmarcSettingsResponse < Aws::EmptyStructure; end
|
3376
|
+
|
2862
3377
|
# @note When making an API call, you may pass PutMailboxPermissionsRequest
|
2863
3378
|
# data as a hash:
|
2864
3379
|
#
|
@@ -2909,6 +3424,63 @@ module Aws::WorkMail
|
|
2909
3424
|
#
|
2910
3425
|
class PutMailboxPermissionsResponse < Aws::EmptyStructure; end
|
2911
3426
|
|
3427
|
+
# @note When making an API call, you may pass PutMobileDeviceAccessOverrideRequest
|
3428
|
+
# data as a hash:
|
3429
|
+
#
|
3430
|
+
# {
|
3431
|
+
# organization_id: "OrganizationId", # required
|
3432
|
+
# user_id: "EntityIdentifier", # required
|
3433
|
+
# device_id: "DeviceId", # required
|
3434
|
+
# effect: "ALLOW", # required, accepts ALLOW, DENY
|
3435
|
+
# description: "MobileDeviceAccessRuleDescription",
|
3436
|
+
# }
|
3437
|
+
#
|
3438
|
+
# @!attribute [rw] organization_id
|
3439
|
+
# Identifies the Amazon WorkMail organization for which you create the
|
3440
|
+
# override.
|
3441
|
+
# @return [String]
|
3442
|
+
#
|
3443
|
+
# @!attribute [rw] user_id
|
3444
|
+
# The WorkMail user for which you create the override. Accepts the
|
3445
|
+
# following types of user identities:
|
3446
|
+
#
|
3447
|
+
# * User ID: `12345678-1234-1234-1234-123456789012` or
|
3448
|
+
# `S-1-1-12-1234567890-123456789-123456789-1234`
|
3449
|
+
#
|
3450
|
+
# * Email address: `user@domain.tld`
|
3451
|
+
#
|
3452
|
+
# * User name: `user`
|
3453
|
+
# @return [String]
|
3454
|
+
#
|
3455
|
+
# @!attribute [rw] device_id
|
3456
|
+
# The mobile device for which you create the override. `DeviceId` is
|
3457
|
+
# case insensitive.
|
3458
|
+
# @return [String]
|
3459
|
+
#
|
3460
|
+
# @!attribute [rw] effect
|
3461
|
+
# The effect of the override, `ALLOW` or `DENY`.
|
3462
|
+
# @return [String]
|
3463
|
+
#
|
3464
|
+
# @!attribute [rw] description
|
3465
|
+
# A description of the override.
|
3466
|
+
# @return [String]
|
3467
|
+
#
|
3468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMobileDeviceAccessOverrideRequest AWS API Documentation
|
3469
|
+
#
|
3470
|
+
class PutMobileDeviceAccessOverrideRequest < Struct.new(
|
3471
|
+
:organization_id,
|
3472
|
+
:user_id,
|
3473
|
+
:device_id,
|
3474
|
+
:effect,
|
3475
|
+
:description)
|
3476
|
+
SENSITIVE = []
|
3477
|
+
include Aws::Structure
|
3478
|
+
end
|
3479
|
+
|
3480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMobileDeviceAccessOverrideResponse AWS API Documentation
|
3481
|
+
#
|
3482
|
+
class PutMobileDeviceAccessOverrideResponse < Aws::EmptyStructure; end
|
3483
|
+
|
2912
3484
|
# @note When making an API call, you may pass PutRetentionPolicyRequest
|
2913
3485
|
# data as a hash:
|
2914
3486
|
#
|
@@ -2962,6 +3534,45 @@ module Aws::WorkMail
|
|
2962
3534
|
#
|
2963
3535
|
class PutRetentionPolicyResponse < Aws::EmptyStructure; end
|
2964
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
|
+
|
2965
3576
|
# @note When making an API call, you may pass RegisterToWorkMailRequest
|
2966
3577
|
# data as a hash:
|
2967
3578
|
#
|
@@ -3301,6 +3912,35 @@ module Aws::WorkMail
|
|
3301
3912
|
#
|
3302
3913
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3303
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
|
+
|
3304
3944
|
# @note When making an API call, you may pass UpdateMailboxQuotaRequest
|
3305
3945
|
# data as a hash:
|
3306
3946
|
#
|