You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-organizations/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 .

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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.

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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_typesArray<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.

Returns:



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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_setString

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.

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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

#idString

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.

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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_arnString

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.

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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_emailString

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

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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_idString

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

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

Returns:

  • (String)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2314

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