Class: Aws::WorkMail::Types::DescribeGroupResponse

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::DescribeGroupResponse

Includes:

Structure

Defined in:

lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disabled_date ⇒ Time

  The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

• #email ⇒ String

  The email of the described group.

• #enabled_date ⇒ Time

  The date and time when a user was registered to WorkMail, in UNIX epoch time format.

• #group_id ⇒ String

  The identifier of the described group.

• #hidden_from_global_address_list ⇒ Boolean

  If the value is set to true, the group is hidden from the address book.

• #name ⇒ String

  The name of the described group.

• #state ⇒ String

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

Instance Attribute Details

#disabled_date ⇒ Time

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

Returns:

• (Time)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#email ⇒ String

The email of the described group.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_date ⇒ Time

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

Returns:

• (Time)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

The identifier of the described group.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#hidden_from_global_address_list ⇒ Boolean

If the value is set to true, the group is hidden from the address book.

Returns:

• (Boolean)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the described group.

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workmail/types.rb', line 1423

class DescribeGroupResponse < Struct.new(
  :group_id,
  :name,
  :email,
  :state,
  :enabled_date,
  :disabled_date,
  :hidden_from_global_address_list)
  SENSITIVE = []
  include Aws::Structure
end