Amazon WorkMail · JSON Structure

Workmail Register Mail Domain Request Structure

RegisterMailDomainRequest schema from Amazon WorkMail API

Type: object Properties: 3 Required: 2
Business CommunicationCalendarEmailExchangeEnterprise

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

Properties

ClientToken OrganizationId DomainName

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "OrganizationId",
    "DomainName"
  ],
  "name": "RegisterMailDomainRequest",
  "properties": {
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyClientToken"
        },
        {
          "description": "Idempotency token used when retrying requests."
        }
      ]
    },
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The WorkMail organization under which you're creating the domain."
        }
      ]
    },
    "DomainName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailDomainName"
        },
        {
          "description": "The name of the mail domain to create in WorkMail and SES."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-register-mail-domain-request-structure.json",
  "description": "RegisterMailDomainRequest schema from Amazon WorkMail API"
}