Amazon WorkMail · JSON Structure

Workmail List Groups Request Structure

ListGroupsRequest schema from Amazon WorkMail API

Type: object Properties: 3 Required: 1
Business CommunicationCalendarEmailExchangeEnterprise

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

Properties

OrganizationId NextToken MaxResults

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "OrganizationId"
  ],
  "name": "ListGroupsRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier for the organization under which the groups exist."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The token to use to retrieve the next page of results. The first call does not contain any tokens."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "The maximum number of results to return in a single call."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-list-groups-request-structure.json",
  "description": "ListGroupsRequest schema from Amazon WorkMail API"
}