[ aws . workmail ]

create-mobile-device-access-rule

Description

Creates a new mobile device access rule for the specified Amazon WorkMail organization.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-mobile-device-access-rule
--organization-id <value>
[--client-token <value>]
--name <value>
[--description <value>]
--effect <value>
[--device-types <value>]
[--not-device-types <value>]
[--device-models <value>]
[--not-device-models <value>]
[--device-operating-systems <value>]
[--not-device-operating-systems <value>]
[--device-user-agents <value>]
[--not-device-user-agents <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The Amazon WorkMail organization under which the rule will be created.

--client-token (string)

The idempotency token for the client request.

--name (string)

The rule name.

--description (string)

The rule description.

--effect (string)

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

Possible values:

  • ALLOW

  • DENY

--device-types (list)

Device types that the rule will match.

(string)

Syntax:

"string" "string" ...

--not-device-types (list)

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

(string)

Syntax:

"string" "string" ...

--device-models (list)

Device models that the rule will match.

(string)

Syntax:

"string" "string" ...

--not-device-models (list)

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

(string)

Syntax:

"string" "string" ...

--device-operating-systems (list)

Device operating systems that the rule will match.

(string)

Syntax:

"string" "string" ...

--not-device-operating-systems (list)

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

(string)

Syntax:

"string" "string" ...

--device-user-agents (list)

Device user agents that the rule will match.

(string)

Syntax:

"string" "string" ...

--not-device-user-agents (list)

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

(string)

Syntax:

"string" "string" ...

--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

MobileDeviceAccessRuleId -> (string)

The identifier for the newly created mobile device access rule.