aws-sdk-workmail 1.24.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workmail.rb +1 -1
- data/lib/aws-sdk-workmail/client.rb +111 -2
- data/lib/aws-sdk-workmail/client_api.rb +79 -0
- data/lib/aws-sdk-workmail/types.rb +159 -0
- 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: d98fc7d663cab3fe44f4f054b359e6d7559e46f8cf5ea3216c7b37246e58ac08
|
4
|
+
data.tar.gz: ade93656f387b4639f3d4cab1bcf51b046ed60a169757bb8c53df4d459171807
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eae4710e7a0df1f81d6859054c305df36934fb42c781bec508786ffac864534d1f5ca15564877761a7515e4f7b17e59c678a5e30583b0fc6c103a4d0cf37da03
|
7
|
+
data.tar.gz: 14047e5094f725e46975663d126195c637b91a059a30ddd813c46a52f39b4d56a5248eb8feec21b1ca8a7c74c83bfe4c4a2f57018f264d7a00e25d0c3b7754bf
|
data/lib/aws-sdk-workmail.rb
CHANGED
@@ -176,7 +176,7 @@ module Aws::WorkMail
|
|
176
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
177
|
#
|
178
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
180
|
#
|
181
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
182
|
# The log formatter.
|
@@ -668,6 +668,33 @@ module Aws::WorkMail
|
|
668
668
|
req.send_request(options)
|
669
669
|
end
|
670
670
|
|
671
|
+
# Deletes the specified retention policy from the specified
|
672
|
+
# organization.
|
673
|
+
#
|
674
|
+
# @option params [required, String] :organization_id
|
675
|
+
# The organization ID.
|
676
|
+
#
|
677
|
+
# @option params [required, String] :id
|
678
|
+
# The retention policy ID.
|
679
|
+
#
|
680
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
681
|
+
#
|
682
|
+
# @example Request syntax with placeholder values
|
683
|
+
#
|
684
|
+
# resp = client.delete_retention_policy({
|
685
|
+
# organization_id: "OrganizationId", # required
|
686
|
+
# id: "ShortString", # required
|
687
|
+
# })
|
688
|
+
#
|
689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicy AWS API Documentation
|
690
|
+
#
|
691
|
+
# @overload delete_retention_policy(params = {})
|
692
|
+
# @param [Hash] params ({})
|
693
|
+
def delete_retention_policy(params = {}, options = {})
|
694
|
+
req = build_request(:delete_retention_policy, params)
|
695
|
+
req.send_request(options)
|
696
|
+
end
|
697
|
+
|
671
698
|
# Deletes a user from Amazon WorkMail and all subsequent systems. Before
|
672
699
|
# you can delete a user, the user state must be `DISABLED`. Use the
|
673
700
|
# DescribeUser action to confirm the user state.
|
@@ -1019,6 +1046,44 @@ module Aws::WorkMail
|
|
1019
1046
|
req.send_request(options)
|
1020
1047
|
end
|
1021
1048
|
|
1049
|
+
# Gets the default retention policy details for the specified
|
1050
|
+
# organization.
|
1051
|
+
#
|
1052
|
+
# @option params [required, String] :organization_id
|
1053
|
+
# The organization ID.
|
1054
|
+
#
|
1055
|
+
# @return [Types::GetDefaultRetentionPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1056
|
+
#
|
1057
|
+
# * {Types::GetDefaultRetentionPolicyResponse#id #id} => String
|
1058
|
+
# * {Types::GetDefaultRetentionPolicyResponse#name #name} => String
|
1059
|
+
# * {Types::GetDefaultRetentionPolicyResponse#description #description} => String
|
1060
|
+
# * {Types::GetDefaultRetentionPolicyResponse#folder_configurations #folder_configurations} => Array<Types::FolderConfiguration>
|
1061
|
+
#
|
1062
|
+
# @example Request syntax with placeholder values
|
1063
|
+
#
|
1064
|
+
# resp = client.get_default_retention_policy({
|
1065
|
+
# organization_id: "OrganizationId", # required
|
1066
|
+
# })
|
1067
|
+
#
|
1068
|
+
# @example Response structure
|
1069
|
+
#
|
1070
|
+
# resp.id #=> String
|
1071
|
+
# resp.name #=> String
|
1072
|
+
# resp.description #=> String
|
1073
|
+
# resp.folder_configurations #=> Array
|
1074
|
+
# resp.folder_configurations[0].name #=> String, one of "INBOX", "DELETED_ITEMS", "SENT_ITEMS", "DRAFTS", "JUNK_EMAIL"
|
1075
|
+
# resp.folder_configurations[0].action #=> String, one of "NONE", "DELETE", "PERMANENTLY_DELETE"
|
1076
|
+
# resp.folder_configurations[0].period #=> Integer
|
1077
|
+
#
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicy AWS API Documentation
|
1079
|
+
#
|
1080
|
+
# @overload get_default_retention_policy(params = {})
|
1081
|
+
# @param [Hash] params ({})
|
1082
|
+
def get_default_retention_policy(params = {}, options = {})
|
1083
|
+
req = build_request(:get_default_retention_policy, params)
|
1084
|
+
req.send_request(options)
|
1085
|
+
end
|
1086
|
+
|
1022
1087
|
# Requests a user's mailbox details for a specified organization and
|
1023
1088
|
# user.
|
1024
1089
|
#
|
@@ -1625,6 +1690,50 @@ module Aws::WorkMail
|
|
1625
1690
|
req.send_request(options)
|
1626
1691
|
end
|
1627
1692
|
|
1693
|
+
# Puts a retention policy to the specified organization.
|
1694
|
+
#
|
1695
|
+
# @option params [required, String] :organization_id
|
1696
|
+
# The organization ID.
|
1697
|
+
#
|
1698
|
+
# @option params [String] :id
|
1699
|
+
# The retention policy ID.
|
1700
|
+
#
|
1701
|
+
# @option params [required, String] :name
|
1702
|
+
# The retention policy name.
|
1703
|
+
#
|
1704
|
+
# @option params [String] :description
|
1705
|
+
# The retention policy description.
|
1706
|
+
#
|
1707
|
+
# @option params [required, Array<Types::FolderConfiguration>] :folder_configurations
|
1708
|
+
# The retention policy folder configurations.
|
1709
|
+
#
|
1710
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1711
|
+
#
|
1712
|
+
# @example Request syntax with placeholder values
|
1713
|
+
#
|
1714
|
+
# resp = client.put_retention_policy({
|
1715
|
+
# organization_id: "OrganizationId", # required
|
1716
|
+
# id: "ShortString",
|
1717
|
+
# name: "ShortString", # required
|
1718
|
+
# description: "PolicyDescription",
|
1719
|
+
# folder_configurations: [ # required
|
1720
|
+
# {
|
1721
|
+
# name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
|
1722
|
+
# action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
|
1723
|
+
# period: 1,
|
1724
|
+
# },
|
1725
|
+
# ],
|
1726
|
+
# })
|
1727
|
+
#
|
1728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicy AWS API Documentation
|
1729
|
+
#
|
1730
|
+
# @overload put_retention_policy(params = {})
|
1731
|
+
# @param [Hash] params ({})
|
1732
|
+
def put_retention_policy(params = {}, options = {})
|
1733
|
+
req = build_request(:put_retention_policy, params)
|
1734
|
+
req.send_request(options)
|
1735
|
+
end
|
1736
|
+
|
1628
1737
|
# Registers an existing and disabled user, group, or resource for Amazon
|
1629
1738
|
# WorkMail use by associating a mailbox and calendaring capabilities. It
|
1630
1739
|
# performs no change if the user, group, or resource is enabled and
|
@@ -1880,7 +1989,7 @@ module Aws::WorkMail
|
|
1880
1989
|
params: params,
|
1881
1990
|
config: config)
|
1882
1991
|
context[:gem_name] = 'aws-sdk-workmail'
|
1883
|
-
context[:gem_version] = '1.
|
1992
|
+
context[:gem_version] = '1.25.0'
|
1884
1993
|
Seahorse::Client::Request.new(handlers, context)
|
1885
1994
|
end
|
1886
1995
|
|
@@ -46,6 +46,8 @@ module Aws::WorkMail
|
|
46
46
|
DeleteMailboxPermissionsResponse = Shapes::StructureShape.new(name: 'DeleteMailboxPermissionsResponse')
|
47
47
|
DeleteResourceRequest = Shapes::StructureShape.new(name: 'DeleteResourceRequest')
|
48
48
|
DeleteResourceResponse = Shapes::StructureShape.new(name: 'DeleteResourceResponse')
|
49
|
+
DeleteRetentionPolicyRequest = Shapes::StructureShape.new(name: 'DeleteRetentionPolicyRequest')
|
50
|
+
DeleteRetentionPolicyResponse = Shapes::StructureShape.new(name: 'DeleteRetentionPolicyResponse')
|
49
51
|
DeleteUserRequest = Shapes::StructureShape.new(name: 'DeleteUserRequest')
|
50
52
|
DeleteUserResponse = Shapes::StructureShape.new(name: 'DeleteUserResponse')
|
51
53
|
DeregisterFromWorkMailRequest = Shapes::StructureShape.new(name: 'DeregisterFromWorkMailRequest')
|
@@ -70,8 +72,13 @@ module Aws::WorkMail
|
|
70
72
|
EntityNotFoundException = Shapes::StructureShape.new(name: 'EntityNotFoundException')
|
71
73
|
EntityState = Shapes::StringShape.new(name: 'EntityState')
|
72
74
|
EntityStateException = Shapes::StructureShape.new(name: 'EntityStateException')
|
75
|
+
FolderConfiguration = Shapes::StructureShape.new(name: 'FolderConfiguration')
|
76
|
+
FolderConfigurations = Shapes::ListShape.new(name: 'FolderConfigurations')
|
77
|
+
FolderName = Shapes::StringShape.new(name: 'FolderName')
|
73
78
|
GetAccessControlEffectRequest = Shapes::StructureShape.new(name: 'GetAccessControlEffectRequest')
|
74
79
|
GetAccessControlEffectResponse = Shapes::StructureShape.new(name: 'GetAccessControlEffectResponse')
|
80
|
+
GetDefaultRetentionPolicyRequest = Shapes::StructureShape.new(name: 'GetDefaultRetentionPolicyRequest')
|
81
|
+
GetDefaultRetentionPolicyResponse = Shapes::StructureShape.new(name: 'GetDefaultRetentionPolicyResponse')
|
75
82
|
GetMailboxDetailsRequest = Shapes::StructureShape.new(name: 'GetMailboxDetailsRequest')
|
76
83
|
GetMailboxDetailsResponse = Shapes::StructureShape.new(name: 'GetMailboxDetailsResponse')
|
77
84
|
Group = Shapes::StructureShape.new(name: 'Group')
|
@@ -125,10 +132,13 @@ module Aws::WorkMail
|
|
125
132
|
PermissionType = Shapes::StringShape.new(name: 'PermissionType')
|
126
133
|
PermissionValues = Shapes::ListShape.new(name: 'PermissionValues')
|
127
134
|
Permissions = Shapes::ListShape.new(name: 'Permissions')
|
135
|
+
PolicyDescription = Shapes::StringShape.new(name: 'PolicyDescription')
|
128
136
|
PutAccessControlRuleRequest = Shapes::StructureShape.new(name: 'PutAccessControlRuleRequest')
|
129
137
|
PutAccessControlRuleResponse = Shapes::StructureShape.new(name: 'PutAccessControlRuleResponse')
|
130
138
|
PutMailboxPermissionsRequest = Shapes::StructureShape.new(name: 'PutMailboxPermissionsRequest')
|
131
139
|
PutMailboxPermissionsResponse = Shapes::StructureShape.new(name: 'PutMailboxPermissionsResponse')
|
140
|
+
PutRetentionPolicyRequest = Shapes::StructureShape.new(name: 'PutRetentionPolicyRequest')
|
141
|
+
PutRetentionPolicyResponse = Shapes::StructureShape.new(name: 'PutRetentionPolicyResponse')
|
132
142
|
RegisterToWorkMailRequest = Shapes::StructureShape.new(name: 'RegisterToWorkMailRequest')
|
133
143
|
RegisterToWorkMailResponse = Shapes::StructureShape.new(name: 'RegisterToWorkMailResponse')
|
134
144
|
ReservedNameException = Shapes::StructureShape.new(name: 'ReservedNameException')
|
@@ -141,6 +151,9 @@ module Aws::WorkMail
|
|
141
151
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
142
152
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
143
153
|
Resources = Shapes::ListShape.new(name: 'Resources')
|
154
|
+
RetentionAction = Shapes::StringShape.new(name: 'RetentionAction')
|
155
|
+
RetentionPeriod = Shapes::IntegerShape.new(name: 'RetentionPeriod')
|
156
|
+
ShortString = Shapes::StringShape.new(name: 'ShortString')
|
144
157
|
String = Shapes::StringShape.new(name: 'String')
|
145
158
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
146
159
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
@@ -274,6 +287,12 @@ module Aws::WorkMail
|
|
274
287
|
|
275
288
|
DeleteResourceResponse.struct_class = Types::DeleteResourceResponse
|
276
289
|
|
290
|
+
DeleteRetentionPolicyRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
291
|
+
DeleteRetentionPolicyRequest.add_member(:id, Shapes::ShapeRef.new(shape: ShortString, required: true, location_name: "Id"))
|
292
|
+
DeleteRetentionPolicyRequest.struct_class = Types::DeleteRetentionPolicyRequest
|
293
|
+
|
294
|
+
DeleteRetentionPolicyResponse.struct_class = Types::DeleteRetentionPolicyResponse
|
295
|
+
|
277
296
|
DeleteUserRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
278
297
|
DeleteUserRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "UserId"))
|
279
298
|
DeleteUserRequest.struct_class = Types::DeleteUserRequest
|
@@ -372,6 +391,13 @@ module Aws::WorkMail
|
|
372
391
|
EntityStateException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
373
392
|
EntityStateException.struct_class = Types::EntityStateException
|
374
393
|
|
394
|
+
FolderConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: FolderName, required: true, location_name: "Name"))
|
395
|
+
FolderConfiguration.add_member(:action, Shapes::ShapeRef.new(shape: RetentionAction, required: true, location_name: "Action"))
|
396
|
+
FolderConfiguration.add_member(:period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "Period"))
|
397
|
+
FolderConfiguration.struct_class = Types::FolderConfiguration
|
398
|
+
|
399
|
+
FolderConfigurations.member = Shapes::ShapeRef.new(shape: FolderConfiguration)
|
400
|
+
|
375
401
|
GetAccessControlEffectRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
376
402
|
GetAccessControlEffectRequest.add_member(:ip_address, Shapes::ShapeRef.new(shape: IpAddress, required: true, location_name: "IpAddress"))
|
377
403
|
GetAccessControlEffectRequest.add_member(:action, Shapes::ShapeRef.new(shape: AccessControlRuleAction, required: true, location_name: "Action"))
|
@@ -382,6 +408,15 @@ module Aws::WorkMail
|
|
382
408
|
GetAccessControlEffectResponse.add_member(:matched_rules, Shapes::ShapeRef.new(shape: AccessControlRuleNameList, location_name: "MatchedRules"))
|
383
409
|
GetAccessControlEffectResponse.struct_class = Types::GetAccessControlEffectResponse
|
384
410
|
|
411
|
+
GetDefaultRetentionPolicyRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
412
|
+
GetDefaultRetentionPolicyRequest.struct_class = Types::GetDefaultRetentionPolicyRequest
|
413
|
+
|
414
|
+
GetDefaultRetentionPolicyResponse.add_member(:id, Shapes::ShapeRef.new(shape: ShortString, location_name: "Id"))
|
415
|
+
GetDefaultRetentionPolicyResponse.add_member(:name, Shapes::ShapeRef.new(shape: ShortString, location_name: "Name"))
|
416
|
+
GetDefaultRetentionPolicyResponse.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "Description"))
|
417
|
+
GetDefaultRetentionPolicyResponse.add_member(:folder_configurations, Shapes::ShapeRef.new(shape: FolderConfigurations, location_name: "FolderConfigurations"))
|
418
|
+
GetDefaultRetentionPolicyResponse.struct_class = Types::GetDefaultRetentionPolicyResponse
|
419
|
+
|
385
420
|
GetMailboxDetailsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
386
421
|
GetMailboxDetailsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "UserId"))
|
387
422
|
GetMailboxDetailsRequest.struct_class = Types::GetMailboxDetailsRequest
|
@@ -565,6 +600,15 @@ module Aws::WorkMail
|
|
565
600
|
|
566
601
|
PutMailboxPermissionsResponse.struct_class = Types::PutMailboxPermissionsResponse
|
567
602
|
|
603
|
+
PutRetentionPolicyRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
604
|
+
PutRetentionPolicyRequest.add_member(:id, Shapes::ShapeRef.new(shape: ShortString, location_name: "Id"))
|
605
|
+
PutRetentionPolicyRequest.add_member(:name, Shapes::ShapeRef.new(shape: ShortString, required: true, location_name: "Name"))
|
606
|
+
PutRetentionPolicyRequest.add_member(:description, Shapes::ShapeRef.new(shape: PolicyDescription, location_name: "Description"))
|
607
|
+
PutRetentionPolicyRequest.add_member(:folder_configurations, Shapes::ShapeRef.new(shape: FolderConfigurations, required: true, location_name: "FolderConfigurations"))
|
608
|
+
PutRetentionPolicyRequest.struct_class = Types::PutRetentionPolicyRequest
|
609
|
+
|
610
|
+
PutRetentionPolicyResponse.struct_class = Types::PutRetentionPolicyResponse
|
611
|
+
|
568
612
|
RegisterToWorkMailRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
569
613
|
RegisterToWorkMailRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "EntityId"))
|
570
614
|
RegisterToWorkMailRequest.add_member(:email, Shapes::ShapeRef.new(shape: EmailAddress, required: true, location_name: "Email"))
|
@@ -835,6 +879,17 @@ module Aws::WorkMail
|
|
835
879
|
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
836
880
|
end)
|
837
881
|
|
882
|
+
api.add_operation(:delete_retention_policy, Seahorse::Model::Operation.new.tap do |o|
|
883
|
+
o.name = "DeleteRetentionPolicy"
|
884
|
+
o.http_method = "POST"
|
885
|
+
o.http_request_uri = "/"
|
886
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteRetentionPolicyRequest)
|
887
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteRetentionPolicyResponse)
|
888
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
889
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
890
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
891
|
+
end)
|
892
|
+
|
838
893
|
api.add_operation(:delete_user, Seahorse::Model::Operation.new.tap do |o|
|
839
894
|
o.name = "DeleteUser"
|
840
895
|
o.http_method = "POST"
|
@@ -950,6 +1005,18 @@ module Aws::WorkMail
|
|
950
1005
|
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
951
1006
|
end)
|
952
1007
|
|
1008
|
+
api.add_operation(:get_default_retention_policy, Seahorse::Model::Operation.new.tap do |o|
|
1009
|
+
o.name = "GetDefaultRetentionPolicy"
|
1010
|
+
o.http_method = "POST"
|
1011
|
+
o.http_request_uri = "/"
|
1012
|
+
o.input = Shapes::ShapeRef.new(shape: GetDefaultRetentionPolicyRequest)
|
1013
|
+
o.output = Shapes::ShapeRef.new(shape: GetDefaultRetentionPolicyResponse)
|
1014
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1015
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1016
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1017
|
+
o.errors << Shapes::ShapeRef.new(shape: EntityNotFoundException)
|
1018
|
+
end)
|
1019
|
+
|
953
1020
|
api.add_operation(:get_mailbox_details, Seahorse::Model::Operation.new.tap do |o|
|
954
1021
|
o.name = "GetMailboxDetails"
|
955
1022
|
o.http_method = "POST"
|
@@ -1148,6 +1215,18 @@ module Aws::WorkMail
|
|
1148
1215
|
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1149
1216
|
end)
|
1150
1217
|
|
1218
|
+
api.add_operation(:put_retention_policy, Seahorse::Model::Operation.new.tap do |o|
|
1219
|
+
o.name = "PutRetentionPolicy"
|
1220
|
+
o.http_method = "POST"
|
1221
|
+
o.http_request_uri = "/"
|
1222
|
+
o.input = Shapes::ShapeRef.new(shape: PutRetentionPolicyRequest)
|
1223
|
+
o.output = Shapes::ShapeRef.new(shape: PutRetentionPolicyResponse)
|
1224
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1225
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1226
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1227
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1228
|
+
end)
|
1229
|
+
|
1151
1230
|
api.add_operation(:register_to_work_mail, Seahorse::Model::Operation.new.tap do |o|
|
1152
1231
|
o.name = "RegisterToWorkMail"
|
1153
1232
|
o.http_method = "POST"
|
@@ -517,6 +517,34 @@ module Aws::WorkMail
|
|
517
517
|
#
|
518
518
|
class DeleteResourceResponse < Aws::EmptyStructure; end
|
519
519
|
|
520
|
+
# @note When making an API call, you may pass DeleteRetentionPolicyRequest
|
521
|
+
# data as a hash:
|
522
|
+
#
|
523
|
+
# {
|
524
|
+
# organization_id: "OrganizationId", # required
|
525
|
+
# id: "ShortString", # required
|
526
|
+
# }
|
527
|
+
#
|
528
|
+
# @!attribute [rw] organization_id
|
529
|
+
# The organization ID.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @!attribute [rw] id
|
533
|
+
# The retention policy ID.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicyRequest AWS API Documentation
|
537
|
+
#
|
538
|
+
class DeleteRetentionPolicyRequest < Struct.new(
|
539
|
+
:organization_id,
|
540
|
+
:id)
|
541
|
+
include Aws::Structure
|
542
|
+
end
|
543
|
+
|
544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicyResponse AWS API Documentation
|
545
|
+
#
|
546
|
+
class DeleteRetentionPolicyResponse < Aws::EmptyStructure; end
|
547
|
+
|
520
548
|
# @note When making an API call, you may pass DeleteUserRequest
|
521
549
|
# data as a hash:
|
522
550
|
#
|
@@ -1010,6 +1038,41 @@ module Aws::WorkMail
|
|
1010
1038
|
include Aws::Structure
|
1011
1039
|
end
|
1012
1040
|
|
1041
|
+
# The configuration applied to an organization's folders by its
|
1042
|
+
# retention policy.
|
1043
|
+
#
|
1044
|
+
# @note When making an API call, you may pass FolderConfiguration
|
1045
|
+
# data as a hash:
|
1046
|
+
#
|
1047
|
+
# {
|
1048
|
+
# name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
|
1049
|
+
# action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
|
1050
|
+
# period: 1,
|
1051
|
+
# }
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] name
|
1054
|
+
# The folder name.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] action
|
1058
|
+
# The action to take on the folder contents at the end of the folder
|
1059
|
+
# configuration period.
|
1060
|
+
# @return [String]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] period
|
1063
|
+
# The period of time at which the folder configuration action is
|
1064
|
+
# applied.
|
1065
|
+
# @return [Integer]
|
1066
|
+
#
|
1067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/FolderConfiguration AWS API Documentation
|
1068
|
+
#
|
1069
|
+
class FolderConfiguration < Struct.new(
|
1070
|
+
:name,
|
1071
|
+
:action,
|
1072
|
+
:period)
|
1073
|
+
include Aws::Structure
|
1074
|
+
end
|
1075
|
+
|
1013
1076
|
# @note When making an API call, you may pass GetAccessControlEffectRequest
|
1014
1077
|
# data as a hash:
|
1015
1078
|
#
|
@@ -1064,6 +1127,50 @@ module Aws::WorkMail
|
|
1064
1127
|
include Aws::Structure
|
1065
1128
|
end
|
1066
1129
|
|
1130
|
+
# @note When making an API call, you may pass GetDefaultRetentionPolicyRequest
|
1131
|
+
# data as a hash:
|
1132
|
+
#
|
1133
|
+
# {
|
1134
|
+
# organization_id: "OrganizationId", # required
|
1135
|
+
# }
|
1136
|
+
#
|
1137
|
+
# @!attribute [rw] organization_id
|
1138
|
+
# The organization ID.
|
1139
|
+
# @return [String]
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicyRequest AWS API Documentation
|
1142
|
+
#
|
1143
|
+
class GetDefaultRetentionPolicyRequest < Struct.new(
|
1144
|
+
:organization_id)
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# @!attribute [rw] id
|
1149
|
+
# The retention policy ID.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] name
|
1153
|
+
# The retention policy name.
|
1154
|
+
# @return [String]
|
1155
|
+
#
|
1156
|
+
# @!attribute [rw] description
|
1157
|
+
# The retention policy description.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] folder_configurations
|
1161
|
+
# The retention policy folder configurations.
|
1162
|
+
# @return [Array<Types::FolderConfiguration>]
|
1163
|
+
#
|
1164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicyResponse AWS API Documentation
|
1165
|
+
#
|
1166
|
+
class GetDefaultRetentionPolicyResponse < Struct.new(
|
1167
|
+
:id,
|
1168
|
+
:name,
|
1169
|
+
:description,
|
1170
|
+
:folder_configurations)
|
1171
|
+
include Aws::Structure
|
1172
|
+
end
|
1173
|
+
|
1067
1174
|
# @note When making an API call, you may pass GetMailboxDetailsRequest
|
1068
1175
|
# data as a hash:
|
1069
1176
|
#
|
@@ -1960,6 +2067,58 @@ module Aws::WorkMail
|
|
1960
2067
|
#
|
1961
2068
|
class PutMailboxPermissionsResponse < Aws::EmptyStructure; end
|
1962
2069
|
|
2070
|
+
# @note When making an API call, you may pass PutRetentionPolicyRequest
|
2071
|
+
# data as a hash:
|
2072
|
+
#
|
2073
|
+
# {
|
2074
|
+
# organization_id: "OrganizationId", # required
|
2075
|
+
# id: "ShortString",
|
2076
|
+
# name: "ShortString", # required
|
2077
|
+
# description: "PolicyDescription",
|
2078
|
+
# folder_configurations: [ # required
|
2079
|
+
# {
|
2080
|
+
# name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
|
2081
|
+
# action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
|
2082
|
+
# period: 1,
|
2083
|
+
# },
|
2084
|
+
# ],
|
2085
|
+
# }
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] organization_id
|
2088
|
+
# The organization ID.
|
2089
|
+
# @return [String]
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] id
|
2092
|
+
# The retention policy ID.
|
2093
|
+
# @return [String]
|
2094
|
+
#
|
2095
|
+
# @!attribute [rw] name
|
2096
|
+
# The retention policy name.
|
2097
|
+
# @return [String]
|
2098
|
+
#
|
2099
|
+
# @!attribute [rw] description
|
2100
|
+
# The retention policy description.
|
2101
|
+
# @return [String]
|
2102
|
+
#
|
2103
|
+
# @!attribute [rw] folder_configurations
|
2104
|
+
# The retention policy folder configurations.
|
2105
|
+
# @return [Array<Types::FolderConfiguration>]
|
2106
|
+
#
|
2107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicyRequest AWS API Documentation
|
2108
|
+
#
|
2109
|
+
class PutRetentionPolicyRequest < Struct.new(
|
2110
|
+
:organization_id,
|
2111
|
+
:id,
|
2112
|
+
:name,
|
2113
|
+
:description,
|
2114
|
+
:folder_configurations)
|
2115
|
+
include Aws::Structure
|
2116
|
+
end
|
2117
|
+
|
2118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicyResponse AWS API Documentation
|
2119
|
+
#
|
2120
|
+
class PutRetentionPolicyResponse < Aws::EmptyStructure; end
|
2121
|
+
|
1963
2122
|
# @note When making an API call, you may pass RegisterToWorkMailRequest
|
1964
2123
|
# data as a hash:
|
1965
2124
|
#
|
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.25.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: 2020-05-
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|