Class: Aws::Organizations::Types::Organization

Inherits:

Struct

• Object
• Struct
• Aws::Organizations::Types::Organization

Includes:

Structure

Defined in:

lib/aws-sdk-organizations/types.rb

Overview

Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:master_account_email]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of an organization.

• #available_policy_types ⇒ Array<Types::PolicyTypeSummary>

  Do not use.

• #feature_set ⇒ String

  Specifies the functionality that currently is available to the organization.

• #id ⇒ String

  The unique identifier (ID) of an organization.

• #master_account_arn ⇒ String

  The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.

• #master_account_email ⇒ String

  The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.

• #master_account_id ⇒ String

  The unique identifier (ID) of the management account of an organization.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of an organization.

For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the *Amazon Web Services Service Authorization Reference*.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#available_policy_types ⇒ Array<Types::PolicyTypeSummary>

Do not use. This field is deprecated and doesn’t provide complete information about the policies in your organization.

To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.

Returns:

• (Array<Types::PolicyTypeSummary>)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#feature_set ⇒ String

Specifies the functionality that currently is available to the organization. If set to “ALL”, then all features are enabled and policies can be applied to accounts in the organization. If set to “CONSOLIDATED_BILLING”, then only consolidated billing functionality is available. For more information, see [Enabling all features in your organization] in the *Organizations User Guide*.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#id ⇒ String

The unique identifier (ID) of an organization.

The [regex pattern] for an organization ID string requires “o-” followed by from 10 to 32 lowercase letters or digits.

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#master_account_arn ⇒ String

The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.

For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the *Amazon Web Services Service Authorization Reference*.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#master_account_email ⇒ String

The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end

#master_account_id ⇒ String

The unique identifier (ID) of the management account of an organization.

The [regex pattern] for an account ID string requires exactly 12 digits.

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 3835

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  SENSITIVE = [:master_account_email]
  include Aws::Structure
end