mailbox_permissions

Creates, updates, deletes, gets or lists a mailbox_permissions resource.

Overview

Name	mailbox_permissions
Type	Resource
Id	aws.workmail.mailbox_permissions

Fields

The following fields are returned by SELECT queries:

list_mailbox_permissions

Name	Datatype	Description
grantee_id	string	The identifier of the user, group, or resource to which the permissions are granted.
grantee_type	string	The type of user, group, or resource referred to in GranteeId. (GROUP, USER)
permission_values	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_mailbox_permissions	select	region		Lists the mailbox permissions associated with a user, group, or resource mailbox.
put_mailbox_permissions	replace	region, OrganizationId, EntityId, GranteeId, PermissionValues		Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
delete_mailbox_permissions	delete	region		Deletes permissions granted to a member (user or group).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_mailbox_permissions

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

SELECT
grantee_id,
grantee_type,
permission_values
FROM aws.workmail.mailbox_permissions
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_mailbox_permissions

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

REPLACE aws.workmail.mailbox_permissions
SET 
OrganizationId = '{{ OrganizationId }}',
EntityId = '{{ EntityId }}',
GranteeId = '{{ GranteeId }}',
PermissionValues = '{{ PermissionValues }}'
WHERE 
region = '{{ region }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required
AND EntityId = '{{ EntityId }}' --required
AND GranteeId = '{{ GranteeId }}' --required
AND PermissionValues = '{{ PermissionValues }}' --required;

DELETE examples

delete_mailbox_permissions

Deletes permissions granted to a member (user or group).

DELETE FROM aws.workmail.mailbox_permissions
WHERE region = '{{ region }}' --required
;