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 ]



Gets the 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.


--organization-id <value>
--user-id <value>
--device-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--organization-id (string)

The Amazon WorkMail organization to which you want to apply the override.

--user-id (string)

Identifies the WorkMail user for 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 to which the override applies. DeviceId is case insensitive.

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

See 'aws help' for descriptions of global parameters.


UserId -> (string)

The WorkMail user to which the access override applies.

DeviceId -> (string)

The device to which the access override applies.

Effect -> (string)

The effect of the override, ALLOW or DENY .

Description -> (string)

A description of the override.

DateCreated -> (timestamp)

The date the override was first created.

DateModified -> (timestamp)

The date the description was last modified.