Amazon WorkMail · Schema

DescribeGroupResponse

DescribeGroupResponse schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
GroupId object
Name object
Email object
State object
EnabledDate object
DisabledDate object
View JSON Schema on GitHub

JSON Schema

workmail-describe-group-response-schema.json 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-schema.org/draft/2020-12/schema",
  "title": "DescribeGroupResponse",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-describe-group-response-schema.json",
  "description": "DescribeGroupResponse schema from Amazon WorkMail API"
}