Amazon WorkMail · JSON Structure

Workmail Describe Group Response Structure

DescribeGroupResponse schema from Amazon WorkMail API

Type: object Properties: 6
Business CommunicationCalendarEmailExchangeEnterprise

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

Properties

GroupId Name Email State EnabledDate DisabledDate

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "GroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The identifier of the described group."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        },
        {
          "description": "The name of the described group."
        }
      ]
    },
    "Email": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailAddress"
        },
        {
          "description": "The email of the described group."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityState"
        },
        {
          "description": "The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail)."
        }
      ]
    },
    "EnabledDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when a user was registered to WorkMail, in UNIX epoch time format."
        }
      ]
    },
    "DisabledDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when a user was deregistered from WorkMail, in UNIX epoch time format."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "DescribeGroupResponse",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-describe-group-response-structure.json",
  "description": "DescribeGroupResponse schema from Amazon WorkMail API"
}