Skip to content

Account

Source code in docs_src/capo_organizations/types/account.py
class Account(TypedDict, closed=True):
    id: NotRequired["capo_organizations.types.account_id.AccountId"]
    """<p>The unique identifier (ID) of the account.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits.</p>"""
    arn: NotRequired["capo_organizations.types.account_arn.AccountArn"]
    """<p>The Amazon Resource Name (ARN) of the account.</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>"""
    email: NotRequired["capo_organizations.types.email.Email"]
    """<p>The email address associated with the Amazon Web Services account.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for this parameter is a string of characters that represents a standard internet email address.</p>"""
    name: NotRequired["capo_organizations.types.account_name.AccountName"]
    """<p>The friendly name of the account.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range.</p>"""
    status: NotRequired["capo_organizations.types.account_status.AccountStatus"]
    """<p>The status of the account in the organization.</p> <important> <p>The <code>Status</code> parameter in the <code>Account</code> object will be retired on September 9, 2026. Although both the account <code>State</code> and account <code>Status</code> parameters are currently available in the Organizations APIs (<code>DescribeAccount</code>, <code>ListAccounts</code>, <code>ListAccountsForParent</code>), we recommend that you update your scripts or other code to use the <code>State</code> parameter instead of <code>Status</code> before September 9, 2026.</p> </important>"""
    state: NotRequired["capo_organizations.types.account_state.AccountState"]
    """<p>Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.</p> <p>For more information about account states and their implications, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_account_state.html">Monitor the state of your Amazon Web Services accounts </a> in the <i>Organizations User Guide</i>.</p>"""
    paths: NotRequired["capo_organizations.types.paths.Paths"]
    """<p>The paths in the organization where the account exists.</p>"""
    joined_method: NotRequired[
        "capo_organizations.types.account_joined_method.AccountJoinedMethod"
    ]
    """<p>The method by which the account joined the organization.</p>"""
    joined_timestamp: NotRequired["capo_organizations.types.timestamp.Timestamp"]
    """<p>The date the account became a part of the organization.</p>"""

arn instance-attribute

arn: NotRequired[AccountArn]

The Amazon Resource Name (ARN) of the account.

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

email instance-attribute

email: NotRequired[Email]

The email address associated with the Amazon Web Services account.

The regex pattern for this parameter is a string of characters that represents a standard internet email address.

id instance-attribute

id: NotRequired[AccountId]

The unique identifier (ID) of the account.

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

joined_method instance-attribute

joined_method: NotRequired[AccountJoinedMethod]

The method by which the account joined the organization.

joined_timestamp instance-attribute

joined_timestamp: NotRequired[Timestamp]

The date the account became a part of the organization.

name instance-attribute

name: NotRequired[AccountName]

The friendly name of the account.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

paths instance-attribute

paths: NotRequired[Paths]

The paths in the organization where the account exists.

state instance-attribute

state: NotRequired[AccountState]

Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

status instance-attribute

status: NotRequired[AccountStatus]

The status of the account in the organization.

The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.