| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.WorkMail.CreateOrganization
Description
Creates a new 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 WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the 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 WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
Synopsis
- data CreateOrganization = CreateOrganization' {}
- newCreateOrganization :: Text -> CreateOrganization
- createOrganization_clientToken :: Lens' CreateOrganization (Maybe Text)
- createOrganization_directoryId :: Lens' CreateOrganization (Maybe Text)
- createOrganization_domains :: Lens' CreateOrganization (Maybe [Domain])
- createOrganization_enableInteroperability :: Lens' CreateOrganization (Maybe Bool)
- createOrganization_kmsKeyArn :: Lens' CreateOrganization (Maybe Text)
- createOrganization_alias :: Lens' CreateOrganization Text
- data CreateOrganizationResponse = CreateOrganizationResponse' {
- organizationId :: Maybe Text
- httpStatus :: Int
- newCreateOrganizationResponse :: Int -> CreateOrganizationResponse
- createOrganizationResponse_organizationId :: Lens' CreateOrganizationResponse (Maybe Text)
- createOrganizationResponse_httpStatus :: Lens' CreateOrganizationResponse Int
Creating a Request
data CreateOrganization Source #
See: newCreateOrganization smart constructor.
Constructors
| CreateOrganization' | |
Fields
| |
Instances
newCreateOrganization Source #
Arguments
| :: Text | |
| -> CreateOrganization |
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:clientToken:CreateOrganization', createOrganization_clientToken - The idempotency token associated with the request.
$sel:directoryId:CreateOrganization', createOrganization_directoryId - The AWS Directory Service directory ID.
$sel:domains:CreateOrganization', createOrganization_domains - The email domains to associate with the organization.
$sel:enableInteroperability:CreateOrganization', createOrganization_enableInteroperability - When true, allows organization interoperability between WorkMail and
Microsoft Exchange. If true, you must include a AD Connector directory
ID in the request.
$sel:kmsKeyArn:CreateOrganization', createOrganization_kmsKeyArn - The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
CreateOrganization, createOrganization_alias - The organization alias.
Request Lenses
createOrganization_clientToken :: Lens' CreateOrganization (Maybe Text) Source #
The idempotency token associated with the request.
createOrganization_directoryId :: Lens' CreateOrganization (Maybe Text) Source #
The AWS Directory Service directory ID.
createOrganization_domains :: Lens' CreateOrganization (Maybe [Domain]) Source #
The email domains to associate with the organization.
createOrganization_enableInteroperability :: Lens' CreateOrganization (Maybe Bool) Source #
When true, allows organization interoperability between WorkMail and
Microsoft Exchange. If true, you must include a AD Connector directory
ID in the request.
createOrganization_kmsKeyArn :: Lens' CreateOrganization (Maybe Text) Source #
The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
createOrganization_alias :: Lens' CreateOrganization Text Source #
The organization alias.
Destructuring the Response
data CreateOrganizationResponse Source #
See: newCreateOrganizationResponse smart constructor.
Constructors
| CreateOrganizationResponse' | |
Fields
| |
Instances
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:
CreateOrganizationResponse, createOrganizationResponse_organizationId - The organization ID.
$sel:httpStatus:CreateOrganizationResponse', createOrganizationResponse_httpStatus - The response's http status code.
Response Lenses
createOrganizationResponse_organizationId :: Lens' CreateOrganizationResponse (Maybe Text) Source #
The organization ID.
createOrganizationResponse_httpStatus :: Lens' CreateOrganizationResponse Int Source #
The response's http status code.