amazonka-organizations-2.0: Amazon Organizations SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Organizations.Types.Organization

Description

 
Synopsis

Documentation

data Organization Source #

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: newOrganization smart constructor.

Constructors

Organization' 

Fields

  • arn :: Maybe Text

    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.

  • availablePolicyTypes :: Maybe [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.

  • featureSet :: Maybe OrganizationFeatureSet

    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.

  • id :: Maybe Text

    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.

  • masterAccountArn :: Maybe Text

    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.

  • masterAccountEmail :: Maybe (Sensitive Text)

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

  • masterAccountId :: Maybe Text

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

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

Instances

Instances details
FromJSON Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

Generic Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

Associated Types

type Rep Organization :: Type -> Type #

Show Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

NFData Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

Methods

rnf :: Organization -> () #

Eq Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

Hashable Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

type Rep Organization Source # 
Instance details

Defined in Amazonka.Organizations.Types.Organization

type Rep Organization = D1 ('MetaData "Organization" "Amazonka.Organizations.Types.Organization" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "Organization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "availablePolicyTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyTypeSummary])) :*: S1 ('MetaSel ('Just "featureSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationFeatureSet)))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "masterAccountArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "masterAccountEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "masterAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newOrganization :: Organization Source #

Create a value of Organization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Organization', organization_arn - 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.

$sel:availablePolicyTypes:Organization', organization_availablePolicyTypes - 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.

$sel:featureSet:Organization', organization_featureSet - 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.

$sel:id:Organization', organization_id - 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.

$sel:masterAccountArn:Organization', organization_masterAccountArn - 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.

$sel:masterAccountEmail:Organization', organization_masterAccountEmail - The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.

$sel:masterAccountId:Organization', organization_masterAccountId - The unique identifier (ID) of the management account of an organization.

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

organization_arn :: Lens' Organization (Maybe Text) Source #

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.

organization_availablePolicyTypes :: Lens' Organization (Maybe [PolicyTypeSummary]) Source #

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.

organization_featureSet :: Lens' Organization (Maybe OrganizationFeatureSet) Source #

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.

organization_id :: Lens' Organization (Maybe Text) Source #

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.

organization_masterAccountArn :: Lens' Organization (Maybe Text) Source #

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.

organization_masterAccountEmail :: Lens' Organization (Maybe Text) Source #

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

organization_masterAccountId :: Lens' Organization (Maybe Text) Source #

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

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