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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The alias for an organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#arnString

The Amazon Resource Name (ARN) of the organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#completed_dateTime

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

Returns:

  • (Time)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#default_mail_domainString

The default mail domain associated with the organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#directory_idString

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

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#directory_typeString

The type of directory associated with the WorkMail organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#error_messageString

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

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#organization_idString

The identifier of an organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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

#stateString

The state of an organization.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 752

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