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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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

#display_nameString

The display name of the user.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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

#emailString

The email of the user.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  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)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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

#nameString

The name for the user.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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

#stateString

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

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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

#user_idString

The identifier for the described user.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

class DescribeUserResponse < Struct.new(
  :user_id,
  :name,
  :email,
  :display_name,
  :state,
  :user_role,
  :enabled_date,
  :disabled_date)
  SENSITIVE = []
  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 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, and SYSTEM_USER.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1045

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