Amazon WorkMail · JSON Structure

Workmail Describe Organization Response Structure

DescribeOrganizationResponse schema from Amazon WorkMail API

Type: object Properties: 9
Business CommunicationCalendarEmailExchangeEnterprise

DescribeOrganizationResponse is a JSON Structure definition published by Amazon WorkMail, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

OrganizationId Alias State DirectoryId DirectoryType DefaultMailDomain CompletedDate ErrorMessage ARN

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier of an organization."
        }
      ]
    },
    "Alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationName"
        },
        {
          "description": "The alias for an organization."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The state of an organization."
        }
      ]
    },
    "DirectoryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The identifier for the directory associated with an WorkMail organization."
        }
      ]
    },
    "DirectoryType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The type of directory associated with the WorkMail organization."
        }
      ]
    },
    "DefaultMailDomain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The default mail domain associated with the organization."
        }
      ]
    },
    "CompletedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date at which the organization became usable in the WorkMail context, in UNIX epoch time format."
        }
      ]
    },
    "ErrorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization."
        }
      ]
    },
    "ARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonResourceName"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the organization."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "DescribeOrganizationResponse",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-describe-organization-response-structure.json",
  "description": "DescribeOrganizationResponse schema from Amazon WorkMail API"
}