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

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The alias for an organization.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#completed_dateTime

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

Returns:

  • (Time)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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_domainString

The default mail domain associated with the organization.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#directory_idString

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

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#directory_typeString

The type of directory associated with the Amazon WorkMail organization.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#error_messageString

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

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#organization_idString

The identifier of an organization.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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

#stateString

The state of an organization.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 563

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