Class: Aws::WorkMail::Types::OrganizationSummary

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::OrganizationSummary

Defined in:

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

Overview

The representation of an organization.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  The alias associated with the organization.

• #default_mail_domain ⇒ String

  The default email domain associated with the organization.

• #error_message ⇒ String

  The error message associated with the organization.

• #organization_id ⇒ String

  The identifier associated with the organization.

• #state ⇒ String

  The state associated with the organization.

Instance Attribute Details

#alias ⇒ String

The alias associated with the organization.

Returns:

• (String)

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

class OrganizationSummary < Struct.new(
  :organization_id,
  :alias,
  :default_mail_domain,
  :error_message,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#default_mail_domain ⇒ String

The default email domain associated with the organization.

Returns:

• (String)

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

class OrganizationSummary < Struct.new(
  :organization_id,
  :alias,
  :default_mail_domain,
  :error_message,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

Returns:

• (String)

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

class OrganizationSummary < Struct.new(
  :organization_id,
  :alias,
  :default_mail_domain,
  :error_message,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier associated with the organization.

Returns:

• (String)

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

class OrganizationSummary < Struct.new(
  :organization_id,
  :alias,
  :default_mail_domain,
  :error_message,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state associated with the organization.

Returns:

• (String)

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

class OrganizationSummary < Struct.new(
  :organization_id,
  :alias,
  :default_mail_domain,
  :error_message,
  :state)
  SENSITIVE = []
  include Aws::Structure
end