@aws-sdk/client-organizations 3.281.0 → 3.283.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/Organizations.d.ts +281 -278
- package/dist-types/OrganizationsClient.d.ts +27 -27
- package/dist-types/commands/AcceptHandshakeCommand.d.ts +7 -7
- package/dist-types/commands/AttachPolicyCommand.d.ts +2 -2
- package/dist-types/commands/CancelHandshakeCommand.d.ts +2 -2
- package/dist-types/commands/CloseAccountCommand.d.ts +26 -22
- package/dist-types/commands/CreateAccountCommand.d.ts +20 -20
- package/dist-types/commands/CreateGovCloudAccountCommand.d.ts +33 -35
- package/dist-types/commands/CreateOrganizationCommand.d.ts +2 -2
- package/dist-types/commands/CreateOrganizationalUnitCommand.d.ts +3 -3
- package/dist-types/commands/CreatePolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeclineHandshakeCommand.d.ts +2 -2
- package/dist-types/commands/DeleteOrganizationalUnitCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterDelegatedAdministratorCommand.d.ts +4 -4
- package/dist-types/commands/DescribeAccountCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCreateAccountStatusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEffectivePolicyCommand.d.ts +3 -3
- package/dist-types/commands/DescribeHandshakeCommand.d.ts +2 -2
- package/dist-types/commands/DescribeOrganizationCommand.d.ts +3 -3
- package/dist-types/commands/DescribeOrganizationalUnitCommand.d.ts +1 -1
- package/dist-types/commands/DescribePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DetachPolicyCommand.d.ts +4 -4
- package/dist-types/commands/DisableAWSServiceAccessCommand.d.ts +11 -11
- package/dist-types/commands/DisablePolicyTypeCommand.d.ts +3 -3
- package/dist-types/commands/EnableAWSServiceAccessCommand.d.ts +4 -4
- package/dist-types/commands/EnableAllFeaturesCommand.d.ts +6 -6
- package/dist-types/commands/EnablePolicyTypeCommand.d.ts +3 -3
- package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts +8 -8
- package/dist-types/commands/LeaveOrganizationCommand.d.ts +23 -23
- package/dist-types/commands/ListAWSServiceAccessForOrganizationCommand.d.ts +2 -2
- package/dist-types/commands/ListAccountsCommand.d.ts +2 -2
- package/dist-types/commands/ListAccountsForParentCommand.d.ts +2 -2
- package/dist-types/commands/ListChildrenCommand.d.ts +2 -2
- package/dist-types/commands/ListCreateAccountStatusCommand.d.ts +2 -2
- package/dist-types/commands/ListDelegatedAdministratorsCommand.d.ts +1 -1
- package/dist-types/commands/ListDelegatedServicesForAccountCommand.d.ts +1 -1
- package/dist-types/commands/ListHandshakesForAccountCommand.d.ts +3 -3
- package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts +3 -3
- package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts +2 -2
- package/dist-types/commands/ListParentsCommand.d.ts +4 -4
- package/dist-types/commands/ListPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListPoliciesForTargetCommand.d.ts +2 -2
- package/dist-types/commands/ListRootsCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
- package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +2 -2
- package/dist-types/commands/MoveAccountCommand.d.ts +1 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/RegisterDelegatedAdministratorCommand.d.ts +2 -2
- package/dist-types/commands/RemoveAccountFromOrganizationCommand.d.ts +10 -10
- package/dist-types/commands/TagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UpdateOrganizationalUnitCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +311 -304
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +17 -17
|
@@ -181,68 +181,68 @@ export interface OrganizationsClientResolvedConfig extends OrganizationsClientRe
|
|
|
181
181
|
* <p>Organizations is a web service that enables you to consolidate your multiple
|
|
182
182
|
* Amazon Web Services accounts into an <i>organization</i> and centrally manage your
|
|
183
183
|
* accounts and their resources.</p>
|
|
184
|
-
*
|
|
184
|
+
* <p>This guide provides descriptions of the Organizations operations. For more
|
|
185
185
|
* information about using this service, see the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">Organizations User Guide</a>.</p>
|
|
186
|
-
*
|
|
186
|
+
* <p>
|
|
187
187
|
* <b>Support and feedback for Organizations</b>
|
|
188
188
|
* </p>
|
|
189
|
-
*
|
|
189
|
+
* <p>We welcome your feedback. Send your comments to <a href="mailto:feedback-awsorganizations@amazon.com">feedback-awsorganizations@amazon.com</a> or post your feedback and questions in
|
|
190
190
|
* the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=219">Organizations support forum</a>. For
|
|
191
191
|
* more information about the Amazon Web Services support forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums Help</a>.</p>
|
|
192
|
-
*
|
|
192
|
+
* <p>
|
|
193
193
|
* <b>Endpoint to call When using the CLI or the Amazon Web Services
|
|
194
194
|
* SDK</b>
|
|
195
195
|
* </p>
|
|
196
|
-
*
|
|
196
|
+
* <p>For the current release of Organizations, specify the <code>us-east-1</code> region
|
|
197
197
|
* for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of
|
|
198
198
|
* China. If calling from one of the Amazon Web Services Regions in China, then specify
|
|
199
199
|
* <code>cn-northwest-1</code>. You can do this in the CLI by using these parameters
|
|
200
200
|
* and commands:</p>
|
|
201
|
-
*
|
|
201
|
+
* <ul>
|
|
202
202
|
* <li>
|
|
203
|
-
*
|
|
203
|
+
* <p>Use the following parameter with each command to specify both the endpoint and
|
|
204
204
|
* its region:</p>
|
|
205
|
-
*
|
|
205
|
+
* <p>
|
|
206
206
|
* <code>--endpoint-url https://organizations.us-east-1.amazonaws.com</code>
|
|
207
|
-
*
|
|
207
|
+
* <i>(from commercial Amazon Web Services Regions outside of China)</i>
|
|
208
208
|
* </p>
|
|
209
|
-
*
|
|
210
|
-
*
|
|
209
|
+
* <p>or</p>
|
|
210
|
+
* <p>
|
|
211
211
|
* <code>--endpoint-url
|
|
212
212
|
* https://organizations.cn-northwest-1.amazonaws.com.cn</code>
|
|
213
|
-
*
|
|
213
|
+
* <i>(from Amazon Web Services Regions in China)</i>
|
|
214
214
|
* </p>
|
|
215
215
|
* </li>
|
|
216
216
|
* <li>
|
|
217
|
-
*
|
|
217
|
+
* <p>Use the default endpoint, but configure your default region with this
|
|
218
218
|
* command:</p>
|
|
219
|
-
*
|
|
219
|
+
* <p>
|
|
220
220
|
* <code>aws configure set default.region us-east-1</code>
|
|
221
|
-
*
|
|
221
|
+
* <i>(from commercial Amazon Web Services Regions outside of China)</i>
|
|
222
222
|
* </p>
|
|
223
|
-
*
|
|
224
|
-
*
|
|
223
|
+
* <p>or</p>
|
|
224
|
+
* <p>
|
|
225
225
|
* <code>aws configure set default.region cn-northwest-1</code>
|
|
226
|
-
*
|
|
226
|
+
* <i>(from Amazon Web Services Regions in China)</i>
|
|
227
227
|
* </p>
|
|
228
228
|
* </li>
|
|
229
229
|
* <li>
|
|
230
|
-
*
|
|
231
|
-
*
|
|
230
|
+
* <p>Use the following parameter with each command to specify the endpoint:</p>
|
|
231
|
+
* <p>
|
|
232
232
|
* <code>--region us-east-1</code>
|
|
233
|
-
*
|
|
233
|
+
* <i>(from commercial Amazon Web Services Regions outside of China)</i>
|
|
234
234
|
* </p>
|
|
235
|
-
*
|
|
236
|
-
*
|
|
235
|
+
* <p>or</p>
|
|
236
|
+
* <p>
|
|
237
237
|
* <code>--region cn-northwest-1</code>
|
|
238
|
-
*
|
|
238
|
+
* <i>(from Amazon Web Services Regions in China)</i>
|
|
239
239
|
* </p>
|
|
240
240
|
* </li>
|
|
241
241
|
* </ul>
|
|
242
|
-
*
|
|
242
|
+
* <p>
|
|
243
243
|
* <b>Recording API Requests</b>
|
|
244
|
-
*
|
|
245
|
-
*
|
|
244
|
+
* </p>
|
|
245
|
+
* <p>Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your
|
|
246
246
|
* Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected
|
|
247
247
|
* by CloudTrail, you can determine which requests the Organizations service received, who made the
|
|
248
248
|
* request and when, and so on. For more about Organizations and its support for CloudTrail, see
|
|
@@ -16,14 +16,14 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Sends a response to the originator of a handshake agreeing to the action proposed by
|
|
18
18
|
* the handshake request.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>You can only call this operation by the following principals when they also have the
|
|
20
20
|
* relevant IAM permissions:</p>
|
|
21
|
-
*
|
|
21
|
+
* <ul>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* <b>Invitation to join</b> or <b>Approve all features request</b> handshakes: only a principal from
|
|
25
25
|
* the member account.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>The user who calls the API for an invitation to join must have the
|
|
27
27
|
* <code>organizations:AcceptHandshake</code> permission. If you enabled all
|
|
28
28
|
* features in the organization, the user must also have the
|
|
29
29
|
* <code>iam:CreateServiceLinkedRole</code> permission so that Organizations can
|
|
@@ -32,10 +32,10 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
|
|
|
32
32
|
* <i>Organizations User Guide</i>.</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>
|
|
36
36
|
* <b>Enable all features final confirmation</b>
|
|
37
37
|
* handshake: only a principal from the management account.</p>
|
|
38
|
-
*
|
|
38
|
+
* <p>For more information about invitations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html">Inviting an
|
|
39
39
|
* Amazon Web Services account to join your organization</a> in the
|
|
40
40
|
* <i>Organizations User Guide.</i> For more information about requests to
|
|
41
41
|
* enable all features in the organization, 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
|
|
@@ -43,7 +43,7 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
|
|
|
43
43
|
* </p>
|
|
44
44
|
* </li>
|
|
45
45
|
* </ul>
|
|
46
|
-
*
|
|
46
|
+
* <p>After you accept a handshake, it continues to appear in the results of relevant APIs
|
|
47
47
|
* for only 30 days. After that, it's deleted.</p>
|
|
48
48
|
* @example
|
|
49
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -17,7 +17,7 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {
|
|
|
17
17
|
* <p>Attaches a policy to a root, an organizational unit (OU), or an individual account.
|
|
18
18
|
* How the policy affects accounts depends on the type of policy. Refer to the
|
|
19
19
|
* <i>Organizations User Guide</i> for information about each policy type:</p>
|
|
20
|
-
*
|
|
20
|
+
* <ul>
|
|
21
21
|
* <li>
|
|
22
22
|
* <p>
|
|
23
23
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html">AISERVICES_OPT_OUT_POLICY</a>
|
|
@@ -39,7 +39,7 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {
|
|
|
39
39
|
* </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* </ul>
|
|
42
|
-
*
|
|
42
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
43
43
|
* @example
|
|
44
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
45
|
* ```javascript
|
|
@@ -16,9 +16,9 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Cancels a handshake. Canceling a handshake sets the handshake state to
|
|
18
18
|
* <code>CANCELED</code>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use <a>DeclineHandshake</a> instead. After a handshake is canceled, the recipient
|
|
20
20
|
* can no longer respond to that handshake.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>After you cancel a handshake, it continues to appear in the results of relevant APIs
|
|
22
22
|
* for only 30 days. After that, it's deleted.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,51 +14,55 @@ export interface CloseAccountCommandInput extends CloseAccountRequest {
|
|
|
14
14
|
export interface CloseAccountCommandOutput extends __MetadataBearer {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>Closes an Amazon Web Services member account within an organization. You can
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
17
|
+
* <p>Closes an Amazon Web Services member account within an organization. You can close an account when
|
|
18
|
+
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all
|
|
19
|
+
* features are enabled </a>. You can't close the management account with this API.
|
|
20
|
+
* This is an asynchronous request that Amazon Web Services performs in the background. Because
|
|
21
|
+
* <code>CloseAccount</code> operates asynchronously, it can return a successful
|
|
22
|
+
* completion message even though account closure might still be in progress. You need to
|
|
23
|
+
* wait a few minutes before the account is fully closed. To check the status of the
|
|
24
|
+
* request, do one of the following:</p>
|
|
25
|
+
* <ul>
|
|
24
26
|
* <li>
|
|
25
|
-
*
|
|
27
|
+
* <p>Use the <code>AccountId</code> that you sent in the <code>CloseAccount</code>
|
|
26
28
|
* request to provide as a parameter to the <a>DescribeAccount</a>
|
|
27
29
|
* operation. </p>
|
|
28
|
-
*
|
|
30
|
+
* <p>While the close account request is in progress, Account status will indicate
|
|
29
31
|
* PENDING_CLOSURE. When the close account request completes, the status will
|
|
30
32
|
* change to SUSPENDED. </p>
|
|
31
33
|
* </li>
|
|
32
34
|
* <li>
|
|
33
|
-
*
|
|
35
|
+
* <p>Check the CloudTrail log for the <code>CloseAccountResult</code> event that gets
|
|
34
36
|
* published after the account closes successfully. For information on using CloudTrail
|
|
35
37
|
* with Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration">Logging and monitoring in Organizations</a> in the
|
|
36
38
|
* <i>Organizations User Guide.</i>
|
|
37
39
|
* </p>
|
|
38
40
|
* </li>
|
|
39
41
|
* </ul>
|
|
40
|
-
*
|
|
42
|
+
* <note>
|
|
41
43
|
* <ul>
|
|
42
44
|
* <li>
|
|
43
|
-
*
|
|
44
|
-
* period. This quota is not bound by a calendar month, but
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
45
|
+
* <p>You can close only 10% of member accounts, between 10 and 200, within a
|
|
46
|
+
* rolling 30 day period. This quota is not bound by a calendar month, but
|
|
47
|
+
* starts when you close an account.</p>
|
|
48
|
+
* <p>After you reach this limit, you can close additional accounts in the
|
|
49
|
+
* Billing console. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/close-account.html">Closing an
|
|
50
|
+
* account</a> in the Amazon Web Services Billing and Cost Management User Guide.</p>
|
|
51
|
+
* </li>
|
|
48
52
|
* <li>
|
|
49
|
-
*
|
|
53
|
+
* <p>To reinstate a closed account, contact Amazon Web Services Support within the 90-day
|
|
50
54
|
* grace period while the account is in SUSPENDED status. </p>
|
|
51
|
-
*
|
|
55
|
+
* </li>
|
|
52
56
|
* <li>
|
|
53
|
-
*
|
|
57
|
+
* <p>If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud
|
|
54
58
|
* (US) account, the <code>CloseAccount</code> request will close both
|
|
55
59
|
* accounts. To learn important pre-closure details, see <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/Closing-govcloud-account.html">
|
|
56
60
|
* Closing an Amazon Web Services GovCloud (US) account</a> in the <i>
|
|
57
61
|
* Amazon Web Services GovCloud User Guide</i>.</p>
|
|
58
|
-
*
|
|
62
|
+
* </li>
|
|
59
63
|
* </ul>
|
|
60
|
-
*
|
|
61
|
-
*
|
|
64
|
+
* </note>
|
|
65
|
+
* <p>For more information about closing accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing an
|
|
62
66
|
* Amazon Web Services account</a> in the <i>Organizations User Guide.</i>
|
|
63
67
|
* </p>
|
|
64
68
|
* @example
|
|
@@ -20,38 +20,38 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
|
|
|
20
20
|
* successful completion message even though account initialization might still be in
|
|
21
21
|
* progress. You might need to wait a few minutes before you can successfully access the
|
|
22
22
|
* account. To check the status of the request, do one of the following:</p>
|
|
23
|
-
*
|
|
23
|
+
* <ul>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>Use the <code>Id</code> value of the <code>CreateAccountStatus</code> response
|
|
26
26
|
* element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>Check the CloudTrail log for the <code>CreateAccountResult</code> event. For
|
|
30
30
|
* information on using CloudTrail with Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration">Logging and monitoring in Organizations</a> in the
|
|
31
31
|
* <i>Organizations User Guide.</i>
|
|
32
32
|
* </p>
|
|
33
33
|
* </li>
|
|
34
34
|
* </ul>
|
|
35
|
-
*
|
|
35
|
+
* <p>The user who calls the API to create an account must have the
|
|
36
36
|
* <code>organizations:CreateAccount</code> permission. If you enabled all features in
|
|
37
37
|
* the organization, Organizations creates the required service-linked role named
|
|
38
38
|
* <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs">Organizations and Service-Linked Roles</a> in the
|
|
39
39
|
* <i>Organizations User Guide</i>.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>If the request includes tags, then the requester must have the
|
|
41
41
|
* <code>organizations:TagResource</code> permission.</p>
|
|
42
|
-
*
|
|
42
|
+
* <p>Organizations preconfigures the new member account with a role (named
|
|
43
43
|
* <code>OrganizationAccountAccessRole</code> by default) that grants users in the
|
|
44
44
|
* management account administrator permissions in the new member account. Principals in
|
|
45
45
|
* the management account can assume the role. Organizations clones the company name and address
|
|
46
46
|
* information for the new account from the organization's management account.</p>
|
|
47
|
-
*
|
|
48
|
-
*
|
|
47
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
48
|
+
* <p>For more information about creating accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html">Creating an Amazon Web Services account in
|
|
49
49
|
* Your Organization</a> in the <i>Organizations User Guide.</i>
|
|
50
50
|
* </p>
|
|
51
|
-
*
|
|
51
|
+
* <important>
|
|
52
52
|
* <ul>
|
|
53
53
|
* <li>
|
|
54
|
-
*
|
|
54
|
+
* <p>When you create an account in an organization using the Organizations console,
|
|
55
55
|
* API, or CLI commands, the information required for the account to operate
|
|
56
56
|
* as a standalone account, such as a payment method and signing the end user
|
|
57
57
|
* license agreement (EULA) is <i>not</i> automatically
|
|
@@ -59,27 +59,27 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
|
|
|
59
59
|
* can do so only after you provide the missing information. Follow the steps
|
|
60
60
|
* at <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info"> To leave an organization as a member account</a> in the
|
|
61
61
|
* <i>Organizations User Guide</i>.</p>
|
|
62
|
-
*
|
|
62
|
+
* </li>
|
|
63
63
|
* <li>
|
|
64
|
-
*
|
|
64
|
+
* <p>If you get an exception that indicates that you exceeded your account
|
|
65
65
|
* limits for the organization, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
|
|
66
|
-
*
|
|
66
|
+
* </li>
|
|
67
67
|
* <li>
|
|
68
|
-
*
|
|
68
|
+
* <p>If you get an exception that indicates that the operation failed because
|
|
69
69
|
* your organization is still initializing, wait one hour and then try again.
|
|
70
70
|
* If the error persists, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
|
|
71
|
-
*
|
|
71
|
+
* </li>
|
|
72
72
|
* <li>
|
|
73
|
-
*
|
|
73
|
+
* <p>Using <code>CreateAccount</code> to create multiple temporary accounts
|
|
74
74
|
* isn't recommended. You can only close an account from the Billing and Cost Management console, and
|
|
75
75
|
* you must be signed in as the root user. For information on the requirements
|
|
76
76
|
* and process for closing an account, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing an
|
|
77
77
|
* Amazon Web Services account</a> in the
|
|
78
78
|
* <i>Organizations User Guide</i>.</p>
|
|
79
|
-
*
|
|
79
|
+
* </li>
|
|
80
80
|
* </ul>
|
|
81
|
-
*
|
|
82
|
-
*
|
|
81
|
+
* </important>
|
|
82
|
+
* <note>
|
|
83
83
|
* <p>When you create a member account with this operation, you can choose whether to
|
|
84
84
|
* create the account with the <b>IAM User and Role Access to
|
|
85
85
|
* Billing Information</b> switch enabled. If you enable it, IAM users and
|
|
@@ -88,7 +88,7 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
|
|
|
88
88
|
* information. For information about how to disable this switch for an account, see
|
|
89
89
|
* <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html">Granting
|
|
90
90
|
* Access to Your Billing Information and Tools</a>.</p>
|
|
91
|
-
*
|
|
91
|
+
* </note>
|
|
92
92
|
* @example
|
|
93
93
|
* Use a bare-bones client and the command you need to make an API call.
|
|
94
94
|
* ```javascript
|
|
@@ -15,49 +15,49 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>This action is available if all of the following are true:</p>
|
|
18
|
-
*
|
|
18
|
+
* <ul>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For
|
|
21
21
|
* more information on the Amazon Web Services GovCloud (US) Region, see the <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html">
|
|
22
22
|
* <i>Amazon Web Services GovCloud User Guide</i>.</a>
|
|
23
23
|
* </p>
|
|
24
24
|
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>You already have an account in the Amazon Web Services GovCloud (US) Region that is paired
|
|
27
27
|
* with a management account of an organization in the commercial Region.</p>
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>You call this action from the management account of your organization in the
|
|
31
31
|
* commercial Region.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>You have the <code>organizations:CreateGovCloudAccount</code> permission.
|
|
35
35
|
* </p>
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
|
-
*
|
|
38
|
+
* <p>Organizations automatically creates the required service-linked role named
|
|
39
39
|
* <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs">Organizations and Service-Linked Roles</a> in the
|
|
40
40
|
* <i>Organizations User Guide.</i>
|
|
41
41
|
* </p>
|
|
42
|
-
*
|
|
42
|
+
* <p>Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also
|
|
43
43
|
* do the following:</p>
|
|
44
|
-
*
|
|
44
|
+
* <ul>
|
|
45
45
|
* <li>
|
|
46
|
-
*
|
|
46
|
+
* <p>Verify that CloudTrail is enabled to store logs.</p>
|
|
47
47
|
* </li>
|
|
48
48
|
* <li>
|
|
49
|
-
*
|
|
50
|
-
*
|
|
49
|
+
* <p>Create an Amazon S3 bucket for CloudTrail log storage.</p>
|
|
50
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html">Verifying CloudTrail Is
|
|
51
51
|
* Enabled</a> in the <i>Amazon Web Services GovCloud User Guide</i>.
|
|
52
52
|
* </p>
|
|
53
53
|
* </li>
|
|
54
54
|
* </ul>
|
|
55
|
-
*
|
|
55
|
+
* <p>If the request includes tags, then the requester must have the
|
|
56
56
|
* <code>organizations:TagResource</code> permission. The tags are attached to the
|
|
57
57
|
* commercial account associated with the GovCloud account, rather than the GovCloud
|
|
58
58
|
* account itself. To add tags to the GovCloud account, call the <a>TagResource</a> operation in the GovCloud Region after the new GovCloud
|
|
59
59
|
* account exists.</p>
|
|
60
|
-
*
|
|
60
|
+
* <p>You call this action from the management account of your organization in the
|
|
61
61
|
* commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)
|
|
62
62
|
* Region. After the account is created, the management account of an organization in the
|
|
63
63
|
* Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on
|
|
@@ -65,32 +65,32 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
|
|
|
65
65
|
* <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html">Organizations</a> in the
|
|
66
66
|
* <i>Amazon Web Services GovCloud User Guide.</i>
|
|
67
67
|
* </p>
|
|
68
|
-
*
|
|
68
|
+
* <p>Calling <code>CreateGovCloudAccount</code> is an asynchronous request that Amazon Web Services
|
|
69
69
|
* performs in the background. Because <code>CreateGovCloudAccount</code> operates
|
|
70
70
|
* asynchronously, it can return a successful completion message even though account
|
|
71
71
|
* initialization might still be in progress. You might need to wait a few minutes before
|
|
72
72
|
* you can successfully access the account. To check the status of the request, do one of
|
|
73
73
|
* the following:</p>
|
|
74
|
-
*
|
|
74
|
+
* <ul>
|
|
75
75
|
* <li>
|
|
76
|
-
*
|
|
76
|
+
* <p>Use the <code>OperationId</code> response element from this operation to
|
|
77
77
|
* provide as a parameter to the <a>DescribeCreateAccountStatus</a>
|
|
78
78
|
* operation.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
81
|
+
* <p>Check the CloudTrail log for the <code>CreateAccountResult</code> event. For
|
|
82
82
|
* information on using CloudTrail with Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html">Monitoring the Activity in Your
|
|
83
83
|
* Organization</a> in the <i>Organizations User Guide.</i>
|
|
84
84
|
* </p>
|
|
85
85
|
* </li>
|
|
86
86
|
* </ul>
|
|
87
|
-
*
|
|
88
|
-
*
|
|
87
|
+
* <p></p>
|
|
88
|
+
* <p>When you call the <code>CreateGovCloudAccount</code> action, you create two accounts:
|
|
89
89
|
* a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the
|
|
90
90
|
* commercial Region for billing and support purposes. The account in the commercial Region
|
|
91
91
|
* is automatically a member of the organization whose credentials made the request. Both
|
|
92
92
|
* accounts are associated with the same email address.</p>
|
|
93
|
-
*
|
|
93
|
+
* <p>A role is created in the new account in the commercial Region that allows the
|
|
94
94
|
* management account in the organization in the commercial Region to assume it. An Amazon Web Services
|
|
95
95
|
* GovCloud (US) account is then created and associated with the commercial account that
|
|
96
96
|
* you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can
|
|
@@ -99,16 +99,14 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
|
|
|
99
99
|
* explains how account access works, see <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html">Organizations</a> in the
|
|
100
100
|
* <i>Amazon Web Services GovCloud User Guide.</i>
|
|
101
101
|
* </p>
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* <p>For more information about creating accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html">Creating
|
|
102
|
+
* <p>For more information about creating accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html">Creating
|
|
105
103
|
* an Amazon Web Services account in Your Organization</a> in the
|
|
106
104
|
* <i>Organizations User Guide.</i>
|
|
107
105
|
* </p>
|
|
108
|
-
*
|
|
106
|
+
* <important>
|
|
109
107
|
* <ul>
|
|
110
108
|
* <li>
|
|
111
|
-
*
|
|
109
|
+
* <p>When you create an account in an organization using the Organizations console,
|
|
112
110
|
* API, or CLI commands, the information required for the account to operate as
|
|
113
111
|
* a standalone account is <i>not</i> automatically collected.
|
|
114
112
|
* This includes a payment method and signing the end user license agreement
|
|
@@ -117,27 +115,27 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
|
|
|
117
115
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info"> To leave an organization as a member account</a> in the
|
|
118
116
|
* <i>Organizations User Guide.</i>
|
|
119
117
|
* </p>
|
|
120
|
-
*
|
|
118
|
+
* </li>
|
|
121
119
|
* <li>
|
|
122
|
-
*
|
|
120
|
+
* <p>If you get an exception that indicates that you exceeded your account
|
|
123
121
|
* limits for the organization, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
|
|
124
|
-
*
|
|
122
|
+
* </li>
|
|
125
123
|
* <li>
|
|
126
|
-
*
|
|
124
|
+
* <p>If you get an exception that indicates that the operation failed because
|
|
127
125
|
* your organization is still initializing, wait one hour and then try again.
|
|
128
126
|
* If the error persists, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
|
|
129
|
-
*
|
|
127
|
+
* </li>
|
|
130
128
|
* <li>
|
|
131
|
-
*
|
|
129
|
+
* <p>Using <code>CreateGovCloudAccount</code> to create multiple temporary
|
|
132
130
|
* accounts isn't recommended. You can only close an account from the Amazon Web Services
|
|
133
131
|
* Billing and Cost Management console, and you must be signed in as the root user. For information on
|
|
134
132
|
* the requirements and process for closing an account, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html">Closing an
|
|
135
133
|
* Amazon Web Services account</a> in the
|
|
136
134
|
* <i>Organizations User Guide</i>.</p>
|
|
137
|
-
*
|
|
135
|
+
* </li>
|
|
138
136
|
* </ul>
|
|
139
|
-
*
|
|
140
|
-
*
|
|
137
|
+
* </important>
|
|
138
|
+
* <note>
|
|
141
139
|
* <p>When you create a member account with this operation, you can choose whether to
|
|
142
140
|
* create the account with the <b>IAM User and Role Access to
|
|
143
141
|
* Billing Information</b> switch enabled. If you enable it, IAM users and
|
|
@@ -146,7 +144,7 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
|
|
|
146
144
|
* information. For information about how to disable this switch for an account, see
|
|
147
145
|
* <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html">Granting
|
|
148
146
|
* Access to Your Billing Information and Tools</a>.</p>
|
|
149
|
-
*
|
|
147
|
+
* </note>
|
|
150
148
|
* @example
|
|
151
149
|
* Use a bare-bones client and the command you need to make an API call.
|
|
152
150
|
* ```javascript
|
|
@@ -16,10 +16,10 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Creates an Amazon Web Services organization. The account whose user is calling the
|
|
18
18
|
* <code>CreateOrganization</code> operation automatically becomes the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">management account</a> of the new organization.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>This operation must be called using credentials from the account that is to become the
|
|
20
20
|
* new organization's management account. The principal must also have the relevant IAM
|
|
21
21
|
* permissions.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>By default (or if you set the <code>FeatureSet</code> parameter to <code>ALL</code>),
|
|
23
23
|
* the new organization is created with all features enabled and service control policies
|
|
24
24
|
* automatically enabled in the root. If you instead choose to create the organization
|
|
25
25
|
* supporting only the consolidated billing features by setting the <code>FeatureSet</code>
|
|
@@ -19,12 +19,12 @@ export interface CreateOrganizationalUnitCommandOutput extends CreateOrganizatio
|
|
|
19
19
|
* your business requirements. The number of levels deep that you can nest OUs is dependent
|
|
20
20
|
* upon the policy types enabled for that root. For service control policies, the limit is
|
|
21
21
|
* five.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>For more information about OUs, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html">Managing Organizational Units</a> in the
|
|
23
23
|
* <i>Organizations User Guide.</i>
|
|
24
24
|
* </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>If the request includes tags, then the requester must have the
|
|
26
26
|
* <code>organizations:TagResource</code> permission.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -16,11 +16,11 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Creates a policy of a specified type that you can attach to a root, an organizational
|
|
18
18
|
* unit (OU), or an individual Amazon Web Services account.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>For more information about policies and their use, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html">Managing
|
|
20
20
|
* Organization Policies</a>.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>If the request includes tags, then the requester must have the
|
|
22
22
|
* <code>organizations:TagResource</code> permission.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -16,10 +16,10 @@ export interface DeclineHandshakeCommandOutput extends DeclineHandshakeResponse,
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Declines a handshake request. This sets the handshake state to <code>DECLINED</code>
|
|
18
18
|
* and effectively deactivates the request.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>This operation can be called only from the account that received the handshake. The originator of the handshake can use <a>CancelHandshake</a>
|
|
20
20
|
* instead. The originator can't reactivate a declined request, but can reinitiate the
|
|
21
21
|
* process with a new handshake request.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>After you decline a handshake, it continues to appear in the results of relevant APIs
|
|
23
23
|
* for only 30 days. After that, it's deleted.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -16,7 +16,7 @@ export interface DeleteOrganizationalUnitCommandOutput extends __MetadataBearer
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Deletes an organizational unit (OU) from a root or another OU. You must first remove
|
|
18
18
|
* all accounts and child OUs from the OU that you want to delete.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -17,7 +17,7 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
|
|
|
17
17
|
* <p>Deletes the specified policy from your organization. Before you perform this
|
|
18
18
|
* operation, you must first detach the policy from all organizational units (OUs), roots,
|
|
19
19
|
* and accounts.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>This operation can be called only from the organization's management account.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|