Amazon WorkMail · Schema

OrganizationSummary

The representation of an organization.

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
OrganizationId object
Alias object
DefaultMailDomain object
ErrorMessage object
State object
View JSON Schema on GitHub

JSON Schema

workmail-organization-summary-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier associated with the organization."
        }
      ]
    },
    "Alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationName"
        },
        {
          "description": "The alias associated with the organization."
        }
      ]
    },
    "DefaultMailDomain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainName"
        },
        {
          "description": "The default email domain associated with the organization."
        }
      ]
    },
    "ErrorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The state associated with the organization."
        }
      ]
    }
  },
  "description": "The representation of an organization.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrganizationSummary",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-organization-summary-schema.json"
}