You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkMail::Types::DescribeUserResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#disabled_dateTime

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

Returns:

  • (Time)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#display_nameString

The display name of the user.

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#emailString

The email of the user.

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#enabled_dateTime

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

Returns:

  • (Time)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#nameString

The name for the user.

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#stateString

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

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#user_idString

The identifier for the described user.

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end

#user_roleString

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

Returns:

  • (String)


753
754
755
756
757
758
759
760
761
762
763
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 753

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  include Aws::Structure
end