Skip to content

Organization

Source code in docs_src/capo_organizations/types/organization.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class Organization(TypedDict, closed=True):
    id: NotRequired["capo_organizations.types.organization_id.OrganizationId"]
    """<p>The unique identifier (ID) of an organization.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.</p>"""
    arn: NotRequired["capo_organizations.types.organization_arn.OrganizationArn"]
    """<p>The Amazon Resource Name (ARN) of an organization.</p> <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"""
    feature_set: NotRequired[
        "capo_organizations.types.organization_feature_set.OrganizationFeatureSet"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features in your organization</a> in the <i>Organizations User Guide</i>.</p>"""
    master_account_arn: NotRequired["capo_organizations.types.account_arn.AccountArn"]
    """<p>The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.</p> <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"""
    master_account_id: NotRequired["capo_organizations.types.account_id.AccountId"]
    """<p>The unique identifier (ID) of the management account of an organization.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits.</p>"""
    master_account_email: NotRequired["capo_organizations.types.email.Email"]
    """<p>The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.</p>"""
    available_policy_types: NotRequired[
        "capo_organizations.types.policy_types.PolicyTypes"
    ]
    """<important> <p>Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.</p> </important> <p>To determine the policies that are enabled and available for use in your organization, use the <a>ListRoots</a> operation instead.</p>"""

arn instance-attribute 

arn: NotRequired[OrganizationArn]

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.

available_policy_types instance-attribute 

available_policy_types: NotRequired[PolicyTypes]

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.

feature_set instance-attribute 

feature_set: NotRequired[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 instance-attribute 

id: NotRequired[OrganizationId]

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.

master_account_arn instance-attribute 

master_account_arn: NotRequired[AccountArn]

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.

master_account_email instance-attribute 

master_account_email: NotRequired[Email]

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 instance-attribute 

master_account_id: NotRequired[AccountId]

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

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