aws-sdk-workmail 1.30.0 → 1.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workmail.rb +1 -1
- data/lib/aws-sdk-workmail/client.rb +139 -4
- data/lib/aws-sdk-workmail/client_api.rb +64 -0
- data/lib/aws-sdk-workmail/errors.rb +16 -0
- data/lib/aws-sdk-workmail/types.rb +187 -7
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6231e0b456bd3b0533b3fe1e474356d2b7065b343dbd73f0ad52351729b1922c
|
4
|
+
data.tar.gz: abdfdd6209addcfee0abf70b78508cfe97dddf7e2103d02d4d7d54f4548e03b0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e4d41b50b95a85265f9cc1dc10ae6402e8e311c0f4ebcb6af5bc3a3411a819611f86623f9c5f463af17c3d903aacba4906fecf07288266d31367fe913f850558
|
7
|
+
data.tar.gz: 0ef9434fb6ec0067342af154994f29530e30e4732f1be720fcd7222882dc30e7bd591528975fbcf37183ba69b783cf34a0a7899a9502374e6c3ae5bc31782eba
|
data/lib/aws-sdk-workmail.rb
CHANGED
@@ -499,6 +499,90 @@ module Aws::WorkMail
|
|
499
499
|
req.send_request(options)
|
500
500
|
end
|
501
501
|
|
502
|
+
# Creates a new Amazon WorkMail organization. Optionally, you can choose
|
503
|
+
# to associate an existing AWS Directory Service directory with your
|
504
|
+
# organization. If an AWS Directory Service directory ID is specified,
|
505
|
+
# the organization alias must match the directory alias. If you choose
|
506
|
+
# not to associate an existing directory with your organization, then we
|
507
|
+
# create a new Amazon WorkMail directory for you. For more information,
|
508
|
+
# see [Adding an organization][1] in the *Amazon WorkMail Administrator
|
509
|
+
# Guide*.
|
510
|
+
#
|
511
|
+
# You can associate multiple email domains with an organization, then
|
512
|
+
# set your default email domain from the Amazon WorkMail console. You
|
513
|
+
# can also associate a domain that is managed in an Amazon Route 53
|
514
|
+
# public hosted zone. For more information, see [Adding a domain][2] and
|
515
|
+
# [Choosing the default domain][3] in the *Amazon WorkMail Administrator
|
516
|
+
# Guide*.
|
517
|
+
#
|
518
|
+
# Optionally, you can use a customer managed master key from AWS Key
|
519
|
+
# Management Service (AWS KMS) to encrypt email for your organization.
|
520
|
+
# If you don't associate an AWS KMS key, Amazon WorkMail creates a
|
521
|
+
# default AWS managed master key for you.
|
522
|
+
#
|
523
|
+
#
|
524
|
+
#
|
525
|
+
# [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html
|
526
|
+
# [2]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html
|
527
|
+
# [3]: https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html
|
528
|
+
#
|
529
|
+
# @option params [String] :directory_id
|
530
|
+
# The AWS Directory Service directory ID.
|
531
|
+
#
|
532
|
+
# @option params [required, String] :alias
|
533
|
+
# The organization alias.
|
534
|
+
#
|
535
|
+
# @option params [String] :client_token
|
536
|
+
# The idempotency token associated with the request.
|
537
|
+
#
|
538
|
+
# **A suitable default value is auto-generated.** You should normally
|
539
|
+
# not need to pass this option.**
|
540
|
+
#
|
541
|
+
# @option params [Array<Types::Domain>] :domains
|
542
|
+
# The email domains to associate with the organization.
|
543
|
+
#
|
544
|
+
# @option params [String] :kms_key_arn
|
545
|
+
# The Amazon Resource Name (ARN) of a customer managed master key from
|
546
|
+
# AWS KMS.
|
547
|
+
#
|
548
|
+
# @option params [Boolean] :enable_interoperability
|
549
|
+
# When `true`, allows organization interoperability between Amazon
|
550
|
+
# WorkMail and Microsoft Exchange. Can only be set to `true` if an AD
|
551
|
+
# Connector directory ID is included in the request.
|
552
|
+
#
|
553
|
+
# @return [Types::CreateOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
554
|
+
#
|
555
|
+
# * {Types::CreateOrganizationResponse#organization_id #organization_id} => String
|
556
|
+
#
|
557
|
+
# @example Request syntax with placeholder values
|
558
|
+
#
|
559
|
+
# resp = client.create_organization({
|
560
|
+
# directory_id: "DirectoryId",
|
561
|
+
# alias: "OrganizationName", # required
|
562
|
+
# client_token: "IdempotencyClientToken",
|
563
|
+
# domains: [
|
564
|
+
# {
|
565
|
+
# domain_name: "DomainName",
|
566
|
+
# hosted_zone_id: "HostedZoneId",
|
567
|
+
# },
|
568
|
+
# ],
|
569
|
+
# kms_key_arn: "KmsKeyArn",
|
570
|
+
# enable_interoperability: false,
|
571
|
+
# })
|
572
|
+
#
|
573
|
+
# @example Response structure
|
574
|
+
#
|
575
|
+
# resp.organization_id #=> String
|
576
|
+
#
|
577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganization AWS API Documentation
|
578
|
+
#
|
579
|
+
# @overload create_organization(params = {})
|
580
|
+
# @param [Hash] params ({})
|
581
|
+
def create_organization(params = {}, options = {})
|
582
|
+
req = build_request(:create_organization, params)
|
583
|
+
req.send_request(options)
|
584
|
+
end
|
585
|
+
|
502
586
|
# Creates a new Amazon WorkMail resource.
|
503
587
|
#
|
504
588
|
# @option params [required, String] :organization_id
|
@@ -544,8 +628,8 @@ module Aws::WorkMail
|
|
544
628
|
# The identifier of the organization for which the user is created.
|
545
629
|
#
|
546
630
|
# @option params [required, String] :name
|
547
|
-
# The name for the new user.
|
548
|
-
# maximum length of
|
631
|
+
# The name for the new user. WorkMail directory user names have a
|
632
|
+
# maximum length of 64. All others have a maximum length of 20.
|
549
633
|
#
|
550
634
|
# @option params [required, String] :display_name
|
551
635
|
# The display name for the new user.
|
@@ -673,7 +757,7 @@ module Aws::WorkMail
|
|
673
757
|
# group) exists.
|
674
758
|
#
|
675
759
|
# @option params [required, String] :entity_id
|
676
|
-
# The identifier of the member (user or group)that owns the mailbox.
|
760
|
+
# The identifier of the member (user or group) that owns the mailbox.
|
677
761
|
#
|
678
762
|
# @option params [required, String] :grantee_id
|
679
763
|
# The identifier of the member (user or group) for which to delete
|
@@ -698,6 +782,56 @@ module Aws::WorkMail
|
|
698
782
|
req.send_request(options)
|
699
783
|
end
|
700
784
|
|
785
|
+
# Deletes an Amazon WorkMail organization and all underlying AWS
|
786
|
+
# resources managed by Amazon WorkMail as part of the organization. You
|
787
|
+
# can choose whether to delete the associated directory. For more
|
788
|
+
# information, see [Removing an organization][1] in the *Amazon WorkMail
|
789
|
+
# Administrator Guide*.
|
790
|
+
#
|
791
|
+
#
|
792
|
+
#
|
793
|
+
# [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html
|
794
|
+
#
|
795
|
+
# @option params [String] :client_token
|
796
|
+
# The idempotency token associated with the request.
|
797
|
+
#
|
798
|
+
# **A suitable default value is auto-generated.** You should normally
|
799
|
+
# not need to pass this option.**
|
800
|
+
#
|
801
|
+
# @option params [required, String] :organization_id
|
802
|
+
# The organization ID.
|
803
|
+
#
|
804
|
+
# @option params [required, Boolean] :delete_directory
|
805
|
+
# If true, deletes the AWS Directory Service directory associated with
|
806
|
+
# the organization.
|
807
|
+
#
|
808
|
+
# @return [Types::DeleteOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
809
|
+
#
|
810
|
+
# * {Types::DeleteOrganizationResponse#organization_id #organization_id} => String
|
811
|
+
# * {Types::DeleteOrganizationResponse#state #state} => String
|
812
|
+
#
|
813
|
+
# @example Request syntax with placeholder values
|
814
|
+
#
|
815
|
+
# resp = client.delete_organization({
|
816
|
+
# client_token: "IdempotencyClientToken",
|
817
|
+
# organization_id: "OrganizationId", # required
|
818
|
+
# delete_directory: false, # required
|
819
|
+
# })
|
820
|
+
#
|
821
|
+
# @example Response structure
|
822
|
+
#
|
823
|
+
# resp.organization_id #=> String
|
824
|
+
# resp.state #=> String
|
825
|
+
#
|
826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganization AWS API Documentation
|
827
|
+
#
|
828
|
+
# @overload delete_organization(params = {})
|
829
|
+
# @param [Hash] params ({})
|
830
|
+
def delete_organization(params = {}, options = {})
|
831
|
+
req = build_request(:delete_organization, params)
|
832
|
+
req.send_request(options)
|
833
|
+
end
|
834
|
+
|
701
835
|
# Deletes the specified resource.
|
702
836
|
#
|
703
837
|
# @option params [required, String] :organization_id
|
@@ -1553,6 +1687,7 @@ module Aws::WorkMail
|
|
1553
1687
|
# resp.organization_summaries #=> Array
|
1554
1688
|
# resp.organization_summaries[0].organization_id #=> String
|
1555
1689
|
# resp.organization_summaries[0].alias #=> String
|
1690
|
+
# resp.organization_summaries[0].default_mail_domain #=> String
|
1556
1691
|
# resp.organization_summaries[0].error_message #=> String
|
1557
1692
|
# resp.organization_summaries[0].state #=> String
|
1558
1693
|
# resp.next_token #=> String
|
@@ -2219,7 +2354,7 @@ module Aws::WorkMail
|
|
2219
2354
|
params: params,
|
2220
2355
|
config: config)
|
2221
2356
|
context[:gem_name] = 'aws-sdk-workmail'
|
2222
|
-
context[:gem_version] = '1.
|
2357
|
+
context[:gem_version] = '1.35.0'
|
2223
2358
|
Seahorse::Client::Request.new(handlers, context)
|
2224
2359
|
end
|
2225
2360
|
|
@@ -35,6 +35,8 @@ module Aws::WorkMail
|
|
35
35
|
CreateAliasResponse = Shapes::StructureShape.new(name: 'CreateAliasResponse')
|
36
36
|
CreateGroupRequest = Shapes::StructureShape.new(name: 'CreateGroupRequest')
|
37
37
|
CreateGroupResponse = Shapes::StructureShape.new(name: 'CreateGroupResponse')
|
38
|
+
CreateOrganizationRequest = Shapes::StructureShape.new(name: 'CreateOrganizationRequest')
|
39
|
+
CreateOrganizationResponse = Shapes::StructureShape.new(name: 'CreateOrganizationResponse')
|
38
40
|
CreateResourceRequest = Shapes::StructureShape.new(name: 'CreateResourceRequest')
|
39
41
|
CreateResourceResponse = Shapes::StructureShape.new(name: 'CreateResourceResponse')
|
40
42
|
CreateUserRequest = Shapes::StructureShape.new(name: 'CreateUserRequest')
|
@@ -48,6 +50,8 @@ module Aws::WorkMail
|
|
48
50
|
DeleteGroupResponse = Shapes::StructureShape.new(name: 'DeleteGroupResponse')
|
49
51
|
DeleteMailboxPermissionsRequest = Shapes::StructureShape.new(name: 'DeleteMailboxPermissionsRequest')
|
50
52
|
DeleteMailboxPermissionsResponse = Shapes::StructureShape.new(name: 'DeleteMailboxPermissionsResponse')
|
53
|
+
DeleteOrganizationRequest = Shapes::StructureShape.new(name: 'DeleteOrganizationRequest')
|
54
|
+
DeleteOrganizationResponse = Shapes::StructureShape.new(name: 'DeleteOrganizationResponse')
|
51
55
|
DeleteResourceRequest = Shapes::StructureShape.new(name: 'DeleteResourceRequest')
|
52
56
|
DeleteResourceResponse = Shapes::StructureShape.new(name: 'DeleteResourceResponse')
|
53
57
|
DeleteRetentionPolicyRequest = Shapes::StructureShape.new(name: 'DeleteRetentionPolicyRequest')
|
@@ -67,12 +71,17 @@ module Aws::WorkMail
|
|
67
71
|
DescribeUserRequest = Shapes::StructureShape.new(name: 'DescribeUserRequest')
|
68
72
|
DescribeUserResponse = Shapes::StructureShape.new(name: 'DescribeUserResponse')
|
69
73
|
Description = Shapes::StringShape.new(name: 'Description')
|
74
|
+
DirectoryId = Shapes::StringShape.new(name: 'DirectoryId')
|
75
|
+
DirectoryInUseException = Shapes::StructureShape.new(name: 'DirectoryInUseException')
|
70
76
|
DirectoryServiceAuthenticationFailedException = Shapes::StructureShape.new(name: 'DirectoryServiceAuthenticationFailedException')
|
71
77
|
DirectoryUnavailableException = Shapes::StructureShape.new(name: 'DirectoryUnavailableException')
|
72
78
|
DisassociateDelegateFromResourceRequest = Shapes::StructureShape.new(name: 'DisassociateDelegateFromResourceRequest')
|
73
79
|
DisassociateDelegateFromResourceResponse = Shapes::StructureShape.new(name: 'DisassociateDelegateFromResourceResponse')
|
74
80
|
DisassociateMemberFromGroupRequest = Shapes::StructureShape.new(name: 'DisassociateMemberFromGroupRequest')
|
75
81
|
DisassociateMemberFromGroupResponse = Shapes::StructureShape.new(name: 'DisassociateMemberFromGroupResponse')
|
82
|
+
Domain = Shapes::StructureShape.new(name: 'Domain')
|
83
|
+
DomainName = Shapes::StringShape.new(name: 'DomainName')
|
84
|
+
Domains = Shapes::ListShape.new(name: 'Domains')
|
76
85
|
EmailAddress = Shapes::StringShape.new(name: 'EmailAddress')
|
77
86
|
EmailAddressInUseException = Shapes::StructureShape.new(name: 'EmailAddressInUseException')
|
78
87
|
EntityAlreadyRegisteredException = Shapes::StructureShape.new(name: 'EntityAlreadyRegisteredException')
|
@@ -91,6 +100,7 @@ module Aws::WorkMail
|
|
91
100
|
Group = Shapes::StructureShape.new(name: 'Group')
|
92
101
|
GroupName = Shapes::StringShape.new(name: 'GroupName')
|
93
102
|
Groups = Shapes::ListShape.new(name: 'Groups')
|
103
|
+
HostedZoneId = Shapes::StringShape.new(name: 'HostedZoneId')
|
94
104
|
IdempotencyClientToken = Shapes::StringShape.new(name: 'IdempotencyClientToken')
|
95
105
|
InvalidConfigurationException = Shapes::StructureShape.new(name: 'InvalidConfigurationException')
|
96
106
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
@@ -263,6 +273,17 @@ module Aws::WorkMail
|
|
263
273
|
CreateGroupResponse.add_member(:group_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, location_name: "GroupId"))
|
264
274
|
CreateGroupResponse.struct_class = Types::CreateGroupResponse
|
265
275
|
|
276
|
+
CreateOrganizationRequest.add_member(:directory_id, Shapes::ShapeRef.new(shape: DirectoryId, location_name: "DirectoryId"))
|
277
|
+
CreateOrganizationRequest.add_member(:alias, Shapes::ShapeRef.new(shape: OrganizationName, required: true, location_name: "Alias"))
|
278
|
+
CreateOrganizationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
279
|
+
CreateOrganizationRequest.add_member(:domains, Shapes::ShapeRef.new(shape: Domains, location_name: "Domains"))
|
280
|
+
CreateOrganizationRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
|
281
|
+
CreateOrganizationRequest.add_member(:enable_interoperability, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableInteroperability"))
|
282
|
+
CreateOrganizationRequest.struct_class = Types::CreateOrganizationRequest
|
283
|
+
|
284
|
+
CreateOrganizationResponse.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, location_name: "OrganizationId"))
|
285
|
+
CreateOrganizationResponse.struct_class = Types::CreateOrganizationResponse
|
286
|
+
|
266
287
|
CreateResourceRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
267
288
|
CreateResourceRequest.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "Name"))
|
268
289
|
CreateResourceRequest.add_member(:type, Shapes::ShapeRef.new(shape: ResourceType, required: true, location_name: "Type"))
|
@@ -310,6 +331,15 @@ module Aws::WorkMail
|
|
310
331
|
|
311
332
|
DeleteMailboxPermissionsResponse.struct_class = Types::DeleteMailboxPermissionsResponse
|
312
333
|
|
334
|
+
DeleteOrganizationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
335
|
+
DeleteOrganizationRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
336
|
+
DeleteOrganizationRequest.add_member(:delete_directory, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "DeleteDirectory"))
|
337
|
+
DeleteOrganizationRequest.struct_class = Types::DeleteOrganizationRequest
|
338
|
+
|
339
|
+
DeleteOrganizationResponse.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, location_name: "OrganizationId"))
|
340
|
+
DeleteOrganizationResponse.add_member(:state, Shapes::ShapeRef.new(shape: String, location_name: "State"))
|
341
|
+
DeleteOrganizationResponse.struct_class = Types::DeleteOrganizationResponse
|
342
|
+
|
313
343
|
DeleteResourceRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
|
314
344
|
DeleteResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ResourceId"))
|
315
345
|
DeleteResourceRequest.struct_class = Types::DeleteResourceRequest
|
@@ -406,6 +436,9 @@ module Aws::WorkMail
|
|
406
436
|
DescribeUserResponse.add_member(:disabled_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DisabledDate"))
|
407
437
|
DescribeUserResponse.struct_class = Types::DescribeUserResponse
|
408
438
|
|
439
|
+
DirectoryInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
440
|
+
DirectoryInUseException.struct_class = Types::DirectoryInUseException
|
441
|
+
|
409
442
|
DirectoryServiceAuthenticationFailedException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
410
443
|
DirectoryServiceAuthenticationFailedException.struct_class = Types::DirectoryServiceAuthenticationFailedException
|
411
444
|
|
@@ -426,6 +459,12 @@ module Aws::WorkMail
|
|
426
459
|
|
427
460
|
DisassociateMemberFromGroupResponse.struct_class = Types::DisassociateMemberFromGroupResponse
|
428
461
|
|
462
|
+
Domain.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location_name: "DomainName"))
|
463
|
+
Domain.add_member(:hosted_zone_id, Shapes::ShapeRef.new(shape: HostedZoneId, location_name: "HostedZoneId"))
|
464
|
+
Domain.struct_class = Types::Domain
|
465
|
+
|
466
|
+
Domains.member = Shapes::ShapeRef.new(shape: Domain)
|
467
|
+
|
429
468
|
EmailAddressInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
430
469
|
EmailAddressInUseException.struct_class = Types::EmailAddressInUseException
|
431
470
|
|
@@ -634,6 +673,7 @@ module Aws::WorkMail
|
|
634
673
|
|
635
674
|
OrganizationSummary.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, location_name: "OrganizationId"))
|
636
675
|
OrganizationSummary.add_member(:alias, Shapes::ShapeRef.new(shape: OrganizationName, location_name: "Alias"))
|
676
|
+
OrganizationSummary.add_member(:default_mail_domain, Shapes::ShapeRef.new(shape: DomainName, location_name: "DefaultMailDomain"))
|
637
677
|
OrganizationSummary.add_member(:error_message, Shapes::ShapeRef.new(shape: String, location_name: "ErrorMessage"))
|
638
678
|
OrganizationSummary.add_member(:state, Shapes::ShapeRef.new(shape: String, location_name: "State"))
|
639
679
|
OrganizationSummary.struct_class = Types::OrganizationSummary
|
@@ -878,6 +918,19 @@ module Aws::WorkMail
|
|
878
918
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
|
879
919
|
end)
|
880
920
|
|
921
|
+
api.add_operation(:create_organization, Seahorse::Model::Operation.new.tap do |o|
|
922
|
+
o.name = "CreateOrganization"
|
923
|
+
o.http_method = "POST"
|
924
|
+
o.http_request_uri = "/"
|
925
|
+
o.input = Shapes::ShapeRef.new(shape: CreateOrganizationRequest)
|
926
|
+
o.output = Shapes::ShapeRef.new(shape: CreateOrganizationResponse)
|
927
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
928
|
+
o.errors << Shapes::ShapeRef.new(shape: DirectoryInUseException)
|
929
|
+
o.errors << Shapes::ShapeRef.new(shape: DirectoryUnavailableException)
|
930
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
931
|
+
o.errors << Shapes::ShapeRef.new(shape: NameAvailabilityException)
|
932
|
+
end)
|
933
|
+
|
881
934
|
api.add_operation(:create_resource, Seahorse::Model::Operation.new.tap do |o|
|
882
935
|
o.name = "CreateResource"
|
883
936
|
o.http_method = "POST"
|
@@ -961,6 +1014,17 @@ module Aws::WorkMail
|
|
961
1014
|
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
962
1015
|
end)
|
963
1016
|
|
1017
|
+
api.add_operation(:delete_organization, Seahorse::Model::Operation.new.tap do |o|
|
1018
|
+
o.name = "DeleteOrganization"
|
1019
|
+
o.http_method = "POST"
|
1020
|
+
o.http_request_uri = "/"
|
1021
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteOrganizationRequest)
|
1022
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteOrganizationResponse)
|
1023
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1024
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
|
1025
|
+
o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
|
1026
|
+
end)
|
1027
|
+
|
964
1028
|
api.add_operation(:delete_resource, Seahorse::Model::Operation.new.tap do |o|
|
965
1029
|
o.name = "DeleteResource"
|
966
1030
|
o.http_method = "POST"
|
@@ -27,6 +27,7 @@ module Aws::WorkMail
|
|
27
27
|
# See {Seahorse::Client::RequestContext} for more information.
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
|
+
# * {DirectoryInUseException}
|
30
31
|
# * {DirectoryServiceAuthenticationFailedException}
|
31
32
|
# * {DirectoryUnavailableException}
|
32
33
|
# * {EmailAddressInUseException}
|
@@ -53,6 +54,21 @@ module Aws::WorkMail
|
|
53
54
|
|
54
55
|
extend Aws::Errors::DynamicErrors
|
55
56
|
|
57
|
+
class DirectoryInUseException < ServiceError
|
58
|
+
|
59
|
+
# @param [Seahorse::Client::RequestContext] context
|
60
|
+
# @param [String] message
|
61
|
+
# @param [Aws::WorkMail::Types::DirectoryInUseException] data
|
62
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
63
|
+
super(context, message, data)
|
64
|
+
end
|
65
|
+
|
66
|
+
# @return [String]
|
67
|
+
def message
|
68
|
+
@message || @data[:message]
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
56
72
|
class DirectoryServiceAuthenticationFailedException < ServiceError
|
57
73
|
|
58
74
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -295,6 +295,78 @@ module Aws::WorkMail
|
|
295
295
|
include Aws::Structure
|
296
296
|
end
|
297
297
|
|
298
|
+
# @note When making an API call, you may pass CreateOrganizationRequest
|
299
|
+
# data as a hash:
|
300
|
+
#
|
301
|
+
# {
|
302
|
+
# directory_id: "DirectoryId",
|
303
|
+
# alias: "OrganizationName", # required
|
304
|
+
# client_token: "IdempotencyClientToken",
|
305
|
+
# domains: [
|
306
|
+
# {
|
307
|
+
# domain_name: "DomainName",
|
308
|
+
# hosted_zone_id: "HostedZoneId",
|
309
|
+
# },
|
310
|
+
# ],
|
311
|
+
# kms_key_arn: "KmsKeyArn",
|
312
|
+
# enable_interoperability: false,
|
313
|
+
# }
|
314
|
+
#
|
315
|
+
# @!attribute [rw] directory_id
|
316
|
+
# The AWS Directory Service directory ID.
|
317
|
+
# @return [String]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] alias
|
320
|
+
# The organization alias.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] client_token
|
324
|
+
# The idempotency token associated with the request.
|
325
|
+
#
|
326
|
+
# **A suitable default value is auto-generated.** You should normally
|
327
|
+
# not need to pass this option.
|
328
|
+
# @return [String]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] domains
|
331
|
+
# The email domains to associate with the organization.
|
332
|
+
# @return [Array<Types::Domain>]
|
333
|
+
#
|
334
|
+
# @!attribute [rw] kms_key_arn
|
335
|
+
# The Amazon Resource Name (ARN) of a customer managed master key from
|
336
|
+
# AWS KMS.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] enable_interoperability
|
340
|
+
# When `true`, allows organization interoperability between Amazon
|
341
|
+
# WorkMail and Microsoft Exchange. Can only be set to `true` if an AD
|
342
|
+
# Connector directory ID is included in the request.
|
343
|
+
# @return [Boolean]
|
344
|
+
#
|
345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganizationRequest AWS API Documentation
|
346
|
+
#
|
347
|
+
class CreateOrganizationRequest < Struct.new(
|
348
|
+
:directory_id,
|
349
|
+
:alias,
|
350
|
+
:client_token,
|
351
|
+
:domains,
|
352
|
+
:kms_key_arn,
|
353
|
+
:enable_interoperability)
|
354
|
+
SENSITIVE = []
|
355
|
+
include Aws::Structure
|
356
|
+
end
|
357
|
+
|
358
|
+
# @!attribute [rw] organization_id
|
359
|
+
# The organization ID.
|
360
|
+
# @return [String]
|
361
|
+
#
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganizationResponse AWS API Documentation
|
363
|
+
#
|
364
|
+
class CreateOrganizationResponse < Struct.new(
|
365
|
+
:organization_id)
|
366
|
+
SENSITIVE = []
|
367
|
+
include Aws::Structure
|
368
|
+
end
|
369
|
+
|
298
370
|
# @note When making an API call, you may pass CreateResourceRequest
|
299
371
|
# data as a hash:
|
300
372
|
#
|
@@ -355,8 +427,8 @@ module Aws::WorkMail
|
|
355
427
|
# @return [String]
|
356
428
|
#
|
357
429
|
# @!attribute [rw] name
|
358
|
-
# The name for the new user.
|
359
|
-
#
|
430
|
+
# The name for the new user. WorkMail directory user names have a
|
431
|
+
# maximum length of 64. All others have a maximum length of 20.
|
360
432
|
# @return [String]
|
361
433
|
#
|
362
434
|
# @!attribute [rw] display_name
|
@@ -522,7 +594,7 @@ module Aws::WorkMail
|
|
522
594
|
# @return [String]
|
523
595
|
#
|
524
596
|
# @!attribute [rw] entity_id
|
525
|
-
# The identifier of the member (user or group)that owns the mailbox.
|
597
|
+
# The identifier of the member (user or group) that owns the mailbox.
|
526
598
|
# @return [String]
|
527
599
|
#
|
528
600
|
# @!attribute [rw] grantee_id
|
@@ -544,6 +616,58 @@ module Aws::WorkMail
|
|
544
616
|
#
|
545
617
|
class DeleteMailboxPermissionsResponse < Aws::EmptyStructure; end
|
546
618
|
|
619
|
+
# @note When making an API call, you may pass DeleteOrganizationRequest
|
620
|
+
# data as a hash:
|
621
|
+
#
|
622
|
+
# {
|
623
|
+
# client_token: "IdempotencyClientToken",
|
624
|
+
# organization_id: "OrganizationId", # required
|
625
|
+
# delete_directory: false, # required
|
626
|
+
# }
|
627
|
+
#
|
628
|
+
# @!attribute [rw] client_token
|
629
|
+
# The idempotency token associated with the request.
|
630
|
+
#
|
631
|
+
# **A suitable default value is auto-generated.** You should normally
|
632
|
+
# not need to pass this option.
|
633
|
+
# @return [String]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] organization_id
|
636
|
+
# The organization ID.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] delete_directory
|
640
|
+
# If true, deletes the AWS Directory Service directory associated with
|
641
|
+
# the organization.
|
642
|
+
# @return [Boolean]
|
643
|
+
#
|
644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganizationRequest AWS API Documentation
|
645
|
+
#
|
646
|
+
class DeleteOrganizationRequest < Struct.new(
|
647
|
+
:client_token,
|
648
|
+
:organization_id,
|
649
|
+
:delete_directory)
|
650
|
+
SENSITIVE = []
|
651
|
+
include Aws::Structure
|
652
|
+
end
|
653
|
+
|
654
|
+
# @!attribute [rw] organization_id
|
655
|
+
# The organization ID.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] state
|
659
|
+
# The state of the organization.
|
660
|
+
# @return [String]
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganizationResponse AWS API Documentation
|
663
|
+
#
|
664
|
+
class DeleteOrganizationResponse < Struct.new(
|
665
|
+
:organization_id,
|
666
|
+
:state)
|
667
|
+
SENSITIVE = []
|
668
|
+
include Aws::Structure
|
669
|
+
end
|
670
|
+
|
547
671
|
# @note When making an API call, you may pass DeleteResourceRequest
|
548
672
|
# data as a hash:
|
549
673
|
#
|
@@ -1055,6 +1179,20 @@ module Aws::WorkMail
|
|
1055
1179
|
include Aws::Structure
|
1056
1180
|
end
|
1057
1181
|
|
1182
|
+
# The directory is already in use by another WorkMail organization in
|
1183
|
+
# the same account and Region.
|
1184
|
+
#
|
1185
|
+
# @!attribute [rw] message
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DirectoryInUseException AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class DirectoryInUseException < Struct.new(
|
1191
|
+
:message)
|
1192
|
+
SENSITIVE = []
|
1193
|
+
include Aws::Structure
|
1194
|
+
end
|
1195
|
+
|
1058
1196
|
# The directory service doesn't recognize the credentials supplied by
|
1059
1197
|
# WorkMail.
|
1060
1198
|
#
|
@@ -1069,8 +1207,8 @@ module Aws::WorkMail
|
|
1069
1207
|
include Aws::Structure
|
1070
1208
|
end
|
1071
1209
|
|
1072
|
-
# The directory
|
1073
|
-
#
|
1210
|
+
# The directory is unavailable. It might be located in another Region or
|
1211
|
+
# deleted.
|
1074
1212
|
#
|
1075
1213
|
# @!attribute [rw] message
|
1076
1214
|
# @return [String]
|
@@ -1155,6 +1293,43 @@ module Aws::WorkMail
|
|
1155
1293
|
#
|
1156
1294
|
class DisassociateMemberFromGroupResponse < Aws::EmptyStructure; end
|
1157
1295
|
|
1296
|
+
# The domain to associate with an Amazon WorkMail organization.
|
1297
|
+
#
|
1298
|
+
# When you configure a domain hosted in Amazon Route 53 (Route 53), all
|
1299
|
+
# recommended DNS records are added to the organization when you create
|
1300
|
+
# it. For more information, see [Adding a domain][1] in the *Amazon
|
1301
|
+
# WorkMail Administrator Guide*.
|
1302
|
+
#
|
1303
|
+
#
|
1304
|
+
#
|
1305
|
+
# [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html
|
1306
|
+
#
|
1307
|
+
# @note When making an API call, you may pass Domain
|
1308
|
+
# data as a hash:
|
1309
|
+
#
|
1310
|
+
# {
|
1311
|
+
# domain_name: "DomainName",
|
1312
|
+
# hosted_zone_id: "HostedZoneId",
|
1313
|
+
# }
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] domain_name
|
1316
|
+
# The fully qualified domain name.
|
1317
|
+
# @return [String]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] hosted_zone_id
|
1320
|
+
# The hosted zone ID for a domain hosted in Route 53. Required when
|
1321
|
+
# configuring a domain hosted in Route 53.
|
1322
|
+
# @return [String]
|
1323
|
+
#
|
1324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Domain AWS API Documentation
|
1325
|
+
#
|
1326
|
+
class Domain < Struct.new(
|
1327
|
+
:domain_name,
|
1328
|
+
:hosted_zone_id)
|
1329
|
+
SENSITIVE = []
|
1330
|
+
include Aws::Structure
|
1331
|
+
end
|
1332
|
+
|
1158
1333
|
# The email address that you're trying to assign is already created for
|
1159
1334
|
# a different user, group, or resource.
|
1160
1335
|
#
|
@@ -2179,8 +2354,8 @@ module Aws::WorkMail
|
|
2179
2354
|
include Aws::Structure
|
2180
2355
|
end
|
2181
2356
|
|
2182
|
-
# The organization must have a valid state
|
2183
|
-
#
|
2357
|
+
# The organization must have a valid state to perform certain operations
|
2358
|
+
# on the organization or its members.
|
2184
2359
|
#
|
2185
2360
|
# @!attribute [rw] message
|
2186
2361
|
# @return [String]
|
@@ -2203,6 +2378,10 @@ module Aws::WorkMail
|
|
2203
2378
|
# The alias associated with the organization.
|
2204
2379
|
# @return [String]
|
2205
2380
|
#
|
2381
|
+
# @!attribute [rw] default_mail_domain
|
2382
|
+
# The default email domain associated with the organization.
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2206
2385
|
# @!attribute [rw] error_message
|
2207
2386
|
# The error message associated with the organization. It is only
|
2208
2387
|
# present if unexpected behavior has occurred with regards to the
|
@@ -2219,6 +2398,7 @@ module Aws::WorkMail
|
|
2219
2398
|
class OrganizationSummary < Struct.new(
|
2220
2399
|
:organization_id,
|
2221
2400
|
:alias,
|
2401
|
+
:default_mail_domain,
|
2222
2402
|
:error_message,
|
2223
2403
|
:state)
|
2224
2404
|
SENSITIVE = []
|
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.35.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:
|
11
|
+
date: 2021-02-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|