[ aws . workmail ]

list-mobile-device-access-rules

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-mobile-device-access-rules
--organization-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The Amazon WorkMail organization for which to list the rules.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Rules -> (list)

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

(structure)

A rule that controls access to mobile devices for an Amazon WorkMail group.

MobileDeviceAccessRuleId -> (string)

The ID assigned to a mobile access rule.

Name -> (string)

The name of a mobile access rule.

Description -> (string)

The description of a mobile access rule.

Effect -> (string)

The effect of the rule when it matches. Allowed values are ALLOW or DENY .

DeviceTypes -> (list)

Device types that a rule will match.

(string)

NotDeviceTypes -> (list)

Device types that a rule will not match. All other device types will match.

(string)

DeviceModels -> (list)

Device models that a rule will match.

(string)

NotDeviceModels -> (list)

Device models that a rule will not match. All other device models will match.

(string)

DeviceOperatingSystems -> (list)

Device operating systems that a rule will match.

(string)

NotDeviceOperatingSystems -> (list)

Device operating systems that a rule will not match. All other device types will match.

(string)

DeviceUserAgents -> (list)

Device user agents that a rule will match.

(string)

NotDeviceUserAgents -> (list)

Device user agents that a rule will not match. All other device user agents will match.

(string)

DateCreated -> (timestamp)

The date and time at which an access rule was created.

DateModified -> (timestamp)

The date and time at which an access rule was modified.