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

GetMailboxDetails

Requests a user's mailbox details for a specified organization and user.

Request Syntax

{ "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.

OrganizationId

The identifier for the organization that contains the user whose mailbox details are being requested.

Type: String

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

Required: Yes

UserId

The identifier for the user whose mailbox details are being requested.

Type: String

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

Required: Yes

Response Syntax

{ "MailboxQuota": number, "MailboxSize": number }

Response Elements

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

The following data is returned in JSON format by the service.

MailboxQuota

The maximum allowed mailbox size, in MB, for the specified user.

Type: Integer

Valid Range: Minimum value of 1.

MailboxSize

The current mailbox size, in MB, for the specified user.

Type: Double

Valid Range: Minimum value of 0.

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

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: