PutMailboxPermissionsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, PutMailboxPermissionsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, PutMailboxPermissionsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // PutMailboxPermissionsRequest
  OrganizationId: "STRING_VALUE", // required
  EntityId: "STRING_VALUE", // required
  GranteeId: "STRING_VALUE", // required
  PermissionValues: [ // PermissionValues // required
    "FULL_ACCESS" || "SEND_AS" || "SEND_ON_BEHALF",
  ],
};
const command = new PutMailboxPermissionsCommand(input);
const response = await client.send(command);
// {};

PutMailboxPermissionsCommand Input

See PutMailboxPermissionsCommandInput for more details

Parameter
Type
Description
EntityId
Required
string | undefined

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: entitydomain.tld

  • Entity name: entity

GranteeId
Required
string | undefined

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: granteedomain.tld

  • Grantee name: grantee

OrganizationId
Required
string | undefined

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

PermissionValues
Required
PermissionType[] | undefined

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.

PutMailboxPermissionsCommand Output

See PutMailboxPermissionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
EntityNotFoundException
client

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException
client

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException
client

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.