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

Class: Aws::WorkMail::Types::DescribeOrganizationResponse

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

Overview

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String

The alias for an organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#completed_date ⇒ Time

The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

Returns:

  • (Time) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#default_mail_domain ⇒ String

The default mail domain associated with the organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#directory_id ⇒ String

The identifier for the directory associated with an Amazon WorkMail organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#directory_type ⇒ String

The type of directory associated with the WorkMail organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#error_message ⇒ String

(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#organization_id ⇒ String

The identifier of an organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end

#state ⇒ String

The state of an organization.

Returns:

  • (String) 


600
601
602
603
604
605
606
607
608
609
610
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 600

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message)
  include Aws::Structure
end