aws_sdk_workmail/client/
get_mailbox_details.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetMailboxDetails`](crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization that contains the user whose mailbox details are being requested.</p><br>
    ///   - [`user_id(impl Into<String>)`](crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder::set_user_id):<br>required: **true**<br><p>The identifier for the user whose mailbox details are being requested.</p> <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p> <ul>  <li>   <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: user@domain.tld</p></li>  <li>   <p>User name: user</p></li> </ul><br>
    /// - On success, responds with [`GetMailboxDetailsOutput`](crate::operation::get_mailbox_details::GetMailboxDetailsOutput) with field(s):
    ///   - [`mailbox_quota(Option<i32>)`](crate::operation::get_mailbox_details::GetMailboxDetailsOutput::mailbox_quota): <p>The maximum allowed mailbox size, in MB, for the specified user.</p>
    ///   - [`mailbox_size(f64)`](crate::operation::get_mailbox_details::GetMailboxDetailsOutput::mailbox_size): <p>The current mailbox size, in MB, for the specified user.</p>
    /// - On failure, responds with [`SdkError<GetMailboxDetailsError>`](crate::operation::get_mailbox_details::GetMailboxDetailsError)
    pub fn get_mailbox_details(&self) -> crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder {
        crate::operation::get_mailbox_details::builders::GetMailboxDetailsFluentBuilder::new(self.handle.clone())
    }
}