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

Class: Aws::WorkMail::Types::User

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

Overview

The representation of an Amazon WorkMail user.

Instance Attribute Summary collapse

Instance Attribute Details

#disabled_dateTime

The date indicating when the user was disabled from Amazon WorkMail use.

Returns:

  • (Time)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#display_nameString

The display name of the user.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#emailString

The email of the user.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#enabled_dateTime

The date indicating when the user was enabled for Amazon WorkMail use.

Returns:

  • (Time)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#idString

The identifier of the user.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#nameString

The name of the user.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#stateString

The state of the user, which can be ENABLED, DISABLED, or DELETED.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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

#user_roleString

The role of the user.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1952

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