[ aws . workmail ]

put-mobile-device-access-override

Description

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-mobile-device-access-override
--organization-id <value>
--user-id <value>
--device-id <value>
--effect <value>
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

Identifies the Amazon WorkMail organization for which you create the override.

--user-id (string)

The WorkMail user for which you create the override. 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

--device-id (string)

The mobile device for which you create the override. DeviceId is case insensitive.

--effect (string)

The effect of the override, ALLOW or DENY .

Possible values:

  • ALLOW

  • DENY

--description (string)

A description of the override.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None