@aws-sdk/client-organizations 3.321.1 → 3.326.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.
Files changed (56) hide show
  1. package/dist-types/commands/AcceptHandshakeCommand.d.ts +32 -0
  2. package/dist-types/commands/AttachPolicyCommand.d.ts +4 -0
  3. package/dist-types/commands/CancelHandshakeCommand.d.ts +32 -0
  4. package/dist-types/commands/CloseAccountCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateAccountCommand.d.ts +15 -0
  6. package/dist-types/commands/CreateGovCloudAccountCommand.d.ts +15 -0
  7. package/dist-types/commands/CreateOrganizationCommand.d.ts +19 -0
  8. package/dist-types/commands/CreateOrganizationalUnitCommand.d.ts +10 -0
  9. package/dist-types/commands/CreatePolicyCommand.d.ts +16 -0
  10. package/dist-types/commands/DeclineHandshakeCommand.d.ts +32 -0
  11. package/dist-types/commands/DeleteOrganizationCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteOrganizationalUnitCommand.d.ts +4 -0
  13. package/dist-types/commands/DeletePolicyCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  15. package/dist-types/commands/DeregisterDelegatedAdministratorCommand.d.ts +4 -0
  16. package/dist-types/commands/DescribeAccountCommand.d.ts +14 -0
  17. package/dist-types/commands/DescribeCreateAccountStatusCommand.d.ts +15 -0
  18. package/dist-types/commands/DescribeEffectivePolicyCommand.d.ts +11 -0
  19. package/dist-types/commands/DescribeHandshakeCommand.d.ts +32 -0
  20. package/dist-types/commands/DescribeOrganizationCommand.d.ts +19 -0
  21. package/dist-types/commands/DescribeOrganizationalUnitCommand.d.ts +10 -0
  22. package/dist-types/commands/DescribePolicyCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +12 -0
  24. package/dist-types/commands/DetachPolicyCommand.d.ts +4 -0
  25. package/dist-types/commands/DisableAWSServiceAccessCommand.d.ts +4 -0
  26. package/dist-types/commands/DisablePolicyTypeCommand.d.ts +16 -0
  27. package/dist-types/commands/EnableAWSServiceAccessCommand.d.ts +4 -0
  28. package/dist-types/commands/EnableAllFeaturesCommand.d.ts +32 -0
  29. package/dist-types/commands/EnablePolicyTypeCommand.d.ts +16 -0
  30. package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts +32 -0
  31. package/dist-types/commands/LeaveOrganizationCommand.d.ts +4 -0
  32. package/dist-types/commands/ListAWSServiceAccessForOrganizationCommand.d.ts +12 -0
  33. package/dist-types/commands/ListAccountsCommand.d.ts +17 -0
  34. package/dist-types/commands/ListAccountsForParentCommand.d.ts +17 -0
  35. package/dist-types/commands/ListChildrenCommand.d.ts +12 -0
  36. package/dist-types/commands/ListCreateAccountStatusCommand.d.ts +18 -0
  37. package/dist-types/commands/ListDelegatedAdministratorsCommand.d.ts +18 -0
  38. package/dist-types/commands/ListDelegatedServicesForAccountCommand.d.ts +12 -0
  39. package/dist-types/commands/ListHandshakesForAccountCommand.d.ts +35 -0
  40. package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts +35 -0
  41. package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts +13 -0
  42. package/dist-types/commands/ListParentsCommand.d.ts +12 -0
  43. package/dist-types/commands/ListPoliciesCommand.d.ts +16 -0
  44. package/dist-types/commands/ListPoliciesForTargetCommand.d.ts +16 -0
  45. package/dist-types/commands/ListRootsCommand.d.ts +19 -0
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
  47. package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +14 -0
  48. package/dist-types/commands/MoveAccountCommand.d.ts +4 -0
  49. package/dist-types/commands/PutResourcePolicyCommand.d.ts +12 -0
  50. package/dist-types/commands/RegisterDelegatedAdministratorCommand.d.ts +4 -0
  51. package/dist-types/commands/RemoveAccountFromOrganizationCommand.d.ts +4 -0
  52. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  53. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  54. package/dist-types/commands/UpdateOrganizationalUnitCommand.d.ts +10 -0
  55. package/dist-types/commands/UpdatePolicyCommand.d.ts +16 -0
  56. package/package.json +16 -16
@@ -61,6 +61,36 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
61
61
  * };
62
62
  * const command = new AcceptHandshakeCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // AcceptHandshakeResponse
65
+ * // Handshake: { // Handshake
66
+ * // Id: "STRING_VALUE",
67
+ * // Arn: "STRING_VALUE",
68
+ * // Parties: [ // HandshakeParties
69
+ * // { // HandshakeParty
70
+ * // Id: "STRING_VALUE", // required
71
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
72
+ * // },
73
+ * // ],
74
+ * // State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
75
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
76
+ * // ExpirationTimestamp: new Date("TIMESTAMP"),
77
+ * // Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
78
+ * // Resources: [ // HandshakeResources
79
+ * // { // HandshakeResource
80
+ * // Value: "STRING_VALUE",
81
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
82
+ * // Resources: [
83
+ * // {
84
+ * // Value: "STRING_VALUE",
85
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
86
+ * // Resources: "<HandshakeResources>",
87
+ * // },
88
+ * // ],
89
+ * // },
90
+ * // ],
91
+ * // },
92
+ * // };
93
+ *
64
94
  * ```
65
95
  *
66
96
  * @param AcceptHandshakeCommandInput - {@link AcceptHandshakeCommandInput}
@@ -276,6 +306,8 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
276
306
  * <i>Organizations User Guide.</i>
277
307
  * </p>
278
308
  *
309
+ * @throws {@link OrganizationsServiceException}
310
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
279
311
  *
280
312
  * @example To accept a handshake from another account
281
313
  * ```javascript
@@ -57,6 +57,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {
57
57
  * };
58
58
  * const command = new AttachPolicyCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // {};
61
+ *
60
62
  * ```
61
63
  *
62
64
  * @param AttachPolicyCommandInput - {@link AttachPolicyCommandInput}
@@ -416,6 +418,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {
416
418
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
417
419
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
418
420
  *
421
+ * @throws {@link OrganizationsServiceException}
422
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
419
423
  *
420
424
  * @example To attach a policy to an OU
421
425
  * ```javascript
@@ -36,6 +36,36 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
36
36
  * };
37
37
  * const command = new CancelHandshakeCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // CancelHandshakeResponse
40
+ * // Handshake: { // Handshake
41
+ * // Id: "STRING_VALUE",
42
+ * // Arn: "STRING_VALUE",
43
+ * // Parties: [ // HandshakeParties
44
+ * // { // HandshakeParty
45
+ * // Id: "STRING_VALUE", // required
46
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
47
+ * // },
48
+ * // ],
49
+ * // State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
50
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
51
+ * // ExpirationTimestamp: new Date("TIMESTAMP"),
52
+ * // Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
53
+ * // Resources: [ // HandshakeResources
54
+ * // { // HandshakeResource
55
+ * // Value: "STRING_VALUE",
56
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
57
+ * // Resources: [
58
+ * // {
59
+ * // Value: "STRING_VALUE",
60
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
61
+ * // Resources: "<HandshakeResources>",
62
+ * // },
63
+ * // ],
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // };
68
+ *
39
69
  * ```
40
70
  *
41
71
  * @param CancelHandshakeCommandInput - {@link CancelHandshakeCommandInput}
@@ -182,6 +212,8 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
182
212
  * <i>Organizations User Guide.</i>
183
213
  * </p>
184
214
  *
215
+ * @throws {@link OrganizationsServiceException}
216
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
185
217
  *
186
218
  * @example To cancel a handshake sent to a member account
187
219
  * ```javascript
@@ -81,6 +81,8 @@ export interface CloseAccountCommandOutput extends __MetadataBearer {
81
81
  * };
82
82
  * const command = new CloseAccountCommand(input);
83
83
  * const response = await client.send(command);
84
+ * // {};
85
+ *
84
86
  * ```
85
87
  *
86
88
  * @param CloseAccountCommandInput - {@link CloseAccountCommandInput}
@@ -431,6 +433,8 @@ export interface CloseAccountCommandOutput extends __MetadataBearer {
431
433
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
432
434
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
433
435
  *
436
+ * @throws {@link OrganizationsServiceException}
437
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
434
438
  *
435
439
  */
436
440
  export declare class CloseAccountCommand extends $Command<CloseAccountCommandInput, CloseAccountCommandOutput, OrganizationsClientResolvedConfig> {
@@ -114,6 +114,19 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
114
114
  * };
115
115
  * const command = new CreateAccountCommand(input);
116
116
  * const response = await client.send(command);
117
+ * // { // CreateAccountResponse
118
+ * // CreateAccountStatus: { // CreateAccountStatus
119
+ * // Id: "STRING_VALUE",
120
+ * // AccountName: "STRING_VALUE",
121
+ * // State: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
122
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
123
+ * // CompletedTimestamp: new Date("TIMESTAMP"),
124
+ * // AccountId: "STRING_VALUE",
125
+ * // GovCloudAccountId: "STRING_VALUE",
126
+ * // FailureReason: "ACCOUNT_LIMIT_EXCEEDED" || "EMAIL_ALREADY_EXISTS" || "INVALID_ADDRESS" || "INVALID_EMAIL" || "CONCURRENT_ACCOUNT_MODIFICATION" || "INTERNAL_FAILURE" || "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" || "MISSING_BUSINESS_VALIDATION" || "FAILED_BUSINESS_VALIDATION" || "PENDING_BUSINESS_VALIDATION" || "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION" || "UNKNOWN_BUSINESS_VALIDATION" || "MISSING_PAYMENT_INSTRUMENT" || "INVALID_PAYMENT_INSTRUMENT" || "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED",
127
+ * // },
128
+ * // };
129
+ *
117
130
  * ```
118
131
  *
119
132
  * @param CreateAccountCommandInput - {@link CreateAccountCommandInput}
@@ -457,6 +470,8 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
457
470
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
458
471
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
459
472
  *
473
+ * @throws {@link OrganizationsServiceException}
474
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
460
475
  *
461
476
  * @example To create a new account that is automatically part of the organization
462
477
  * ```javascript
@@ -170,6 +170,19 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
170
170
  * };
171
171
  * const command = new CreateGovCloudAccountCommand(input);
172
172
  * const response = await client.send(command);
173
+ * // { // CreateGovCloudAccountResponse
174
+ * // CreateAccountStatus: { // CreateAccountStatus
175
+ * // Id: "STRING_VALUE",
176
+ * // AccountName: "STRING_VALUE",
177
+ * // State: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
178
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
179
+ * // CompletedTimestamp: new Date("TIMESTAMP"),
180
+ * // AccountId: "STRING_VALUE",
181
+ * // GovCloudAccountId: "STRING_VALUE",
182
+ * // FailureReason: "ACCOUNT_LIMIT_EXCEEDED" || "EMAIL_ALREADY_EXISTS" || "INVALID_ADDRESS" || "INVALID_EMAIL" || "CONCURRENT_ACCOUNT_MODIFICATION" || "INTERNAL_FAILURE" || "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" || "MISSING_BUSINESS_VALIDATION" || "FAILED_BUSINESS_VALIDATION" || "PENDING_BUSINESS_VALIDATION" || "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION" || "UNKNOWN_BUSINESS_VALIDATION" || "MISSING_PAYMENT_INSTRUMENT" || "INVALID_PAYMENT_INSTRUMENT" || "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED",
183
+ * // },
184
+ * // };
185
+ *
173
186
  * ```
174
187
  *
175
188
  * @param CreateGovCloudAccountCommandInput - {@link CreateGovCloudAccountCommandInput}
@@ -513,6 +526,8 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun
513
526
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
514
527
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
515
528
  *
529
+ * @throws {@link OrganizationsServiceException}
530
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
516
531
  *
517
532
  */
518
533
  export declare class CreateGovCloudAccountCommand extends $Command<CreateGovCloudAccountCommandInput, CreateGovCloudAccountCommandOutput, OrganizationsClientResolvedConfig> {
@@ -41,6 +41,23 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
41
41
  * };
42
42
  * const command = new CreateOrganizationCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateOrganizationResponse
45
+ * // Organization: { // Organization
46
+ * // Id: "STRING_VALUE",
47
+ * // Arn: "STRING_VALUE",
48
+ * // FeatureSet: "ALL" || "CONSOLIDATED_BILLING",
49
+ * // MasterAccountArn: "STRING_VALUE",
50
+ * // MasterAccountId: "STRING_VALUE",
51
+ * // MasterAccountEmail: "STRING_VALUE",
52
+ * // AvailablePolicyTypes: [ // PolicyTypes
53
+ * // { // PolicyTypeSummary
54
+ * // Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
55
+ * // Status: "ENABLED" || "PENDING_ENABLE" || "PENDING_DISABLE",
56
+ * // },
57
+ * // ],
58
+ * // },
59
+ * // };
60
+ *
44
61
  * ```
45
62
  *
46
63
  * @param CreateOrganizationCommandInput - {@link CreateOrganizationCommandInput}
@@ -382,6 +399,8 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
382
399
  * <i>Organizations User Guide.</i>
383
400
  * </p>
384
401
  *
402
+ * @throws {@link OrganizationsServiceException}
403
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
385
404
  *
386
405
  * @example To create a new organization with all features enabled
387
406
  * ```javascript
@@ -48,6 +48,14 @@ export interface CreateOrganizationalUnitCommandOutput extends CreateOrganizatio
48
48
  * };
49
49
  * const command = new CreateOrganizationalUnitCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // CreateOrganizationalUnitResponse
52
+ * // OrganizationalUnit: { // OrganizationalUnit
53
+ * // Id: "STRING_VALUE",
54
+ * // Arn: "STRING_VALUE",
55
+ * // Name: "STRING_VALUE",
56
+ * // },
57
+ * // };
58
+ *
51
59
  * ```
52
60
  *
53
61
  * @param CreateOrganizationalUnitCommandInput - {@link CreateOrganizationalUnitCommandInput}
@@ -389,6 +397,8 @@ export interface CreateOrganizationalUnitCommandOutput extends CreateOrganizatio
389
397
  * <i>Organizations User Guide.</i>
390
398
  * </p>
391
399
  *
400
+ * @throws {@link OrganizationsServiceException}
401
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
392
402
  *
393
403
  * @example To create a new organization unit
394
404
  * ```javascript
@@ -46,6 +46,20 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
46
46
  * };
47
47
  * const command = new CreatePolicyCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // CreatePolicyResponse
50
+ * // Policy: { // Policy
51
+ * // PolicySummary: { // PolicySummary
52
+ * // Id: "STRING_VALUE",
53
+ * // Arn: "STRING_VALUE",
54
+ * // Name: "STRING_VALUE",
55
+ * // Description: "STRING_VALUE",
56
+ * // Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
57
+ * // AwsManaged: true || false,
58
+ * // },
59
+ * // Content: "STRING_VALUE",
60
+ * // },
61
+ * // };
62
+ *
49
63
  * ```
50
64
  *
51
65
  * @param CreatePolicyCommandInput - {@link CreatePolicyCommandInput}
@@ -401,6 +415,8 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
401
415
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
402
416
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
403
417
  *
418
+ * @throws {@link OrganizationsServiceException}
419
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
404
420
  *
405
421
  * @example To create a service control policy
406
422
  * ```javascript
@@ -37,6 +37,36 @@ export interface DeclineHandshakeCommandOutput extends DeclineHandshakeResponse,
37
37
  * };
38
38
  * const command = new DeclineHandshakeCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DeclineHandshakeResponse
41
+ * // Handshake: { // Handshake
42
+ * // Id: "STRING_VALUE",
43
+ * // Arn: "STRING_VALUE",
44
+ * // Parties: [ // HandshakeParties
45
+ * // { // HandshakeParty
46
+ * // Id: "STRING_VALUE", // required
47
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
48
+ * // },
49
+ * // ],
50
+ * // State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
51
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
52
+ * // ExpirationTimestamp: new Date("TIMESTAMP"),
53
+ * // Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
54
+ * // Resources: [ // HandshakeResources
55
+ * // { // HandshakeResource
56
+ * // Value: "STRING_VALUE",
57
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
58
+ * // Resources: [
59
+ * // {
60
+ * // Value: "STRING_VALUE",
61
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
62
+ * // Resources: "<HandshakeResources>",
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // ],
67
+ * // },
68
+ * // };
69
+ *
40
70
  * ```
41
71
  *
42
72
  * @param DeclineHandshakeCommandInput - {@link DeclineHandshakeCommandInput}
@@ -183,6 +213,8 @@ export interface DeclineHandshakeCommandOutput extends DeclineHandshakeResponse,
183
213
  * <i>Organizations User Guide.</i>
184
214
  * </p>
185
215
  *
216
+ * @throws {@link OrganizationsServiceException}
217
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
186
218
  *
187
219
  * @example To decline a handshake sent from the master account
188
220
  * ```javascript
@@ -29,6 +29,8 @@ export interface DeleteOrganizationCommandOutput extends __MetadataBearer {
29
29
  * const input = {};
30
30
  * const command = new DeleteOrganizationCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // {};
33
+ *
32
34
  * ```
33
35
  *
34
36
  * @param DeleteOrganizationCommandInput - {@link DeleteOrganizationCommandInput}
@@ -171,6 +173,8 @@ export interface DeleteOrganizationCommandOutput extends __MetadataBearer {
171
173
  * <i>Organizations User Guide.</i>
172
174
  * </p>
173
175
  *
176
+ * @throws {@link OrganizationsServiceException}
177
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
174
178
  *
175
179
  */
176
180
  export declare class DeleteOrganizationCommand extends $Command<DeleteOrganizationCommandInput, DeleteOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteOrganizationalUnitCommandOutput extends __MetadataBearer
33
33
  * };
34
34
  * const command = new DeleteOrganizationalUnitCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteOrganizationalUnitCommandInput - {@link DeleteOrganizationalUnitCommandInput}
@@ -179,6 +181,8 @@ export interface DeleteOrganizationalUnitCommandOutput extends __MetadataBearer
179
181
  * <i>Organizations User Guide.</i>
180
182
  * </p>
181
183
  *
184
+ * @throws {@link OrganizationsServiceException}
185
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
182
186
  *
183
187
  * @example To delete an organization unit
184
188
  * ```javascript
@@ -34,6 +34,8 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new DeletePolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeletePolicyCommandInput - {@link DeletePolicyCommandInput}
@@ -182,6 +184,8 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
182
184
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
183
185
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
184
186
  *
187
+ * @throws {@link OrganizationsServiceException}
188
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
185
189
  *
186
190
  * @example To delete a policy
187
191
  * ```javascript
@@ -29,6 +29,8 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {
29
29
  * const input = {};
30
30
  * const command = new DeleteResourcePolicyCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // {};
33
+ *
32
34
  * ```
33
35
  *
34
36
  * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
@@ -266,6 +268,8 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {
266
268
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
267
269
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
268
270
  *
271
+ * @throws {@link OrganizationsServiceException}
272
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
269
273
  *
270
274
  */
271
275
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, OrganizationsClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface DeregisterDelegatedAdministratorCommandOutput extends __Metadat
45
45
  * };
46
46
  * const command = new DeregisterDelegatedAdministratorCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param DeregisterDelegatedAdministratorCommandInput - {@link DeregisterDelegatedAdministratorCommandInput}
@@ -391,6 +393,8 @@ export interface DeregisterDelegatedAdministratorCommandOutput extends __Metadat
391
393
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
392
394
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
393
395
  *
396
+ * @throws {@link OrganizationsServiceException}
397
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
394
398
  *
395
399
  */
396
400
  export declare class DeregisterDelegatedAdministratorCommand extends $Command<DeregisterDelegatedAdministratorCommandInput, DeregisterDelegatedAdministratorCommandOutput, OrganizationsClientResolvedConfig> {
@@ -33,6 +33,18 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResponse, _
33
33
  * };
34
34
  * const command = new DescribeAccountCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeAccountResponse
37
+ * // Account: { // Account
38
+ * // Id: "STRING_VALUE",
39
+ * // Arn: "STRING_VALUE",
40
+ * // Email: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
43
+ * // JoinedMethod: "INVITED" || "CREATED",
44
+ * // JoinedTimestamp: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param DescribeAccountCommandInput - {@link DescribeAccountCommandInput}
@@ -172,6 +184,8 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResponse, _
172
184
  * <i>Organizations User Guide.</i>
173
185
  * </p>
174
186
  *
187
+ * @throws {@link OrganizationsServiceException}
188
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
175
189
  *
176
190
  * @example To get the details about an account
177
191
  * ```javascript
@@ -33,6 +33,19 @@ export interface DescribeCreateAccountStatusCommandOutput extends DescribeCreate
33
33
  * };
34
34
  * const command = new DescribeCreateAccountStatusCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeCreateAccountStatusResponse
37
+ * // CreateAccountStatus: { // CreateAccountStatus
38
+ * // Id: "STRING_VALUE",
39
+ * // AccountName: "STRING_VALUE",
40
+ * // State: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
41
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
42
+ * // CompletedTimestamp: new Date("TIMESTAMP"),
43
+ * // AccountId: "STRING_VALUE",
44
+ * // GovCloudAccountId: "STRING_VALUE",
45
+ * // FailureReason: "ACCOUNT_LIMIT_EXCEEDED" || "EMAIL_ALREADY_EXISTS" || "INVALID_ADDRESS" || "INVALID_EMAIL" || "CONCURRENT_ACCOUNT_MODIFICATION" || "INTERNAL_FAILURE" || "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" || "MISSING_BUSINESS_VALIDATION" || "FAILED_BUSINESS_VALIDATION" || "PENDING_BUSINESS_VALIDATION" || "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION" || "UNKNOWN_BUSINESS_VALIDATION" || "MISSING_PAYMENT_INSTRUMENT" || "INVALID_PAYMENT_INSTRUMENT" || "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED",
46
+ * // },
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param DescribeCreateAccountStatusCommandInput - {@link DescribeCreateAccountStatusCommandInput}
@@ -174,6 +187,8 @@ export interface DescribeCreateAccountStatusCommandOutput extends DescribeCreate
174
187
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
175
188
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
176
189
  *
190
+ * @throws {@link OrganizationsServiceException}
191
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
177
192
  *
178
193
  * @example To get information about a request to create an account
179
194
  * ```javascript
@@ -41,6 +41,15 @@ export interface DescribeEffectivePolicyCommandOutput extends DescribeEffectiveP
41
41
  * };
42
42
  * const command = new DescribeEffectivePolicyCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DescribeEffectivePolicyResponse
45
+ * // EffectivePolicy: { // EffectivePolicy
46
+ * // PolicyContent: "STRING_VALUE",
47
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
48
+ * // TargetId: "STRING_VALUE",
49
+ * // PolicyType: "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
50
+ * // },
51
+ * // };
52
+ *
44
53
  * ```
45
54
  *
46
55
  * @param DescribeEffectivePolicyCommandInput - {@link DescribeEffectivePolicyCommandInput}
@@ -385,6 +394,8 @@ export interface DescribeEffectivePolicyCommandOutput extends DescribeEffectiveP
385
394
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
386
395
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
387
396
  *
397
+ * @throws {@link OrganizationsServiceException}
398
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
388
399
  *
389
400
  */
390
401
  export declare class DescribeEffectivePolicyCommand extends $Command<DescribeEffectivePolicyCommandInput, DescribeEffectivePolicyCommandOutput, OrganizationsClientResolvedConfig> {
@@ -37,6 +37,36 @@ export interface DescribeHandshakeCommandOutput extends DescribeHandshakeRespons
37
37
  * };
38
38
  * const command = new DescribeHandshakeCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DescribeHandshakeResponse
41
+ * // Handshake: { // Handshake
42
+ * // Id: "STRING_VALUE",
43
+ * // Arn: "STRING_VALUE",
44
+ * // Parties: [ // HandshakeParties
45
+ * // { // HandshakeParty
46
+ * // Id: "STRING_VALUE", // required
47
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
48
+ * // },
49
+ * // ],
50
+ * // State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
51
+ * // RequestedTimestamp: new Date("TIMESTAMP"),
52
+ * // ExpirationTimestamp: new Date("TIMESTAMP"),
53
+ * // Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
54
+ * // Resources: [ // HandshakeResources
55
+ * // { // HandshakeResource
56
+ * // Value: "STRING_VALUE",
57
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
58
+ * // Resources: [
59
+ * // {
60
+ * // Value: "STRING_VALUE",
61
+ * // Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
62
+ * // Resources: "<HandshakeResources>",
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // ],
67
+ * // },
68
+ * // };
69
+ *
40
70
  * ```
41
71
  *
42
72
  * @param DescribeHandshakeCommandInput - {@link DescribeHandshakeCommandInput}
@@ -174,6 +204,8 @@ export interface DescribeHandshakeCommandOutput extends DescribeHandshakeRespons
174
204
  * <i>Organizations User Guide.</i>
175
205
  * </p>
176
206
  *
207
+ * @throws {@link OrganizationsServiceException}
208
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
177
209
  *
178
210
  * @example To get information about a handshake
179
211
  * ```javascript
@@ -36,6 +36,23 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
36
36
  * const input = {};
37
37
  * const command = new DescribeOrganizationCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeOrganizationResponse
40
+ * // Organization: { // Organization
41
+ * // Id: "STRING_VALUE",
42
+ * // Arn: "STRING_VALUE",
43
+ * // FeatureSet: "ALL" || "CONSOLIDATED_BILLING",
44
+ * // MasterAccountArn: "STRING_VALUE",
45
+ * // MasterAccountId: "STRING_VALUE",
46
+ * // MasterAccountEmail: "STRING_VALUE",
47
+ * // AvailablePolicyTypes: [ // PolicyTypes
48
+ * // { // PolicyTypeSummary
49
+ * // Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
50
+ * // Status: "ENABLED" || "PENDING_ENABLE" || "PENDING_DISABLE",
51
+ * // },
52
+ * // ],
53
+ * // },
54
+ * // };
55
+ *
39
56
  * ```
40
57
  *
41
58
  * @param DescribeOrganizationCommandInput - {@link DescribeOrganizationCommandInput}
@@ -70,6 +87,8 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
70
87
  * <i>Organizations User Guide.</i>
71
88
  * </p>
72
89
  *
90
+ * @throws {@link OrganizationsServiceException}
91
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
73
92
  *
74
93
  * @example To get information about an organization
75
94
  * ```javascript
@@ -33,6 +33,14 @@ export interface DescribeOrganizationalUnitCommandOutput extends DescribeOrganiz
33
33
  * };
34
34
  * const command = new DescribeOrganizationalUnitCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeOrganizationalUnitResponse
37
+ * // OrganizationalUnit: { // OrganizationalUnit
38
+ * // Id: "STRING_VALUE",
39
+ * // Arn: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // },
42
+ * // };
43
+ *
36
44
  * ```
37
45
  *
38
46
  * @param DescribeOrganizationalUnitCommandInput - {@link DescribeOrganizationalUnitCommandInput}
@@ -171,6 +179,8 @@ export interface DescribeOrganizationalUnitCommandOutput extends DescribeOrganiz
171
179
  * <i>Organizations User Guide.</i>
172
180
  * </p>
173
181
  *
182
+ * @throws {@link OrganizationsServiceException}
183
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
174
184
  *
175
185
  * @example To get information about an organizational unit
176
186
  * ```javascript
@@ -33,6 +33,20 @@ export interface DescribePolicyCommandOutput extends DescribePolicyResponse, __M
33
33
  * };
34
34
  * const command = new DescribePolicyCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribePolicyResponse
37
+ * // Policy: { // Policy
38
+ * // PolicySummary: { // PolicySummary
39
+ * // Id: "STRING_VALUE",
40
+ * // Arn: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Description: "STRING_VALUE",
43
+ * // Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
44
+ * // AwsManaged: true || false,
45
+ * // },
46
+ * // Content: "STRING_VALUE",
47
+ * // },
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribePolicyCommandInput - {@link DescribePolicyCommandInput}
@@ -173,6 +187,8 @@ export interface DescribePolicyCommandOutput extends DescribePolicyResponse, __M
173
187
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
174
188
  * <p>This action isn't available in the current Amazon Web Services Region.</p>
175
189
  *
190
+ * @throws {@link OrganizationsServiceException}
191
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
176
192
  *
177
193
  * @example To get information about a policy
178
194
  * ```javascript