Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMobileDeviceAccessOverrides

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.

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

Request Syntax


{
   "DeviceId": "string",
   "MaxResults": number,
   "NextToken": "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.

DeviceId

The mobile device to which the access override applies.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [A-Za-z0-9]+

Required: No

MaxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to use to retrieve the next page of results. The first call does not require a token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Required: No

OrganizationId

The WorkMail organization under which to list mobile device access overrides.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

UserId

The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:

User ID: 12345678-1234-1234-1234-123456789012 or S-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: No

Response Syntax


{
   "NextToken": "string",
   "Overrides": [ 
      { 
         "DateCreated": number,
         "DateModified": number,
         "Description": "string",
         "DeviceId": "string",
         "Effect": "string",
         "UserId": "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.

NextToken

The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Overrides

The list of mobile device access overrides that exist for the specified WorkMail organization and user.

Type: Array of MobileDeviceAccessOverride objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

EntityNotFoundException

Important

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400