Class: Aws::WorkMail::Types::DescribeResourceResponse

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::DescribeResourceResponse

Includes:

Structure

Defined in:

lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #booking_options ⇒ Types::BookingOptions

  The booking options for the described resource.

• #description ⇒ String

  Description of the resource.

• #disabled_date ⇒ Time

  The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

• #email ⇒ String

  The email of the described resource.

• #enabled_date ⇒ Time

  The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

• #hidden_from_global_address_list ⇒ Boolean

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

• #name ⇒ String

  The name of the described resource.

• #resource_id ⇒ String

  The identifier of the described resource.

• #state ⇒ String

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

• #type ⇒ String

  The type of the described resource.

Instance Attribute Details

#booking_options ⇒ Types::BookingOptions

The booking options for the described resource.

Returns:

• (Types::BookingOptions)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

Description of the resource.

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#disabled_date ⇒ Time

The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

Returns:

• (Time)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#email ⇒ String

The email of the described resource.

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#enabled_date ⇒ Time

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

Returns:

• (Time)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#hidden_from_global_address_list ⇒ Boolean

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

Returns:

• (Boolean)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The name of the described resource.

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#resource_id ⇒ String

The identifier of the described resource.

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end

#type ⇒ String

The type of the described resource.

Returns:

• (String)

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

class DescribeResourceResponse < Struct.new(
  :resource_id,
  :email,
  :name,
  :type,
  :booking_options,
  :state,
  :enabled_date,
  :disabled_date,
  :description,
  :hidden_from_global_address_list)
  SENSITIVE = [:description]
  include Aws::Structure
end