Skip to content

Create Organization

workmail_create_organization R Documentation

Creates a new WorkMail organization

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.

Usage

workmail_create_organization(DirectoryId, Alias, ClientToken, Domains,
  KmsKeyArn, EnableInteroperability)

Arguments

DirectoryId

The AWS Directory Service directory ID.

Alias

[required] The organization alias.

ClientToken

The idempotency token associated with the request.

Domains

The email domains to associate with the organization.

KmsKeyArn

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

EnableInteroperability

When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.

Value

A list with the following syntax: 

list(
  OrganizationId = "string"
)

Request syntax

svc$create_organization(
  DirectoryId = "string",
  Alias = "string",
  ClientToken = "string",
  Domains = list(
    list(
      DomainName = "string",
      HostedZoneId = "string"
    )
  ),
  KmsKeyArn = "string",
  EnableInteroperability = TRUE|FALSE
)