Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workmail ]

put-mailbox-permissions

Description

Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.

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 <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier of the organization under which the entity (user or group) exists.

--entity-id (string)

The identifier of the entity (user or group) for which to update mailbox permissions.

--grantee-id (string)

The identifier of the entity (user or group) 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.

Syntax:

"string" "string" ...

Where valid values are:
  FULL_ACCESS
  SEND_AS
  SEND_ON_BEHALF

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

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

Output