Amazon WorkMail

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

See also: AWS API Documentation

Request Syntax

client.put_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    GranteeId='string',
    PermissionValues=[
        'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
    ]
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

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

type EntityId:

string

param EntityId:

[REQUIRED]

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

type GranteeId:

string

param GranteeId:

[REQUIRED]

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

type PermissionValues:

list

param PermissionValues:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists the mailbox permissions associated with a mailbox.

See also: AWS API Documentation

Request Syntax

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

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

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

type EntityId:

string

param EntityId:

[REQUIRED]

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

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

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

rtype:

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 entity's mailbox permissions.

    • (dict) --

      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.

Deletes permissions granted to a user or group.

See also: AWS API Documentation

Request Syntax

client.delete_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    GranteeId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

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

type EntityId:

string

param EntityId:

[REQUIRED]

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

type GranteeId:

string

param GranteeId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --