[ aws . workmail ]

put-mailbox-permissions

Description

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-mailbox-permissions
--organization-id <value>
--entity-id <value>
--grantee-id <value>
--permission-values <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier of the organization under which the user, group, or resource exists.

--entity-id (string)

The identifier of the user, group, or resource for which to update mailbox permissions.

--grantee-id (string)

The identifier of the user, group, or resource to which to grant the permissions.

--permission-values (list)

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  FULL_ACCESS
  SEND_AS
  SEND_ON_BEHALF

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

Examples

To set mailbox permissions

The following put-mailbox-permissions command sets full access permissions for the specified grantee (user or group). The entity represents the owner of the mailbox.

aws workmail put-mailbox-permissions \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --grantee-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --permission-values FULL_ACCESS

This command produces no output.

Output

None