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 |
JSON Schema
{
"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"
}