Skip to content

Commit dc39bd9

Browse files
Documentation updates for AWS Organizations APIs.
1 parent dbbd1ea commit dc39bd9

17 files changed

+195
-30
lines changed

generator/ServiceModels/organizations/organizations-2016-11-28.api.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,6 +1131,7 @@
11311131
"Email":{"shape":"Email"},
11321132
"Name":{"shape":"AccountName"},
11331133
"Status":{"shape":"AccountStatus"},
1134+
"State":{"shape":"AccountState"},
11341135
"JoinedMethod":{"shape":"AccountJoinedMethod"},
11351136
"JoinedTimestamp":{"shape":"Timestamp"}
11361137
}
@@ -1193,6 +1194,16 @@
11931194
},
11941195
"exception":true
11951196
},
1197+
"AccountState":{
1198+
"type":"string",
1199+
"enum":[
1200+
"PENDING_ACTIVATION",
1201+
"ACTIVE",
1202+
"SUSPENDED",
1203+
"PENDING_CLOSURE",
1204+
"CLOSED"
1205+
]
1206+
},
11961207
"AccountStatus":{
11971208
"type":"string",
11981209
"enum":[

generator/ServiceModels/organizations/organizations-2016-11-28.docs.json

Lines changed: 12 additions & 6 deletions
Large diffs are not rendered by default.

generator/ServiceModels/organizations/organizations-2016-11-28.normal.json

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@
535535
{"shape":"UnsupportedAPIEndpointException"},
536536
{"shape":"PolicyChangesInProgressException"}
537537
],
538-
"documentation":"<p>Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features</a> are enabled for the organization. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator.</p> <p> To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
538+
"documentation":"<p>Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features</a> are enabled for the organization. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator.</p> <p> To view the status of available policy types in the organization, use <a>ListRoots</a>.</p>"
539539
},
540540
"EnableAWSServiceAccess":{
541541
"name":"EnableAWSServiceAccess",
@@ -598,7 +598,7 @@
598598
{"shape":"UnsupportedAPIEndpointException"},
599599
{"shape":"PolicyChangesInProgressException"}
600600
],
601-
"documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
601+
"documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use <a>ListRoots</a>.</p>"
602602
},
603603
"InviteAccountToOrganization":{
604604
"name":"InviteAccountToOrganization",
@@ -1210,7 +1210,11 @@
12101210
},
12111211
"Status":{
12121212
"shape":"AccountStatus",
1213-
"documentation":"<p>The status of the account in the organization.</p>"
1213+
"documentation":"<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>"
1214+
},
1215+
"State":{
1216+
"shape":"AccountState",
1217+
"documentation":"<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>"
12141218
},
12151219
"JoinedMethod":{
12161220
"shape":"AccountJoinedMethod",
@@ -1286,6 +1290,16 @@
12861290
"documentation":"<p>You can't invite an existing account to your organization until you verify that you own the email address associated with the management account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification\">Email address verification</a> in the <i>Organizations User Guide</i>.</p>",
12871291
"exception":true
12881292
},
1293+
"AccountState":{
1294+
"type":"string",
1295+
"enum":[
1296+
"PENDING_ACTIVATION",
1297+
"ACTIVE",
1298+
"SUSPENDED",
1299+
"PENDING_CLOSURE",
1300+
"CLOSED"
1301+
]
1302+
},
12891303
"AccountStatus":{
12901304
"type":"string",
12911305
"enum":[
@@ -1853,7 +1867,7 @@
18531867
"members":{
18541868
"Account":{
18551869
"shape":"Account",
1856-
"documentation":"<p>A structure that contains information about the requested account.</p>"
1870+
"documentation":"<p>A structure that contains information about the requested account.</p> <important> <p>The <code>Status</code> parameter in the API response 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>"
18571871
}
18581872
}
18591873
},
@@ -2565,7 +2579,7 @@
25652579
"members":{
25662580
"Accounts":{
25672581
"shape":"Accounts",
2568-
"documentation":"<p>A list of the accounts in the specified root or OU.</p>"
2582+
"documentation":"<p>A list of the accounts in the specified root or OU.</p> <important> <p>The <code>Status</code> parameter in the API response 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>"
25692583
},
25702584
"NextToken":{
25712585
"shape":"NextToken",
@@ -2591,7 +2605,7 @@
25912605
"members":{
25922606
"Accounts":{
25932607
"shape":"Accounts",
2594-
"documentation":"<p>A list of objects in the organization.</p>"
2608+
"documentation":"<p>A list of objects in the organization.</p> <important> <p>The <code>Status</code> parameter in the API response 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>"
25952609
},
25962610
"NextToken":{
25972611
"shape":"NextToken",

sdk/src/Services/Organizations/Generated/Model/Account.cs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ public partial class Account
4040
private AccountJoinedMethod _joinedMethod;
4141
private DateTime? _joinedTimestamp;
4242
private string _name;
43+
private AccountState _state;
4344
private AccountStatus _status;
4445

4546
/// <summary>
@@ -174,11 +175,46 @@ internal bool IsSetName()
174175
return this._name != null;
175176
}
176177

178+
/// <summary>
179+
/// Gets and sets the property State.
180+
/// <para>
181+
/// Each state represents a specific phase in the account lifecycle. Use this information
182+
/// to manage account access, automate workflows, or trigger actions based on account
183+
/// state changes.
184+
/// </para>
185+
///
186+
/// <para>
187+
/// 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
188+
/// the state of your Amazon Web Services accounts </a> in the <i>Organizations User Guide</i>.
189+
/// </para>
190+
/// </summary>
191+
public AccountState State
192+
{
193+
get { return this._state; }
194+
set { this._state = value; }
195+
}
196+
197+
// Check to see if State property is set
198+
internal bool IsSetState()
199+
{
200+
return this._state != null;
201+
}
202+
177203
/// <summary>
178204
/// Gets and sets the property Status.
179205
/// <para>
180206
/// The status of the account in the organization.
181207
/// </para>
208+
/// <important>
209+
/// <para>
210+
/// The <c>Status</c> parameter in the <c>Account</c> object will be retired on September
211+
/// 9, 2026. Although both the account <c>State</c> and account <c>Status</c> parameters
212+
/// are currently available in the Organizations APIs (<c>DescribeAccount</c>, <c>ListAccounts</c>,
213+
/// <c>ListAccountsForParent</c>), we recommend that you update your scripts or other
214+
/// code to use the <c>State</c> parameter instead of <c>Status</c> before September 9,
215+
/// 2026.
216+
/// </para>
217+
/// </important>
182218
/// </summary>
183219
public AccountStatus Status
184220
{

sdk/src/Services/Organizations/Generated/Model/DescribeAccountResponse.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ public partial class DescribeAccountResponse : AmazonWebServiceResponse
4141
/// <para>
4242
/// A structure that contains information about the requested account.
4343
/// </para>
44+
/// <important>
45+
/// <para>
46+
/// The <c>Status</c> parameter in the API response will be retired on September 9, 2026.
47+
/// Although both the account <c>State</c> and account <c>Status</c> parameters are currently
48+
/// available in the Organizations APIs (<c>DescribeAccount</c>, <c>ListAccounts</c>,
49+
/// <c>ListAccountsForParent</c>), we recommend that you update your scripts or other
50+
/// code to use the <c>State</c> parameter instead of <c>Status</c> before September 9,
51+
/// 2026.
52+
/// </para>
53+
/// </important>
4454
/// </summary>
4555
public Account Account
4656
{

sdk/src/Services/Organizations/Generated/Model/DisablePolicyTypeRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ namespace Amazon.Organizations.Model
5353
/// </para>
5454
///
5555
/// <para>
56-
/// To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.
56+
/// To view the status of available policy types in the organization, use <a>ListRoots</a>.
5757
/// </para>
5858
/// </summary>
5959
public partial class DisablePolicyTypeRequest : AmazonOrganizationsRequest

sdk/src/Services/Organizations/Generated/Model/EnablePolicyTypeRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ namespace Amazon.Organizations.Model
5050
/// <para>
5151
/// You can enable a policy type in a root only if that policy type is available in the
5252
/// organization. To view the status of available policy types in the organization, use
53-
/// <a>DescribeOrganization</a>.
53+
/// <a>ListRoots</a>.
5454
/// </para>
5555
/// </summary>
5656
public partial class EnablePolicyTypeRequest : AmazonOrganizationsRequest

sdk/src/Services/Organizations/Generated/Model/Internal/MarshallTransformations/AccountUnmarshaller.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ public Account Unmarshall(JsonUnmarshallerContext context)
102102
unmarshalledObject.Name = unmarshaller.Unmarshall(context);
103103
continue;
104104
}
105+
if (context.TestExpression("State", targetDepth))
106+
{
107+
var unmarshaller = StringUnmarshaller.Instance;
108+
unmarshalledObject.State = unmarshaller.Unmarshall(context);
109+
continue;
110+
}
105111
if (context.TestExpression("Status", targetDepth))
106112
{
107113
var unmarshaller = StringUnmarshaller.Instance;

sdk/src/Services/Organizations/Generated/Model/ListAccountsForParentResponse.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@ public partial class ListAccountsForParentResponse : AmazonWebServiceResponse
4242
/// <para>
4343
/// A list of the accounts in the specified root or OU.
4444
/// </para>
45+
/// <important>
46+
/// <para>
47+
/// The <c>Status</c> parameter in the API response will be retired on September 9, 2026.
48+
/// Although both the account <c>State</c> and account <c>Status</c> parameters are currently
49+
/// available in the Organizations APIs (<c>DescribeAccount</c>, <c>ListAccounts</c>,
50+
/// <c>ListAccountsForParent</c>), we recommend that you update your scripts or other
51+
/// code to use the <c>State</c> parameter instead of <c>Status</c> before September 9,
52+
/// 2026.
53+
/// </para>
54+
/// </important>
4555
/// </summary>
4656
public List<Account> Accounts
4757
{

sdk/src/Services/Organizations/Generated/Model/ListAccountsResponse.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@ public partial class ListAccountsResponse : AmazonWebServiceResponse
4242
/// <para>
4343
/// A list of objects in the organization.
4444
/// </para>
45+
/// <important>
46+
/// <para>
47+
/// The <c>Status</c> parameter in the API response will be retired on September 9, 2026.
48+
/// Although both the account <c>State</c> and account <c>Status</c> parameters are currently
49+
/// available in the Organizations APIs (<c>DescribeAccount</c>, <c>ListAccounts</c>,
50+
/// <c>ListAccountsForParent</c>), we recommend that you update your scripts or other
51+
/// code to use the <c>State</c> parameter instead of <c>Status</c> before September 9,
52+
/// 2026.
53+
/// </para>
54+
/// </important>
4555
/// </summary>
4656
public List<Account> Accounts
4757
{

0 commit comments

Comments
 (0)