Amazon WorkMail · JSON Structure

Workmail Create Organization Request Structure

CreateOrganizationRequest schema from Amazon WorkMail API

Type: object Properties: 6 Required: 1
Business CommunicationCalendarEmailExchangeEnterprise

CreateOrganizationRequest is a JSON Structure definition published by Amazon WorkMail, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DirectoryId Alias ClientToken Domains KmsKeyArn EnableInteroperability

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "Alias"
  ],
  "name": "CreateOrganizationRequest",
  "properties": {
    "DirectoryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectoryId"
        },
        {
          "description": "The AWS Directory Service directory ID."
        }
      ]
    },
    "Alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationName"
        },
        {
          "description": "The organization alias."
        }
      ]
    },
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyClientToken"
        },
        {
          "description": "The idempotency token associated with the request."
        }
      ]
    },
    "Domains": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Domains"
        },
        {
          "description": "The email domains to associate with the organization."
        }
      ]
    },
    "KmsKeyArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of a customer managed key from AWS KMS."
        }
      ]
    },
    "EnableInteroperability": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "When <code>true</code>, allows organization interoperability between WorkMail and Microsoft Exchange. If <code>true</code>, you must include a AD Connector directory ID in the request."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-create-organization-request-structure.json",
  "description": "CreateOrganizationRequest schema from Amazon WorkMail API"
}