Table Of Contents

Feedback

User Guide

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

[ aws . workmail ]

list-mailbox-permissions

Description

Lists the mailbox permissions associated with a mailbox.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-mailbox-permissions
--organization-id <value>
--entity-id <value>
[--next-token <value>]
[--max-results <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 list mailbox permissions.

--next-token (string)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

--max-results (integer)

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

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

Permissions -> (list)

One page of the entity's mailbox permissions.

(structure)

Permission granted to an entity (user, group) to access a certain aspect of another entity's mailbox.

GranteeId -> (string)

The identifier of the entity (user or group) to which the permissions are granted.

GranteeType -> (string)

The type of entity (user, group) of the entity referred to in GranteeId.

PermissionValues -> (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)

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.