WorkMail / Client / create_organization

create_organization#

WorkMail.Client.create_organization(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_organization(
    DirectoryId='string',
    Alias='string',
    ClientToken='string',
    Domains=[
        {
            'DomainName': 'string',
            'HostedZoneId': 'string'
        },
    ],
    KmsKeyArn='string',
    EnableInteroperability=True|False
)
Parameters:

  • DirectoryId (string) – The AWS Directory Service directory ID.

  • Alias (string) –

    [REQUIRED]

    The organization alias.

  • ClientToken (string) –

    The idempotency token associated with the request.

    This field is autopopulated if not provided.

  • Domains (list) –

    The email domains to associate with the organization.

    • (dict) –

      The domain to associate with an WorkMail organization.

      When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.

      • DomainName (string) –

        The fully qualified domain name.

      • HostedZoneId (string) –

        The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationId': 'string'
}

Response Structure

  • (dict) –

    • OrganizationId (string) –

      The organization ID.

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.DirectoryInUseException

  • WorkMail.Client.exceptions.DirectoryUnavailableException

  • WorkMail.Client.exceptions.LimitExceededException

  • WorkMail.Client.exceptions.NameAvailabilityException