Menu
Amazon WorkMail
API Reference (API Version 2017-10-01)

PutMailboxPermissions

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

Request Syntax

{ "EntityId": "string", "GranteeId": "string", "OrganizationId": "string", "PermissionValues": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EntityId

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

GranteeId

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

OrganizationId

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

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

PermissionValues

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.

Type: Array of strings

Valid Values: FULL_ACCESS | SEND_AS | SEND_ON_BEHALF

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

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

HTTP Status Code: 400

EntityStateException

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

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

OrganizationNotFoundException

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

HTTP Status Code: 400

OrganizationStateException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: