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

Inherits:
Struct
  • Object
show all
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:

Instance Attribute Summary collapse

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 *AWS Organizations User Guide*.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

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

#available_policy_types ⇒ Array<Types::PolicyTypeSummary>

A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.

<note markdown=“1”> Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.

</note>

Returns:



2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  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 *AWS Organizations User Guide*.

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

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

class Organization < Struct.new(
  :id,
  :arn,
  :feature_set,
  :master_account_arn,
  :master_account_id,
  :master_account_email,
  :available_policy_types)
  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 lower-case letters or digits.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

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

#master_account_arn ⇒ String

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

For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the *AWS Organizations User Guide*.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

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

#master_account_email ⇒ String

The email address that is associated with the AWS account that is designated as the master account for the organization.

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

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

#master_account_id ⇒ String

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

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

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/aws-sdk-organizations/types.rb', line 2468

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