@aws-sdk/client-organizations 3.775.0 → 3.782.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-types/commands/AcceptHandshakeCommand.d.ts +1 -57
- package/dist-types/commands/AttachPolicyCommand.d.ts +20 -15
- package/dist-types/commands/CancelHandshakeCommand.d.ts +1 -62
- package/dist-types/commands/CloseAccountCommand.d.ts +1 -0
- package/dist-types/commands/CreateAccountCommand.d.ts +10 -10
- package/dist-types/commands/CreateGovCloudAccountCommand.d.ts +1 -0
- package/dist-types/commands/CreateOrganizationCommand.d.ts +28 -29
- package/dist-types/commands/CreateOrganizationalUnitCommand.d.ts +11 -11
- package/dist-types/commands/CreatePolicyCommand.d.ts +16 -16
- package/dist-types/commands/DeclineHandshakeCommand.d.ts +28 -28
- package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
- package/dist-types/commands/DeleteOrganizationalUnitCommand.d.ts +9 -6
- package/dist-types/commands/DeletePolicyCommand.d.ts +9 -6
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +1 -0
- package/dist-types/commands/DeregisterDelegatedAdministratorCommand.d.ts +1 -0
- package/dist-types/commands/DescribeAccountCommand.d.ts +9 -9
- package/dist-types/commands/DescribeCreateAccountStatusCommand.d.ts +8 -8
- package/dist-types/commands/DescribeEffectivePolicyCommand.d.ts +1 -0
- package/dist-types/commands/DescribeHandshakeCommand.d.ts +26 -26
- package/dist-types/commands/DescribeOrganizationCommand.d.ts +13 -13
- package/dist-types/commands/DescribeOrganizationalUnitCommand.d.ts +8 -8
- package/dist-types/commands/DescribePolicyCommand.d.ts +13 -13
- package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +1 -0
- package/dist-types/commands/DetachPolicyCommand.d.ts +8 -5
- package/dist-types/commands/DisableAWSServiceAccessCommand.d.ts +1 -0
- package/dist-types/commands/DisablePolicyTypeCommand.d.ts +10 -10
- package/dist-types/commands/EnableAWSServiceAccessCommand.d.ts +1 -0
- package/dist-types/commands/EnableAllFeaturesCommand.d.ts +17 -17
- package/dist-types/commands/EnablePolicyTypeCommand.d.ts +12 -12
- package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts +31 -31
- package/dist-types/commands/LeaveOrganizationCommand.d.ts +7 -4
- package/dist-types/commands/ListAWSServiceAccessForOrganizationCommand.d.ts +1 -0
- package/dist-types/commands/ListAccountsCommand.d.ts +1 -51
- package/dist-types/commands/ListAccountsForParentCommand.d.ts +19 -19
- package/dist-types/commands/ListChildrenCommand.d.ts +10 -10
- package/dist-types/commands/ListCreateAccountStatusCommand.d.ts +24 -25
- package/dist-types/commands/ListDelegatedAdministratorsCommand.d.ts +1 -0
- package/dist-types/commands/ListDelegatedServicesForAccountCommand.d.ts +1 -0
- package/dist-types/commands/ListHandshakesForAccountCommand.d.ts +28 -28
- package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts +51 -51
- package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts +11 -11
- package/dist-types/commands/ListParentsCommand.d.ts +7 -7
- package/dist-types/commands/ListPoliciesCommand.d.ts +23 -23
- package/dist-types/commands/ListPoliciesForTargetCommand.d.ts +12 -12
- package/dist-types/commands/ListRootsCommand.d.ts +11 -11
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -0
- package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +17 -17
- package/dist-types/commands/MoveAccountCommand.d.ts +9 -6
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -0
- package/dist-types/commands/RegisterDelegatedAdministratorCommand.d.ts +1 -0
- package/dist-types/commands/RemoveAccountFromOrganizationCommand.d.ts +7 -4
- package/dist-types/commands/TagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UpdateOrganizationalUnitCommand.d.ts +9 -9
- package/dist-types/commands/UpdatePolicyCommand.d.ts +31 -32
- package/package.json +5 -5
|
@@ -199,28 +199,28 @@ declare const DescribeAccountCommand_base: {
|
|
|
199
199
|
* @throws {@link OrganizationsServiceException}
|
|
200
200
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
201
201
|
*
|
|
202
|
-
*
|
|
202
|
+
*
|
|
203
203
|
* @example To get the details about an account
|
|
204
204
|
* ```javascript
|
|
205
205
|
* // The following example shows a user in the master account (111111111111) asking for details about account 555555555555:
|
|
206
206
|
* const input = {
|
|
207
|
-
*
|
|
207
|
+
* AccountId: "555555555555"
|
|
208
208
|
* };
|
|
209
209
|
* const command = new DescribeAccountCommand(input);
|
|
210
210
|
* const response = await client.send(command);
|
|
211
|
-
* /* response
|
|
211
|
+
* /* response is
|
|
212
212
|
* {
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
213
|
+
* Account: {
|
|
214
|
+
* Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555",
|
|
215
|
+
* Email: "anika@example.com",
|
|
216
|
+
* Id: "555555555555",
|
|
217
|
+
* Name: "Beta Account"
|
|
218
218
|
* }
|
|
219
219
|
* }
|
|
220
220
|
* *\/
|
|
221
|
-
* // example id: to-get-the-details-about-an-account-1472503166868
|
|
222
221
|
* ```
|
|
223
222
|
*
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
export declare class DescribeAccountCommand extends DescribeAccountCommand_base {
|
|
226
226
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -202,27 +202,27 @@ declare const DescribeCreateAccountStatusCommand_base: {
|
|
|
202
202
|
* @throws {@link OrganizationsServiceException}
|
|
203
203
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
204
204
|
*
|
|
205
|
-
*
|
|
205
|
+
*
|
|
206
206
|
* @example To get information about a request to create an account
|
|
207
207
|
* ```javascript
|
|
208
208
|
* // The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified "createAccountRequestId" comes from the response of the original call to "CreateAccount":
|
|
209
209
|
* const input = {
|
|
210
|
-
*
|
|
210
|
+
* CreateAccountRequestId: "car-exampleaccountcreationrequestid"
|
|
211
211
|
* };
|
|
212
212
|
* const command = new DescribeCreateAccountStatusCommand(input);
|
|
213
213
|
* const response = await client.send(command);
|
|
214
|
-
* /* response
|
|
214
|
+
* /* response is
|
|
215
215
|
* {
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
216
|
+
* CreateAccountStatus: {
|
|
217
|
+
* AccountId: "333333333333",
|
|
218
|
+
* Id: "car-exampleaccountcreationrequestid",
|
|
219
|
+
* State: "SUCCEEDED"
|
|
220
220
|
* }
|
|
221
221
|
* }
|
|
222
222
|
* *\/
|
|
223
|
-
* // example id: to-get-information-about-a-request-to-create-an-account-1472503727223
|
|
224
223
|
* ```
|
|
225
224
|
*
|
|
225
|
+
* @public
|
|
226
226
|
*/
|
|
227
227
|
export declare class DescribeCreateAccountStatusCommand extends DescribeCreateAccountStatusCommand_base {
|
|
228
228
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -412,6 +412,7 @@ declare const DescribeEffectivePolicyCommand_base: {
|
|
|
412
412
|
* @throws {@link OrganizationsServiceException}
|
|
413
413
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
414
414
|
*
|
|
415
|
+
*
|
|
415
416
|
* @public
|
|
416
417
|
*/
|
|
417
418
|
export declare class DescribeEffectivePolicyCommand extends DescribeEffectivePolicyCommand_base {
|
|
@@ -219,60 +219,60 @@ declare const DescribeHandshakeCommand_base: {
|
|
|
219
219
|
* @throws {@link OrganizationsServiceException}
|
|
220
220
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
221
221
|
*
|
|
222
|
-
*
|
|
222
|
+
*
|
|
223
223
|
* @example To get information about a handshake
|
|
224
224
|
* ```javascript
|
|
225
225
|
* // The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization":
|
|
226
226
|
* const input = {
|
|
227
|
-
*
|
|
227
|
+
* HandshakeId: "h-examplehandshakeid111"
|
|
228
228
|
* };
|
|
229
229
|
* const command = new DescribeHandshakeCommand(input);
|
|
230
230
|
* const response = await client.send(command);
|
|
231
|
-
* /* response
|
|
231
|
+
* /* response is
|
|
232
232
|
* {
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
233
|
+
* Handshake: {
|
|
234
|
+
* Action: "INVITE",
|
|
235
|
+
* Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
236
|
+
* ExpirationTimestamp: "2016-11-30T17:24:58.046Z",
|
|
237
|
+
* Id: "h-examplehandshakeid111",
|
|
238
|
+
* Parties: [
|
|
239
239
|
* {
|
|
240
|
-
*
|
|
241
|
-
*
|
|
240
|
+
* Id: "o-exampleorgid",
|
|
241
|
+
* Type: "ORGANIZATION"
|
|
242
242
|
* },
|
|
243
243
|
* {
|
|
244
|
-
*
|
|
245
|
-
*
|
|
244
|
+
* Id: "333333333333",
|
|
245
|
+
* Type: "ACCOUNT"
|
|
246
246
|
* }
|
|
247
247
|
* ],
|
|
248
|
-
*
|
|
249
|
-
*
|
|
248
|
+
* RequestedTimestamp: "2016-11-30T17:24:58.046Z",
|
|
249
|
+
* Resources: [
|
|
250
250
|
* {
|
|
251
|
-
*
|
|
251
|
+
* Resources: [
|
|
252
252
|
* {
|
|
253
|
-
*
|
|
254
|
-
*
|
|
253
|
+
* Type: "MASTER_EMAIL",
|
|
254
|
+
* Value: "bill@example.com"
|
|
255
255
|
* },
|
|
256
256
|
* {
|
|
257
|
-
*
|
|
258
|
-
*
|
|
257
|
+
* Type: "MASTER_NAME",
|
|
258
|
+
* Value: "Master Account"
|
|
259
259
|
* }
|
|
260
260
|
* ],
|
|
261
|
-
*
|
|
262
|
-
*
|
|
261
|
+
* Type: "ORGANIZATION",
|
|
262
|
+
* Value: "o-exampleorgid"
|
|
263
263
|
* },
|
|
264
264
|
* {
|
|
265
|
-
*
|
|
266
|
-
*
|
|
265
|
+
* Type: "ACCOUNT",
|
|
266
|
+
* Value: "333333333333"
|
|
267
267
|
* }
|
|
268
268
|
* ],
|
|
269
|
-
*
|
|
269
|
+
* State: "OPEN"
|
|
270
270
|
* }
|
|
271
271
|
* }
|
|
272
272
|
* *\/
|
|
273
|
-
* // example id: to-get-information-about-a-handshake-1472503400505
|
|
274
273
|
* ```
|
|
275
274
|
*
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
export declare class DescribeHandshakeCommand extends DescribeHandshakeCommand_base {
|
|
278
278
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -96,33 +96,33 @@ declare const DescribeOrganizationCommand_base: {
|
|
|
96
96
|
* @throws {@link OrganizationsServiceException}
|
|
97
97
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
98
98
|
*
|
|
99
|
-
*
|
|
99
|
+
*
|
|
100
100
|
* @example To get information about an organization
|
|
101
101
|
* ```javascript
|
|
102
102
|
* // The following example shows how to request information about the current user's organization:/n/n
|
|
103
|
-
* const input = {};
|
|
103
|
+
* const input = { /* empty *\/ };
|
|
104
104
|
* const command = new DescribeOrganizationCommand(input);
|
|
105
105
|
* const response = await client.send(command);
|
|
106
|
-
* /* response
|
|
106
|
+
* /* response is
|
|
107
107
|
* {
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
108
|
+
* Organization: {
|
|
109
|
+
* Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid",
|
|
110
|
+
* AvailablePolicyTypes: [
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* Status: "ENABLED",
|
|
113
|
+
* Type: "SERVICE_CONTROL_POLICY"
|
|
114
114
|
* }
|
|
115
115
|
* ],
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
116
|
+
* FeatureSet: "ALL",
|
|
117
|
+
* Id: "o-exampleorgid",
|
|
118
|
+
* MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
|
|
119
|
+
* MasterAccountEmail: "bill@example.com"
|
|
120
120
|
* }
|
|
121
121
|
* }
|
|
122
122
|
* *\/
|
|
123
|
-
* // example id: to-get-information-about-an-organization-1472503400505
|
|
124
123
|
* ```
|
|
125
124
|
*
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
export declare class DescribeOrganizationCommand extends DescribeOrganizationCommand_base {
|
|
128
128
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -194,27 +194,27 @@ declare const DescribeOrganizationalUnitCommand_base: {
|
|
|
194
194
|
* @throws {@link OrganizationsServiceException}
|
|
195
195
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
196
196
|
*
|
|
197
|
-
*
|
|
197
|
+
*
|
|
198
198
|
* @example To get information about an organizational unit
|
|
199
199
|
* ```javascript
|
|
200
200
|
* // The following example shows how to request details about an OU:
|
|
201
201
|
* const input = {
|
|
202
|
-
*
|
|
202
|
+
* OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
|
|
203
203
|
* };
|
|
204
204
|
* const command = new DescribeOrganizationalUnitCommand(input);
|
|
205
205
|
* const response = await client.send(command);
|
|
206
|
-
* /* response
|
|
206
|
+
* /* response is
|
|
207
207
|
* {
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
208
|
+
* OrganizationalUnit: {
|
|
209
|
+
* Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
|
|
210
|
+
* Id: "ou-examplerootid111-exampleouid111",
|
|
211
|
+
* Name: "Accounting Group"
|
|
212
212
|
* }
|
|
213
213
|
* }
|
|
214
214
|
* *\/
|
|
215
|
-
* // example id: to-get-information-about-an-organizational-unit
|
|
216
215
|
* ```
|
|
217
216
|
*
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
export declare class DescribeOrganizationalUnitCommand extends DescribeOrganizationalUnitCommand_base {
|
|
220
220
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -202,33 +202,33 @@ declare const DescribePolicyCommand_base: {
|
|
|
202
202
|
* @throws {@link OrganizationsServiceException}
|
|
203
203
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
204
204
|
*
|
|
205
|
-
*
|
|
205
|
+
*
|
|
206
206
|
* @example To get information about a policy
|
|
207
207
|
* ```javascript
|
|
208
208
|
* // The following example shows how to request information about a policy:/n/n
|
|
209
209
|
* const input = {
|
|
210
|
-
*
|
|
210
|
+
* PolicyId: "p-examplepolicyid111"
|
|
211
211
|
* };
|
|
212
212
|
* const command = new DescribePolicyCommand(input);
|
|
213
213
|
* const response = await client.send(command);
|
|
214
|
-
* /* response
|
|
214
|
+
* /* response is
|
|
215
215
|
* {
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
216
|
+
* Policy: {
|
|
217
|
+
* Content: `{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}`,
|
|
218
|
+
* PolicySummary: {
|
|
219
|
+
* Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
|
|
220
|
+
* AwsManaged: false,
|
|
221
|
+
* Description: "Enables admins to delegate S3 permissions",
|
|
222
|
+
* Id: "p-examplepolicyid111",
|
|
223
|
+
* Name: "AllowAllS3Actions",
|
|
224
|
+
* Type: "SERVICE_CONTROL_POLICY"
|
|
225
225
|
* }
|
|
226
226
|
* }
|
|
227
227
|
* }
|
|
228
228
|
* *\/
|
|
229
|
-
* // example id: to-get-information-about-a-policy
|
|
230
229
|
* ```
|
|
231
230
|
*
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
export declare class DescribePolicyCommand extends DescribePolicyCommand_base {
|
|
234
234
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -286,6 +286,7 @@ declare const DescribeResourcePolicyCommand_base: {
|
|
|
286
286
|
* @throws {@link OrganizationsServiceException}
|
|
287
287
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
288
288
|
*
|
|
289
|
+
*
|
|
289
290
|
* @public
|
|
290
291
|
*/
|
|
291
292
|
export declare class DescribeResourcePolicyCommand extends DescribeResourcePolicyCommand_base {
|
|
@@ -419,19 +419,22 @@ declare const DetachPolicyCommand_base: {
|
|
|
419
419
|
* @throws {@link OrganizationsServiceException}
|
|
420
420
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
421
421
|
*
|
|
422
|
-
*
|
|
422
|
+
*
|
|
423
423
|
* @example To detach a policy from a root, OU, or account
|
|
424
424
|
* ```javascript
|
|
425
425
|
* // The following example shows how to detach a policy from an OU:/n/n
|
|
426
426
|
* const input = {
|
|
427
|
-
*
|
|
428
|
-
*
|
|
427
|
+
* PolicyId: "p-examplepolicyid111",
|
|
428
|
+
* TargetId: "ou-examplerootid111-exampleouid111"
|
|
429
429
|
* };
|
|
430
430
|
* const command = new DetachPolicyCommand(input);
|
|
431
|
-
* await client.send(command);
|
|
432
|
-
*
|
|
431
|
+
* const response = await client.send(command);
|
|
432
|
+
* /* response is
|
|
433
|
+
* { /* metadata only *\/ }
|
|
434
|
+
* *\/
|
|
433
435
|
* ```
|
|
434
436
|
*
|
|
437
|
+
* @public
|
|
435
438
|
*/
|
|
436
439
|
export declare class DetachPolicyCommand extends DetachPolicyCommand_base {
|
|
437
440
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -443,6 +443,7 @@ declare const DisableAWSServiceAccessCommand_base: {
|
|
|
443
443
|
* @throws {@link OrganizationsServiceException}
|
|
444
444
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
445
445
|
*
|
|
446
|
+
*
|
|
446
447
|
* @public
|
|
447
448
|
*/
|
|
448
449
|
export declare class DisableAWSServiceAccessCommand extends DisableAWSServiceAccessCommand_base {
|
|
@@ -426,29 +426,29 @@ declare const DisablePolicyTypeCommand_base: {
|
|
|
426
426
|
* @throws {@link OrganizationsServiceException}
|
|
427
427
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
428
428
|
*
|
|
429
|
-
*
|
|
429
|
+
*
|
|
430
430
|
* @example To disable a policy type in a root
|
|
431
431
|
* ```javascript
|
|
432
432
|
* // The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n
|
|
433
433
|
* const input = {
|
|
434
|
-
*
|
|
435
|
-
*
|
|
434
|
+
* PolicyType: "SERVICE_CONTROL_POLICY",
|
|
435
|
+
* RootId: "r-examplerootid111"
|
|
436
436
|
* };
|
|
437
437
|
* const command = new DisablePolicyTypeCommand(input);
|
|
438
438
|
* const response = await client.send(command);
|
|
439
|
-
* /* response
|
|
439
|
+
* /* response is
|
|
440
440
|
* {
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
441
|
+
* Root: {
|
|
442
|
+
* Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
|
|
443
|
+
* Id: "r-examplerootid111",
|
|
444
|
+
* Name: "Root",
|
|
445
|
+
* PolicyTypes: []
|
|
446
446
|
* }
|
|
447
447
|
* }
|
|
448
448
|
* *\/
|
|
449
|
-
* // example id: to-disable-a-policy-type-in-a-root
|
|
450
449
|
* ```
|
|
451
450
|
*
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
export declare class DisablePolicyTypeCommand extends DisablePolicyTypeCommand_base {
|
|
454
454
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -408,6 +408,7 @@ declare const EnableAWSServiceAccessCommand_base: {
|
|
|
408
408
|
* @throws {@link OrganizationsServiceException}
|
|
409
409
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
410
410
|
*
|
|
411
|
+
*
|
|
411
412
|
* @public
|
|
412
413
|
*/
|
|
413
414
|
export declare class EnableAWSServiceAccessCommand extends EnableAWSServiceAccessCommand_base {
|
|
@@ -496,40 +496,40 @@ declare const EnableAllFeaturesCommand_base: {
|
|
|
496
496
|
* @throws {@link OrganizationsServiceException}
|
|
497
497
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
498
498
|
*
|
|
499
|
-
*
|
|
499
|
+
*
|
|
500
500
|
* @example To enable all features in an organization
|
|
501
501
|
* ```javascript
|
|
502
502
|
* // This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n
|
|
503
|
-
* const input = {};
|
|
503
|
+
* const input = { /* empty *\/ };
|
|
504
504
|
* const command = new EnableAllFeaturesCommand(input);
|
|
505
505
|
* const response = await client.send(command);
|
|
506
|
-
* /* response
|
|
506
|
+
* /* response is
|
|
507
507
|
* {
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
508
|
+
* Handshake: {
|
|
509
|
+
* Action: "ENABLE_ALL_FEATURES",
|
|
510
|
+
* Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111",
|
|
511
|
+
* ExpirationTimestamp: "2017-02-28T09:35:40.05Z",
|
|
512
|
+
* Id: "h-examplehandshakeid111",
|
|
513
|
+
* Parties: [
|
|
514
514
|
* {
|
|
515
|
-
*
|
|
516
|
-
*
|
|
515
|
+
* Id: "o-exampleorgid",
|
|
516
|
+
* Type: "ORGANIZATION"
|
|
517
517
|
* }
|
|
518
518
|
* ],
|
|
519
|
-
*
|
|
520
|
-
*
|
|
519
|
+
* RequestedTimestamp: "2017-02-13T09:35:40.05Z",
|
|
520
|
+
* Resources: [
|
|
521
521
|
* {
|
|
522
|
-
*
|
|
523
|
-
*
|
|
522
|
+
* Type: "ORGANIZATION",
|
|
523
|
+
* Value: "o-exampleorgid"
|
|
524
524
|
* }
|
|
525
525
|
* ],
|
|
526
|
-
*
|
|
526
|
+
* State: "REQUESTED"
|
|
527
527
|
* }
|
|
528
528
|
* }
|
|
529
529
|
* *\/
|
|
530
|
-
* // example id: to-enable-all-features-in-an-organization
|
|
531
530
|
* ```
|
|
532
531
|
*
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
export declare class EnableAllFeaturesCommand extends EnableAllFeaturesCommand_base {
|
|
535
535
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -429,34 +429,34 @@ declare const EnablePolicyTypeCommand_base: {
|
|
|
429
429
|
* @throws {@link OrganizationsServiceException}
|
|
430
430
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
431
431
|
*
|
|
432
|
-
*
|
|
432
|
+
*
|
|
433
433
|
* @example To enable a policy type in a root
|
|
434
434
|
* ```javascript
|
|
435
435
|
* // The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n
|
|
436
436
|
* const input = {
|
|
437
|
-
*
|
|
438
|
-
*
|
|
437
|
+
* PolicyType: "SERVICE_CONTROL_POLICY",
|
|
438
|
+
* RootId: "r-examplerootid111"
|
|
439
439
|
* };
|
|
440
440
|
* const command = new EnablePolicyTypeCommand(input);
|
|
441
441
|
* const response = await client.send(command);
|
|
442
|
-
* /* response
|
|
442
|
+
* /* response is
|
|
443
443
|
* {
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
444
|
+
* Root: {
|
|
445
|
+
* Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
|
|
446
|
+
* Id: "r-examplerootid111",
|
|
447
|
+
* Name: "Root",
|
|
448
|
+
* PolicyTypes: [
|
|
449
449
|
* {
|
|
450
|
-
*
|
|
451
|
-
*
|
|
450
|
+
* Status: "ENABLED",
|
|
451
|
+
* Type: "SERVICE_CONTROL_POLICY"
|
|
452
452
|
* }
|
|
453
453
|
* ]
|
|
454
454
|
* }
|
|
455
455
|
* }
|
|
456
456
|
* *\/
|
|
457
|
-
* // example id: to-enable-a-policy-type-in-a-root
|
|
458
457
|
* ```
|
|
459
458
|
*
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
export declare class EnablePolicyTypeCommand extends EnablePolicyTypeCommand_base {
|
|
462
462
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -527,68 +527,68 @@ declare const InviteAccountToOrganizationCommand_base: {
|
|
|
527
527
|
* @throws {@link OrganizationsServiceException}
|
|
528
528
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
529
529
|
*
|
|
530
|
-
*
|
|
530
|
+
*
|
|
531
531
|
* @example To invite an account to join an organization
|
|
532
532
|
* ```javascript
|
|
533
533
|
* // The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.
|
|
534
534
|
* const input = {
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
535
|
+
* Notes: "This is a request for Juan's account to join Bill's organization",
|
|
536
|
+
* Target: {
|
|
537
|
+
* Id: "juan@example.com",
|
|
538
|
+
* Type: "EMAIL"
|
|
539
539
|
* }
|
|
540
540
|
* };
|
|
541
541
|
* const command = new InviteAccountToOrganizationCommand(input);
|
|
542
542
|
* const response = await client.send(command);
|
|
543
|
-
* /* response
|
|
543
|
+
* /* response is
|
|
544
544
|
* {
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
545
|
+
* Handshake: {
|
|
546
|
+
* Action: "INVITE",
|
|
547
|
+
* Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
548
|
+
* ExpirationTimestamp: "2017-02-16T09:36:05.02Z",
|
|
549
|
+
* Id: "h-examplehandshakeid111",
|
|
550
|
+
* Parties: [
|
|
551
551
|
* {
|
|
552
|
-
*
|
|
553
|
-
*
|
|
552
|
+
* Id: "o-exampleorgid",
|
|
553
|
+
* Type: "ORGANIZATION"
|
|
554
554
|
* },
|
|
555
555
|
* {
|
|
556
|
-
*
|
|
557
|
-
*
|
|
556
|
+
* Id: "juan@example.com",
|
|
557
|
+
* Type: "EMAIL"
|
|
558
558
|
* }
|
|
559
559
|
* ],
|
|
560
|
-
*
|
|
561
|
-
*
|
|
560
|
+
* RequestedTimestamp: "2017-02-01T09:36:05.02Z",
|
|
561
|
+
* Resources: [
|
|
562
562
|
* {
|
|
563
|
-
*
|
|
563
|
+
* Resources: [
|
|
564
564
|
* {
|
|
565
|
-
*
|
|
566
|
-
*
|
|
565
|
+
* Type: "MASTER_EMAIL",
|
|
566
|
+
* Value: "bill@amazon.com"
|
|
567
567
|
* },
|
|
568
568
|
* {
|
|
569
|
-
*
|
|
570
|
-
*
|
|
569
|
+
* Type: "MASTER_NAME",
|
|
570
|
+
* Value: "Org Master Account"
|
|
571
571
|
* },
|
|
572
572
|
* {
|
|
573
|
-
*
|
|
574
|
-
*
|
|
573
|
+
* Type: "ORGANIZATION_FEATURE_SET",
|
|
574
|
+
* Value: "FULL"
|
|
575
575
|
* }
|
|
576
576
|
* ],
|
|
577
|
-
*
|
|
578
|
-
*
|
|
577
|
+
* Type: "ORGANIZATION",
|
|
578
|
+
* Value: "o-exampleorgid"
|
|
579
579
|
* },
|
|
580
580
|
* {
|
|
581
|
-
*
|
|
582
|
-
*
|
|
581
|
+
* Type: "EMAIL",
|
|
582
|
+
* Value: "juan@example.com"
|
|
583
583
|
* }
|
|
584
584
|
* ],
|
|
585
|
-
*
|
|
585
|
+
* State: "OPEN"
|
|
586
586
|
* }
|
|
587
587
|
* }
|
|
588
588
|
* *\/
|
|
589
|
-
* // example id: to-invite-an-account-to-join-an-organization-1472508594110
|
|
590
589
|
* ```
|
|
591
590
|
*
|
|
591
|
+
* @public
|
|
592
592
|
*/
|
|
593
593
|
export declare class InviteAccountToOrganizationCommand extends InviteAccountToOrganizationCommand_base {
|
|
594
594
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -459,16 +459,19 @@ declare const LeaveOrganizationCommand_base: {
|
|
|
459
459
|
* @throws {@link OrganizationsServiceException}
|
|
460
460
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
461
461
|
*
|
|
462
|
-
*
|
|
462
|
+
*
|
|
463
463
|
* @example To leave an organization as a member account
|
|
464
464
|
* ```javascript
|
|
465
465
|
* // TThe following example shows how to remove your member account from an organization:
|
|
466
|
-
* const input = {};
|
|
466
|
+
* const input = { /* empty *\/ };
|
|
467
467
|
* const command = new LeaveOrganizationCommand(input);
|
|
468
|
-
* await client.send(command);
|
|
469
|
-
*
|
|
468
|
+
* const response = await client.send(command);
|
|
469
|
+
* /* response is
|
|
470
|
+
* { /* metadata only *\/ }
|
|
471
|
+
* *\/
|
|
470
472
|
* ```
|
|
471
473
|
*
|
|
474
|
+
* @public
|
|
472
475
|
*/
|
|
473
476
|
export declare class LeaveOrganizationCommand extends LeaveOrganizationCommand_base {
|
|
474
477
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -401,6 +401,7 @@ declare const ListAWSServiceAccessForOrganizationCommand_base: {
|
|
|
401
401
|
* @throws {@link OrganizationsServiceException}
|
|
402
402
|
* <p>Base exception class for all service exceptions from Organizations service.</p>
|
|
403
403
|
*
|
|
404
|
+
*
|
|
404
405
|
* @public
|
|
405
406
|
*/
|
|
406
407
|
export declare class ListAWSServiceAccessForOrganizationCommand extends ListAWSServiceAccessForOrganizationCommand_base {
|