Skip to content

Commit aea4623

Browse files
author
awstools
committed
feat(client-organizations): Documentation updates for AWS Organizations APIs.
1 parent 3e7b610 commit aea4623

16 files changed

+178
-65
lines changed

clients/client-organizations/src/commands/CloseAccountCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ export interface CloseAccountCommandOutput extends __MetadataBearer {}
5757
* <li>
5858
* <p>You can close only 10% of member accounts, between 10 and 1000, within a
5959
* rolling 30 day period. This quota is not bound by a calendar month, but
60-
* starts when you close an account. After you reach this limit, you can't close
61-
* additional accounts. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing a member
60+
* starts when you close an account. After you reach this limit, you can't
61+
* close additional accounts. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing a member
6262
* account in your organization</a> and <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for
6363
* Organizations</a> in the <i>Organizations User Guide</i>. </p>
6464
* </li>

clients/client-organizations/src/commands/CreateAccountCommand.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
7171
* <li>
7272
* <p>When you create an account in an organization using the Organizations console,
7373
* API, or CLI commands, the information required for the account to operate
74-
* as a standalone account, such as a payment method is <i>not</i> automatically
75-
* collected. If you must remove an account from your organization later, you
76-
* can do so only after you provide the missing information. For more
77-
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html">Considerations before removing an account from an organization</a>
74+
* as a standalone account, such as a payment method is
75+
* <i>not</i> automatically collected. If you must remove an
76+
* account from your organization later, you can do so only after you provide
77+
* the missing information. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html">Considerations before removing an account from an organization</a>
7878
* in the <i>Organizations User Guide</i>.</p>
7979
* </li>
8080
* <li>
@@ -87,9 +87,10 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
8787
* If the error persists, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
8888
* </li>
8989
* <li>
90-
* <p>It isn't recommended to use <code>CreateAccount</code> to create multiple temporary accounts, and using
91-
* the <code>CreateAccount</code> API to close accounts is subject to a 30-day usage quota. For information on the requirements
92-
* and process for closing an account, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing a member
90+
* <p>It isn't recommended to use <code>CreateAccount</code> to create multiple
91+
* temporary accounts, and using the <code>CreateAccount</code> API to close
92+
* accounts is subject to a 30-day usage quota. For information on the
93+
* requirements and process for closing an account, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing a member
9394
* account in your organization</a> in the
9495
* <i>Organizations User Guide</i>.</p>
9596
* </li>

clients/client-organizations/src/commands/DescribeAccountCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResponse, _
5353
* // Email: "STRING_VALUE",
5454
* // Name: "STRING_VALUE",
5555
* // Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
56+
* // State: "PENDING_ACTIVATION" || "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE" || "CLOSED",
5657
* // JoinedMethod: "INVITED" || "CREATED",
5758
* // JoinedTimestamp: new Date("TIMESTAMP"),
5859
* // },

clients/client-organizations/src/commands/DescribeEffectivePolicyCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface DescribeEffectivePolicyCommandOutput extends DescribeEffectiveP
3232
* The effective policy is the aggregation of any policies of the specified type that the
3333
* account inherits, plus any policy of that type that is directly attached to the
3434
* account.</p>
35-
* <p>This operation applies only to management policies. It does not apply to authorization policies: service
36-
* control policies (SCPs) and resource control policies (RCPs).</p>
35+
* <p>This operation applies only to management policies. It does not apply to authorization
36+
* policies: service control policies (SCPs) and resource control policies (RCPs).</p>
3737
* <p>For more information about policy inheritance, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_inheritance_mgmt.html">Understanding
3838
* management policy inheritance</a> in the
3939
* <i>Organizations User Guide</i>.</p>

clients/client-organizations/src/commands/DisablePolicyTypeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface DisablePolicyTypeCommandOutput extends DisablePolicyTypeRespons
3939
* root, and then use this operation.</p>
4040
* <p>This operation can be called only from the organization's
4141
* management account or by a member account that is a delegated administrator.</p>
42-
* <p> To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>
42+
* <p> To view the status of available policy types in the organization, use <a>ListRoots</a>.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

clients/client-organizations/src/commands/EnableAWSServiceAccessCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ export interface EnableAWSServiceAccessCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Provides an Amazon Web Services service (the service that is specified by
32-
* <code>ServicePrincipal</code>) with permissions to view the structure of an organization,
33-
* create a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">service-linked role</a> in all the accounts in the organization,
34-
* and allow the service to perform operations
35-
* on behalf of the organization and its accounts. Establishing these permissions can be a first step
36-
* in enabling the integration of an Amazon Web Services service with Organizations.</p>
32+
* <code>ServicePrincipal</code>) with permissions to view the structure of an
33+
* organization, create a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">service-linked role</a> in
34+
* all the accounts in the organization, and allow the service to perform operations on
35+
* behalf of the organization and its accounts. Establishing these permissions can be a
36+
* first step in enabling the integration of an Amazon Web Services service with Organizations.</p>
3737
* <important>
3838
* <p>We recommend that you enable integration between Organizations and the specified Amazon Web Services
3939
* service by using the console or commands that are provided by the specified service.

clients/client-organizations/src/commands/EnablePolicyTypeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface EnablePolicyTypeCommandOutput extends EnablePolicyTypeResponse,
3939
* management account or by a member account that is a delegated administrator.</p>
4040
* <p>You can enable a policy type in a root only if that policy type is available in the
4141
* organization. To view the status of available policy types in the organization, use
42-
* <a>DescribeOrganization</a>.</p>
42+
* <a>ListRoots</a>.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

clients/client-organizations/src/commands/InviteAccountToOrganizationCommand.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ export interface InviteAccountToOrganizationCommandOutput
4040
* other account's owner. The invitation is implemented as a <a>Handshake</a>
4141
* whose details are in the response.</p>
4242
* <important>
43-
* <p>If you receive an exception that indicates that you exceeded your account
44-
* limits for the organization or that the operation failed because your
45-
* organization is still initializing, wait one hour and then try again. If the
46-
* error persists after an hour, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
43+
* <p>If you receive an exception that indicates that you exceeded your account limits
44+
* for the organization or that the operation failed because your organization is still
45+
* initializing, wait one hour and then try again. If the error persists after an hour,
46+
* contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services
47+
* Support</a>.</p>
4748
* </important>
4849
* <p>If the request includes tags, then the requester must have the
4950
* <code>organizations:TagResource</code> permission.</p>

clients/client-organizations/src/commands/LeaveOrganizationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {}
7979
* </li>
8080
* <li>
8181
* <p>A newly created account has a waiting period before it can be removed from
82-
* its organization.
83-
* You must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.</p>
82+
* its organization. You must wait until at least seven days after the account
83+
* was created. Invited accounts aren't subject to this waiting period.</p>
8484
* </li>
8585
* <li>
8686
* <p>If you are using an organization principal to call

clients/client-organizations/src/commands/ListAccountsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad
6060
* // Email: "STRING_VALUE",
6161
* // Name: "STRING_VALUE",
6262
* // Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
63+
* // State: "PENDING_ACTIVATION" || "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE" || "CLOSED",
6364
* // JoinedMethod: "INVITED" || "CREATED",
6465
* // JoinedTimestamp: new Date("TIMESTAMP"),
6566
* // },

0 commit comments

Comments
 (0)