Amazon WorkMail

2019/05/03 - Amazon WorkMail - 2 new api methods

Changes  Amazon WorkMail is releasing two new actions: 'GetMailboxDetails' and 'UpdateMailboxQuota'. They add insight into how much space is used by a given mailbox (size) and what its limit is (quota). A mailbox quota can be updated, but lowering the value will not influence WorkMail per user charges. For a closer look at the actions please visit https://docs.aws.amazon.com/workmail/latest/APIReference/API_Operations.html

GetMailboxDetails (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_mailbox_details(
    OrganizationId='string',
    UserId='string'
)
type OrganizationId

string

param OrganizationId

[REQUIRED]

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

type UserId

string

param UserId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'MailboxQuota': 123,
    'MailboxSize': 123.0
}

Response Structure

  • (dict) --

    • MailboxQuota (integer) --

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

    • MailboxSize (float) --

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

UpdateMailboxQuota (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_mailbox_quota(
    OrganizationId='string',
    UserId='string',
    MailboxQuota=123
)
type OrganizationId

string

param OrganizationId

[REQUIRED]

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

type UserId

string

param UserId

[REQUIRED]

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

type MailboxQuota

integer

param MailboxQuota

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --