mailbox_details

Creates, updates, deletes, gets or lists a mailbox_details resource.

Overview

Name	mailbox_details
Type	Resource
Id	aws.workmail.mailbox_details

Fields

The following fields are returned by SELECT queries:

get_mailbox_details

Name	Datatype	Description
mailbox_quota	integer	The maximum allowed mailbox size, in MB, for the specified user.
mailbox_size	number (double)	The current mailbox size, in MB, for the specified user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_mailbox_details	select	region		Requests a user's mailbox details for a specified organization and user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_mailbox_details

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

SELECT
mailbox_quota,
mailbox_size
FROM aws.workmail.mailbox_details
WHERE region = '{{ region }}' -- required
;