AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workmail ]

list-mobile-device-access-rules

Description

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

See also: AWS API Documentation

Synopsis

  list-mobile-device-access-rules
--organization-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--organization-id (string)

The WorkMail organization for which to list the rules.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Rules -> (list)

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

(structure)

A rule that controls access to mobile devices for an 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.