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

UpdateMailboxQuota

Updates a user's current mailbox quota for a specified organization and user.

Request Syntax

{ "MailboxQuota": number, "OrganizationId": "string", "UserId": "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.

MailboxQuota

The updated mailbox quota, in MB, for the specified user.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

OrganizationId

The identifier for the organization that contains the user for whom to update the mailbox quota.

Type: String

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

Required: Yes

UserId

The identifer for the user for whom to update the mailbox quota.

Type: String

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

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 delete an active 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: