Amazon WorkMail · Schema

ImpersonationRule

The rules for the given impersonation role.

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
ImpersonationRuleId object
Name object
Description object
Effect object
TargetUsers object
NotTargetUsers object
View JSON Schema on GitHub

JSON Schema

workmail-impersonation-rule-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "ImpersonationRuleId",
    "Effect"
  ],
  "properties": {
    "ImpersonationRuleId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRuleId"
        },
        {
          "description": "The identifier of the rule."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRuleName"
        },
        {
          "description": "The rule name."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRuleDescription"
        },
        {
          "description": "The rule description."
        }
      ]
    },
    "Effect": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessEffect"
        },
        {
          "description": "The effect of the rule when it matches the input. Allowed effect values are <code>ALLOW</code> or <code>DENY</code>."
        }
      ]
    },
    "TargetUsers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetUsers"
        },
        {
          "description": "A list of user IDs that match the rule."
        }
      ]
    },
    "NotTargetUsers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetUsers"
        },
        {
          "description": "A list of user IDs that don't match the rule."
        }
      ]
    }
  },
  "description": "The rules for the given impersonation role.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ImpersonationRule",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-impersonation-rule-schema.json"
}