WorkMail / Client / put_mailbox_permissions

put_mailbox_permissions

WorkMail.Client.put_mailbox_permissions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    GranteeId='string',
    PermissionValues=[
        'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
    ]
)
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 or resource for which to update mailbox permissions.

    The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

  • GranteeId (string) –

    [REQUIRED]

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

    The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

    • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: grantee@domain.tld

    • Grantee name: grantee

  • PermissionValues (list) –

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions