[ aws . workmail ]

put-access-control-rule

Description

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-access-control-rule
--name <value>
--effect <value>
--description <value>
[--ip-ranges <value>]
[--not-ip-ranges <value>]
[--actions <value>]
[--not-actions <value>]
[--user-ids <value>]
[--not-user-ids <value>]
--organization-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The rule name.

--effect (string)

The rule effect.

Possible values:

• ALLOW

• DENY

--description (string)

The rule description.

--ip-ranges (list)

IPv4 CIDR ranges to include in the rule.

(string)

Syntax:

"string" "string" ...

--not-ip-ranges (list)

IPv4 CIDR ranges to exclude from the rule.

(string)

Syntax:

"string" "string" ...

--actions (list)

Access protocol actions to include in the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

(string)

Syntax:

"string" "string" ...

--not-actions (list)

Access protocol actions to exclude from the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

(string)

Syntax:

"string" "string" ...

--user-ids (list)

User IDs to include in the rule.

(string)

Syntax:

"string" "string" ...

--not-user-ids (list)

User IDs to exclude from the rule.

(string)

Syntax:

"string" "string" ...

--organization-id (string)

The identifier of the organization.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To put a new access control rule

The following put-access-control-rule example denies the specified user access to the specified Amazon WorkMail organization.

aws workmail put-access-control-rule \
    --name "myRule" \
    --effect "DENY" \
    --description "my rule" \
    --user-ids "S-1-1-11-1111111111-2222222222-3333333333-3333" \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza

This command produces no output.

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

Output

None