libZSservicesZSamazonka-workmailZSamazonka-workmail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkMail.CreateOrganization

Description

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.

Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.

Synopsis

Creating a Request

data CreateOrganization Source #

See: newCreateOrganization smart constructor.

Constructors

CreateOrganization' 

Fields

Instances

Instances details
Eq CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Read CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Show CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Generic CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Associated Types

type Rep CreateOrganization :: Type -> Type #

NFData CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Methods

rnf :: CreateOrganization -> () #

Hashable CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

ToJSON CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

AWSRequest CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Associated Types

type AWSResponse CreateOrganization #

ToHeaders CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

ToPath CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

ToQuery CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

type Rep CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

type Rep CreateOrganization = D1 ('MetaData "CreateOrganization" "Amazonka.WorkMail.CreateOrganization" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "CreateOrganization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enableInteroperability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Domain])) :*: S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateOrganization Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

newCreateOrganization Source #

Create a value of CreateOrganization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directoryId:CreateOrganization', createOrganization_directoryId - The AWS Directory Service directory ID.

$sel:enableInteroperability:CreateOrganization', createOrganization_enableInteroperability - When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.

$sel:kmsKeyArn:CreateOrganization', createOrganization_kmsKeyArn - The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.

$sel:clientToken:CreateOrganization', createOrganization_clientToken - The idempotency token associated with the request.

$sel:domains:CreateOrganization', createOrganization_domains - The email domains to associate with the organization.

$sel:alias:CreateOrganization', createOrganization_alias - The organization alias.

Request Lenses

createOrganization_directoryId :: Lens' CreateOrganization (Maybe Text) Source #

The AWS Directory Service directory ID.

createOrganization_enableInteroperability :: Lens' CreateOrganization (Maybe Bool) Source #

When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.

createOrganization_kmsKeyArn :: Lens' CreateOrganization (Maybe Text) Source #

The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.

createOrganization_clientToken :: Lens' CreateOrganization (Maybe Text) Source #

The idempotency token associated with the request.

createOrganization_domains :: Lens' CreateOrganization (Maybe [Domain]) Source #

The email domains to associate with the organization.

Destructuring the Response

data CreateOrganizationResponse Source #

See: newCreateOrganizationResponse smart constructor.

Constructors

CreateOrganizationResponse' 

Fields

Instances

Instances details
Eq CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Read CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Show CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Generic CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

Associated Types

type Rep CreateOrganizationResponse :: Type -> Type #

NFData CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

type Rep CreateOrganizationResponse Source # 
Instance details

Defined in Amazonka.WorkMail.CreateOrganization

type Rep CreateOrganizationResponse = D1 ('MetaData "CreateOrganizationResponse" "Amazonka.WorkMail.CreateOrganization" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "CreateOrganizationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateOrganizationResponse Source #

Create a value of CreateOrganizationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationId:CreateOrganizationResponse', createOrganizationResponse_organizationId - The organization ID.

$sel:httpStatus:CreateOrganizationResponse', createOrganizationResponse_httpStatus - The response's http status code.

Response Lenses