Amazon WorkMail · Schema

AccessControlRule

A rule that controls access to an WorkMail organization.

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
Name object
Effect object
Description object
IpRanges object
NotIpRanges object
Actions object
NotActions object
UserIds object
NotUserIds object
DateCreated object
DateModified object
ImpersonationRoleIds object
NotImpersonationRoleIds object
View JSON Schema on GitHub

JSON Schema

workmail-access-control-rule-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessControlRuleName"
        },
        {
          "description": "The rule name."
        }
      ]
    },
    "Effect": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessControlRuleEffect"
        },
        {
          "description": "The rule effect."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessControlRuleDescription"
        },
        {
          "description": "The rule description."
        }
      ]
    },
    "IpRanges": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpRangeList"
        },
        {
          "description": "IPv4 CIDR ranges to include in the rule."
        }
      ]
    },
    "NotIpRanges": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpRangeList"
        },
        {
          "description": "IPv4 CIDR ranges to exclude from the rule."
        }
      ]
    },
    "Actions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionsList"
        },
        {
          "description": "Access protocol actions to include in the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>."
        }
      ]
    },
    "NotActions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionsList"
        },
        {
          "description": "Access protocol actions to exclude from the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>."
        }
      ]
    },
    "UserIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserIdList"
        },
        {
          "description": "User IDs to include in the rule."
        }
      ]
    },
    "NotUserIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserIdList"
        },
        {
          "description": "User IDs to exclude from the rule."
        }
      ]
    },
    "DateCreated": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date that the rule was created."
        }
      ]
    },
    "DateModified": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date that the rule was modified."
        }
      ]
    },
    "ImpersonationRoleIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleIdList"
        },
        {
          "description": "Impersonation role IDs to include in the rule."
        }
      ]
    },
    "NotImpersonationRoleIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleIdList"
        },
        {
          "description": "Impersonation role IDs to exclude from the rule."
        }
      ]
    }
  },
  "description": "A rule that controls access to an WorkMail organization.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AccessControlRule",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-access-control-rule-schema.json"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/workmail-access-control-rule"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.