PutMobileDeviceAccessOverride
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
Request Syntax
{
"Description": "string",
"DeviceId": "string",
"Effect": "string",
"OrganizationId": "string",
"UserId": "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.
- Description
-
A description of the override.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S\s]+Required: No
- DeviceId
-
The mobile device for which you create the override.
DeviceIdis case insensitive.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[A-Za-z0-9]+Required: Yes
- Effect
-
The effect of the override,
ALLOWorDENY.Type: String
Valid Values:
ALLOW | DENYRequired: Yes
- OrganizationId
-
Identifies the WorkMail organization for which you create the override.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- UserId
-
The WorkMail user for which you create the override. Accepts the following types of user identities:
-
User ID:
12345678-1234-1234-1234-123456789012orS-1-1-12-1234567890-123456789-123456789-1234 -
Email address:
user@domain.tld -
User name:
user
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400
- EntityStateException
-
You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
HTTP Status Code: 400
- 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:
