Amazon WorkMail · Schema

CreateMobileDeviceAccessRuleRequest

CreateMobileDeviceAccessRuleRequest schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
OrganizationId object
ClientToken object
Name object
Description object
Effect object
DeviceTypes object
NotDeviceTypes object
DeviceModels object
NotDeviceModels object
DeviceOperatingSystems object
NotDeviceOperatingSystems object
DeviceUserAgents object
NotDeviceUserAgents object
View JSON Schema on GitHub

JSON Schema

workmail-create-mobile-device-access-rule-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "OrganizationId",
    "Name",
    "Effect"
  ],
  "title": "CreateMobileDeviceAccessRuleRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The WorkMail organization under which the rule will be created."
        }
      ]
    },
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyClientToken"
        },
        {
          "description": "The idempotency token for the client request."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MobileDeviceAccessRuleName"
        },
        {
          "description": "The rule name."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MobileDeviceAccessRuleDescription"
        },
        {
          "description": "The rule description."
        }
      ]
    },
    "Effect": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MobileDeviceAccessRuleEffect"
        },
        {
          "description": "The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>."
        }
      ]
    },
    "DeviceTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceTypeList"
        },
        {
          "description": "Device types that the rule will match."
        }
      ]
    },
    "NotDeviceTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceTypeList"
        },
        {
          "description": "Device types that the rule <b>will not</b> match. All other device types will match."
        }
      ]
    },
    "DeviceModels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceModelList"
        },
        {
          "description": "Device models that the rule will match."
        }
      ]
    },
    "NotDeviceModels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceModelList"
        },
        {
          "description": "Device models that the rule <b>will not</b> match. All other device models will match."
        }
      ]
    },
    "DeviceOperatingSystems": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceOperatingSystemList"
        },
        {
          "description": "Device operating systems that the rule will match."
        }
      ]
    },
    "NotDeviceOperatingSystems": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceOperatingSystemList"
        },
        {
          "description": "Device operating systems that the rule <b>will not</b> match. All other device operating systems will match."
        }
      ]
    },
    "DeviceUserAgents": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceUserAgentList"
        },
        {
          "description": "Device user agents that the rule will match."
        }
      ]
    },
    "NotDeviceUserAgents": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceUserAgentList"
        },
        {
          "description": "Device user agents that the rule <b>will not</b> match. All other device user agents will match."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-create-mobile-device-access-rule-request-schema.json",
  "description": "CreateMobileDeviceAccessRuleRequest schema from Amazon WorkMail API"
}