[ aws . workmail ]



Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--organization-id <value>
[--user-id <value>]
[--device-id <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--organization-id (string)

The Amazon WorkMail organization under which to list mobile device access overrides.

--user-id (string)

The WorkMail user under which you list the mobile device access overrides. 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 access override applies.

--next-token (string)

The token to use to retrieve the next page of results. The first call does not require a token.

--max-results (integer)

The maximum number of results to return in a single call.

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


Overrides -> (list)

The list of mobile device access overrides that exist for the specified Amazon WorkMail organization and user.


The override object.

UserId -> (string)

The WorkMail user to which the access override applies.

DeviceId -> (string)

The device to which the 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 override was last modified.

NextToken -> (string)

The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.