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

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::DescribeOrganizationResponse

Defined in:

gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  The alias for an organization.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the organization.

• #completed_date ⇒ Time

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

• #default_mail_domain ⇒ String

  The default mail domain associated with the organization.

• #directory_id ⇒ String

  The identifier for the directory associated with an WorkMail organization.

• #directory_type ⇒ String

  The type of directory associated with the WorkMail organization.

• #error_message ⇒ String

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

• #interoperability_enabled ⇒ Boolean

  Indicates if interoperability is enabled for this organization.

• #migration_admin ⇒ String

  The user ID of the migration admin if migration is enabled for the organization.

• #organization_id ⇒ String

  The identifier of an organization.

• #state ⇒ String

  The state of an organization.

Instance Attribute Details

#alias ⇒ String

The alias for an organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  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)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_mail_domain ⇒ String

The default mail domain associated with the organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#directory_id ⇒ String

The identifier for the directory associated with an WorkMail organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#directory_type ⇒ String

The type of directory associated with the WorkMail organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

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

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#interoperability_enabled ⇒ Boolean

Indicates if interoperability is enabled for this organization.

Returns:

• (Boolean)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#migration_admin ⇒ String

The user ID of the migration admin if migration is enabled for the organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier of an organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of an organization.

Returns:

• (String)

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

class DescribeOrganizationResponse < Struct.new(
  :organization_id,
  :alias,
  :state,
  :directory_id,
  :directory_type,
  :default_mail_domain,
  :completed_date,
  :error_message,
  :arn,
  :migration_admin,
  :interoperability_enabled)
  SENSITIVE = []
  include Aws::Structure
end