CreateMobileDeviceAccessRule
Creates a new mobile device access rule for the specified WorkMail organization.
Request Syntax
{
"ClientToken": "string",
"Description": "string",
"DeviceModels": [ "string" ],
"DeviceOperatingSystems": [ "string" ],
"DeviceTypes": [ "string" ],
"DeviceUserAgents": [ "string" ],
"Effect": "string",
"Name": "string",
"NotDeviceModels": [ "string" ],
"NotDeviceOperatingSystems": [ "string" ],
"NotDeviceTypes": [ "string" ],
"NotDeviceUserAgents": [ "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.
- ClientToken
-
The idempotency token for the client request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\x21-\x7e]+Required: No
- Description
-
The rule description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S\s]+Required: No
- DeviceModels
-
Device models that the 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 the 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 the 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 the 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: Yes
- Name
-
The rule name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\S\s]+Required: Yes
- NotDeviceModels
-
Device models that the 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 the rule will not match. All other device operating systems 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 the 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 the 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
- OrganizationId
-
The WorkMail organization under which the rule will be created.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"MobileDeviceAccessRuleId": "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.
- MobileDeviceAccessRuleId
-
The identifier for the newly created mobile device access rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+
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
- LimitExceededException
-
The request exceeds the limit of the resource.
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:
