GetMobileDeviceAccessEffect
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
Request Syntax
{
"DeviceModel": "string",
"DeviceOperatingSystem": "string",
"DeviceType": "string",
"DeviceUserAgent": "string",
"OrganizationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DeviceModel
-
Device model the simulated user will report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceOperatingSystem
-
Device operating system the simulated user will report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceType
-
Device type the simulated user will report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- DeviceUserAgent
-
Device user agent the simulated user will report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u00FF]+Required: No
- OrganizationId
-
The WorkMail organization to simulate the access effect for.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"Effect": "string",
"MatchedRules": [
{
"MobileDeviceAccessRuleId": "string",
"Name": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Effect
-
The effect of the simulated access,
ALLOWorDENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.Type: String
Valid Values:
ALLOW | DENY - MatchedRules
-
A list of the rules which matched the simulated user input and produced the effect.
Type: Array of MobileDeviceAccessMatchedRule objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
