Account
Contains information about an AWS account that is a member of an organization.
Contents
- Arn
-
The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.
Type: String
Pattern:
^arn:aws:organizations::\d{12}:account\/o-[a-z0-9]{10,32}\/\d{12}Required: No
-
The email address associated with the AWS account.
The regex pattern
for this parameter is a string of characters that represents a standard internet email address. Type: String
Length Constraints: Minimum length of 6. Maximum length of 64.
Pattern:
[^\s@]+@[^\s@]+\.[^\s@]+Required: No
- Id
-
The unique identifier (ID) of the account.
The regex pattern
for an account ID string requires exactly 12 digits. Type: String
Length Constraints: Maximum length of 12.
Pattern:
^\d{12}$Required: No
- JoinedMethod
-
The method by which the account joined the organization.
Type: String
Valid Values:
INVITED | CREATEDRequired: No
- JoinedTimestamp
-
The date the account became a part of the organization.
Type: Timestamp
Required: No
- Name
-
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. Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[\s\S]*Required: No
- State
-
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 AWS accounts in the AWS Organizations User Guide.
Type: String
Valid Values:
PENDING_ACTIVATION | ACTIVE | SUSPENDED | PENDING_CLOSURE | CLOSEDRequired: No
- Status
-
The status of the account in the organization.
Important
The
Statusparameter in theAccountobject will be retired on September 9, 2026. Although both the accountStateand accountStatusparameters are currently available in the AWS Organizations APIs (DescribeAccount,ListAccounts,ListAccountsForParent), we recommend that you update your scripts or other code to use theStateparameter instead ofStatusbefore September 9, 2026.Type: String
Valid Values:
ACTIVE | SUSPENDED | PENDING_CLOSURERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
