MobileDeviceAccessRule
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
A rule that controls access to mobile devices for an WorkMail group.
Contents
- DateCreated
-
The date and time at which an access rule was created.
Type: Timestamp
Required: No
- DateModified
-
The date and time at which an access rule was modified.
Type: Timestamp
Required: No
- Description
-
The description of a mobile access rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S\s]+Required: No
- DeviceModels
-
Device models that a rule will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceOperatingSystems
-
Device operating systems that a rule will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceTypes
-
Device types that a rule will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceUserAgents
-
Device user agents that a rule will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- Effect
-
The effect of the rule when it matches. Allowed values are
ALLOWorDENY.Type: String
Valid Values:
ALLOW | DENYRequired: No
- MobileDeviceAccessRuleId
-
The ID assigned to a mobile access rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- Name
-
The name of a mobile access rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\S\s]+Required: No
- NotDeviceModels
-
Device models that a rule will not match. All other device models will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- NotDeviceOperatingSystems
-
Device operating systems that a rule will not match. All other device types will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- NotDeviceTypes
-
Device types that a rule will not match. All other device types will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- NotDeviceUserAgents
-
Device user agents that a rule will not match. All other device user agents will match.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
