ListMobileDeviceAccessRules - Amazon WorkMail

ListMobileDeviceAccessRules

Lists the mobile device access rules for the specified Amazon WorkMail organization.

Request Syntax

{ "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.

OrganizationId

The Amazon WorkMail organization for which to list the rules.

Type: String

Length Constraints: Fixed length of 34.

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

Required: Yes

Response Syntax

{ "Rules": [ { "DateCreated": number, "DateModified": number, "Description": "string", "DeviceModels": [ "string" ], "DeviceOperatingSystems": [ "string" ], "DeviceTypes": [ "string" ], "DeviceUserAgents": [ "string" ], "Effect": "string", "MobileDeviceAccessRuleId": "string", "Name": "string", "NotDeviceModels": [ "string" ], "NotDeviceOperatingSystems": [ "string" ], "NotDeviceTypes": [ "string" ], "NotDeviceUserAgents": [ "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.

Rules

The list of mobile device access rules that exist under the specified Amazon WorkMail organization.

Type: Array of MobileDeviceAccessRule 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: