Struct DescribeUserOutput

#[non_exhaustive]
pub struct DescribeUserOutput {

    pub user_id: Option<String>,
    pub name: Option<String>,
    pub email: Option<String>,
    pub display_name: Option<String>,
    pub state: Option<EntityState>,
    pub user_role: Option<UserRole>,
    pub enabled_date: Option<DateTime>,
    pub disabled_date: Option<DateTime>,
    pub mailbox_provisioned_date: Option<DateTime>,
    pub mailbox_deprovisioned_date: Option<DateTime>,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub hidden_from_global_address_list: bool,
    pub initials: Option<String>,
    pub telephone: Option<String>,
    pub street: Option<String>,
    pub job_title: Option<String>,
    pub city: Option<String>,
    pub company: Option<String>,
    pub zip_code: Option<String>,
    pub department: Option<String>,
    pub country: Option<String>,
    pub office: Option<String>,
    pub identity_provider_user_id: Option<String>,
    pub identity_provider_identity_store_id: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: Option<String>

The identifier for the described user.

name: Option<String>

The name for the user.

email: Option<String>

The email of the user.

display_name: Option<String>

The display name of the user.

state: Option<EntityState>

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

user_role: Option<UserRole>

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

enabled_date: Option<DateTime>

The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

disabled_date: Option<DateTime>

The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

mailbox_provisioned_date: Option<DateTime>

The date when the mailbox was created for the user.

mailbox_deprovisioned_date: Option<DateTime>

The date when the mailbox was removed for the user.

first_name: Option<String>

First name of the user.

last_name: Option<String>

Last name of the user.

hidden_from_global_address_list: bool

If enabled, the user is hidden from the global address list.

initials: Option<String>

Initials of the user.

telephone: Option<String>

User's contact number.

street: Option<String>

Street where the user is located.

job_title: Option<String>

Job title of the user.

city: Option<String>

City where the user is located.

company: Option<String>

Company of the user.

zip_code: Option<String>

Zip code of the user.

department: Option<String>

Department of the user.

country: Option<String>

Country where the user is located.

office: Option<String>

Office where the user is located.

identity_provider_user_id: Option<String>

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

identity_provider_identity_store_id: Option<String>

Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Implementations

impl DescribeUserOutput

pub fn user_id(&self) -> Option<&str>

The identifier for the described user.

pub fn name(&self) -> Option<&str>

The name for the user.

pub fn email(&self) -> Option<&str>

The email of the user.

pub fn display_name(&self) -> Option<&str>

The display name of the user.

pub fn state(&self) -> Option<&EntityState>

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

pub fn user_role(&self) -> Option<&UserRole>

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

pub fn enabled_date(&self) -> Option<&DateTime>

The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

pub fn disabled_date(&self) -> Option<&DateTime>

The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

pub fn mailbox_provisioned_date(&self) -> Option<&DateTime>

The date when the mailbox was created for the user.

pub fn mailbox_deprovisioned_date(&self) -> Option<&DateTime>

The date when the mailbox was removed for the user.

pub fn first_name(&self) -> Option<&str>

First name of the user.

pub fn last_name(&self) -> Option<&str>

Last name of the user.

pub fn hidden_from_global_address_list(&self) -> bool

If enabled, the user is hidden from the global address list.

pub fn initials(&self) -> Option<&str>

Initials of the user.

pub fn telephone(&self) -> Option<&str>

User's contact number.

pub fn street(&self) -> Option<&str>

Street where the user is located.

pub fn job_title(&self) -> Option<&str>

Job title of the user.

pub fn city(&self) -> Option<&str>

City where the user is located.

pub fn company(&self) -> Option<&str>

Company of the user.

pub fn zip_code(&self) -> Option<&str>

Zip code of the user.

pub fn department(&self) -> Option<&str>

Department of the user.

pub fn country(&self) -> Option<&str>

Country where the user is located.

pub fn office(&self) -> Option<&str>

Office where the user is located.

pub fn identity_provider_user_id(&self) -> Option<&str>

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

pub fn identity_provider_identity_store_id(&self) -> Option<&str>

Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

impl DescribeUserOutput

pub fn builder() -> DescribeUserOutputBuilder

Creates a new builder-style object to manufacture DescribeUserOutput.

Trait Implementations

impl Clone for DescribeUserOutput

fn clone(&self) -> DescribeUserOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeUserOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeUserOutput

fn eq(&self, other: &DescribeUserOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeUserOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeUserOutput