[ aws . workmail ]



Gets the effects of an organization’s access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--organization-id <value>
--ip-address <value>
--action <value>
--user-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--organization-id (string)

The identifier for the organization.

--ip-address (string)

The IPv4 address.

--action (string)

The access protocol action. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

--user-id (string)

The user ID.

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



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get the effect of access control rules

The following get-access-control-effect example retrieves the effect of the specified Amazon WorkMail organization’s access control rules for the specified IP address, access protocol action, and user ID.

aws workmail get-access-control-effect \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza \
    --ip-address "" \
    --action "WindowsOutlook" \
    --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333"


    "Effect": "DENY",
    "MatchedRules": [

For more information, see Working with Access Control Rules in the Amazon WorkMail Administrator Guide.


Effect -> (string)

The rule effect.

MatchedRules -> (list)

The rules that match the given parameters, resulting in an effect.