list_mailbox_permissions

list_mailbox_permissions(**kwargs)

Lists the mailbox permissions associated with a user, group, or resource mailbox.

See also: AWS API Documentation

Request Syntax

response = client.list_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

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

• EntityId (string) --

  [REQUIRED]

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

• NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
• MaxResults (integer) -- The maximum number of results to return in a single call.

Return type

dict

Returns

Response Syntax

{
    'Permissions': [
        {
            'GranteeId': 'string',
            'GranteeType': 'GROUP'|'USER',
            'PermissionValues': [
                'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Permissions (list) --

    One page of the user, group, or resource mailbox permissions.

    • (dict) --

      Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

      • GranteeId (string) --

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

      • GranteeType (string) --

        The type of user, group, or resource 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.

Exceptions

• WorkMail.Client.exceptions.EntityNotFoundException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException