@aws-sdk/client-organizations 3.288.0 → 3.289.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 (39) hide show
  1. package/dist-types/commands/AcceptHandshakeCommand.d.ts +57 -0
  2. package/dist-types/commands/AttachPolicyCommand.d.ts +26 -0
  3. package/dist-types/commands/CancelHandshakeCommand.d.ts +62 -0
  4. package/dist-types/commands/CreateAccountCommand.d.ts +22 -0
  5. package/dist-types/commands/CreateOrganizationCommand.d.ts +55 -0
  6. package/dist-types/commands/CreateOrganizationalUnitCommand.d.ts +23 -0
  7. package/dist-types/commands/CreatePolicyCommand.d.ts +29 -0
  8. package/dist-types/commands/DeclineHandshakeCommand.d.ts +57 -0
  9. package/dist-types/commands/DeleteOrganizationalUnitCommand.d.ts +13 -0
  10. package/dist-types/commands/DeletePolicyCommand.d.ts +13 -0
  11. package/dist-types/commands/DescribeAccountCommand.d.ts +21 -0
  12. package/dist-types/commands/DescribeCreateAccountStatusCommand.d.ts +20 -0
  13. package/dist-types/commands/DescribeHandshakeCommand.d.ts +53 -0
  14. package/dist-types/commands/DescribeOrganizationCommand.d.ts +26 -0
  15. package/dist-types/commands/DescribeOrganizationalUnitCommand.d.ts +20 -0
  16. package/dist-types/commands/DescribePolicyCommand.d.ts +26 -0
  17. package/dist-types/commands/DetachPolicyCommand.d.ts +12 -0
  18. package/dist-types/commands/DisablePolicyTypeCommand.d.ts +22 -0
  19. package/dist-types/commands/EnableAllFeaturesCommand.d.ts +33 -0
  20. package/dist-types/commands/EnablePolicyTypeCommand.d.ts +27 -0
  21. package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts +61 -0
  22. package/dist-types/commands/LeaveOrganizationCommand.d.ts +9 -0
  23. package/dist-types/commands/ListAccountsCommand.d.ts +51 -0
  24. package/dist-types/commands/ListAccountsForParentCommand.d.ts +35 -0
  25. package/dist-types/commands/ListChildrenCommand.d.ts +26 -0
  26. package/dist-types/commands/ListCreateAccountStatusCommand.d.ts +52 -0
  27. package/dist-types/commands/ListHandshakesForAccountCommand.d.ts +57 -0
  28. package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts +99 -0
  29. package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts +27 -0
  30. package/dist-types/commands/ListParentsCommand.d.ts +21 -0
  31. package/dist-types/commands/ListPoliciesCommand.d.ts +41 -0
  32. package/dist-types/commands/ListPoliciesForTargetCommand.d.ts +26 -0
  33. package/dist-types/commands/ListRootsCommand.d.ts +26 -0
  34. package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +35 -0
  35. package/dist-types/commands/MoveAccountCommand.d.ts +13 -0
  36. package/dist-types/commands/RemoveAccountFromOrganizationCommand.d.ts +11 -0
  37. package/dist-types/commands/UpdateOrganizationalUnitCommand.d.ts +21 -0
  38. package/dist-types/commands/UpdatePolicyCommand.d.ts +55 -0
  39. package/package.json +29 -29
@@ -39,6 +39,28 @@ export interface DisablePolicyTypeCommandOutput extends DisablePolicyTypeRespons
39
39
  * @see {@link DisablePolicyTypeCommandOutput} for command's `response` shape.
40
40
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
41
41
  *
42
+ * @example To disable a policy type in a root
43
+ * ```javascript
44
+ * // 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
45
+ * const input = {
46
+ * "PolicyType": "SERVICE_CONTROL_POLICY",
47
+ * "RootId": "r-examplerootid111"
48
+ * };
49
+ * const command = new DisablePolicyTypeCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Root": {
54
+ * "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
55
+ * "Id": "r-examplerootid111",
56
+ * "Name": "Root",
57
+ * "PolicyTypes": []
58
+ * }
59
+ * }
60
+ * *\/
61
+ * // example id: to-disable-a-policy-type-in-a-root
62
+ * ```
63
+ *
42
64
  */
43
65
  export declare class DisablePolicyTypeCommand extends $Command<DisablePolicyTypeCommandInput, DisablePolicyTypeCommandOutput, OrganizationsClientResolvedConfig> {
44
66
  readonly input: DisablePolicyTypeCommandInput;
@@ -54,6 +54,39 @@ export interface EnableAllFeaturesCommandOutput extends EnableAllFeaturesRespons
54
54
  * @see {@link EnableAllFeaturesCommandOutput} for command's `response` shape.
55
55
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
56
56
  *
57
+ * @example To enable all features in an organization
58
+ * ```javascript
59
+ * // 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
60
+ * const input = {};
61
+ * const command = new EnableAllFeaturesCommand(input);
62
+ * const response = await client.send(command);
63
+ * /* response ==
64
+ * {
65
+ * "Handshake": {
66
+ * "Action": "ENABLE_ALL_FEATURES",
67
+ * "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111",
68
+ * "ExpirationTimestamp": "2017-02-28T09:35:40.05Z",
69
+ * "Id": "h-examplehandshakeid111",
70
+ * "Parties": [
71
+ * {
72
+ * "Id": "o-exampleorgid",
73
+ * "Type": "ORGANIZATION"
74
+ * }
75
+ * ],
76
+ * "RequestedTimestamp": "2017-02-13T09:35:40.05Z",
77
+ * "Resources": [
78
+ * {
79
+ * "Type": "ORGANIZATION",
80
+ * "Value": "o-exampleorgid"
81
+ * }
82
+ * ],
83
+ * "State": "REQUESTED"
84
+ * }
85
+ * }
86
+ * *\/
87
+ * // example id: to-enable-all-features-in-an-organization
88
+ * ```
89
+ *
57
90
  */
58
91
  export declare class EnableAllFeaturesCommand extends $Command<EnableAllFeaturesCommandInput, EnableAllFeaturesCommandOutput, OrganizationsClientResolvedConfig> {
59
92
  readonly input: EnableAllFeaturesCommandInput;
@@ -39,6 +39,33 @@ export interface EnablePolicyTypeCommandOutput extends EnablePolicyTypeResponse,
39
39
  * @see {@link EnablePolicyTypeCommandOutput} for command's `response` shape.
40
40
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
41
41
  *
42
+ * @example To enable a policy type in a root
43
+ * ```javascript
44
+ * // 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
45
+ * const input = {
46
+ * "PolicyType": "SERVICE_CONTROL_POLICY",
47
+ * "RootId": "r-examplerootid111"
48
+ * };
49
+ * const command = new EnablePolicyTypeCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Root": {
54
+ * "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
55
+ * "Id": "r-examplerootid111",
56
+ * "Name": "Root",
57
+ * "PolicyTypes": [
58
+ * {
59
+ * "Status": "ENABLED",
60
+ * "Type": "SERVICE_CONTROL_POLICY"
61
+ * }
62
+ * ]
63
+ * }
64
+ * }
65
+ * *\/
66
+ * // example id: to-enable-a-policy-type-in-a-root
67
+ * ```
68
+ *
42
69
  */
43
70
  export declare class EnablePolicyTypeCommand extends $Command<EnablePolicyTypeCommandInput, EnablePolicyTypeCommandOutput, OrganizationsClientResolvedConfig> {
44
71
  readonly input: EnablePolicyTypeCommandInput;
@@ -54,6 +54,67 @@ export interface InviteAccountToOrganizationCommandOutput extends InviteAccountT
54
54
  * @see {@link InviteAccountToOrganizationCommandOutput} for command's `response` shape.
55
55
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
56
56
  *
57
+ * @example To invite an account to join an organization
58
+ * ```javascript
59
+ * // 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.
60
+ * const input = {
61
+ * "Notes": "This is a request for Juan's account to join Bill's organization",
62
+ * "Target": {
63
+ * "Id": "juan@example.com",
64
+ * "Type": "EMAIL"
65
+ * }
66
+ * };
67
+ * const command = new InviteAccountToOrganizationCommand(input);
68
+ * const response = await client.send(command);
69
+ * /* response ==
70
+ * {
71
+ * "Handshake": {
72
+ * "Action": "INVITE",
73
+ * "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
74
+ * "ExpirationTimestamp": "2017-02-16T09:36:05.02Z",
75
+ * "Id": "h-examplehandshakeid111",
76
+ * "Parties": [
77
+ * {
78
+ * "Id": "o-exampleorgid",
79
+ * "Type": "ORGANIZATION"
80
+ * },
81
+ * {
82
+ * "Id": "juan@example.com",
83
+ * "Type": "EMAIL"
84
+ * }
85
+ * ],
86
+ * "RequestedTimestamp": "2017-02-01T09:36:05.02Z",
87
+ * "Resources": [
88
+ * {
89
+ * "Resources": [
90
+ * {
91
+ * "Type": "MASTER_EMAIL",
92
+ * "Value": "bill@amazon.com"
93
+ * },
94
+ * {
95
+ * "Type": "MASTER_NAME",
96
+ * "Value": "Org Master Account"
97
+ * },
98
+ * {
99
+ * "Type": "ORGANIZATION_FEATURE_SET",
100
+ * "Value": "FULL"
101
+ * }
102
+ * ],
103
+ * "Type": "ORGANIZATION",
104
+ * "Value": "o-exampleorgid"
105
+ * },
106
+ * {
107
+ * "Type": "EMAIL",
108
+ * "Value": "juan@example.com"
109
+ * }
110
+ * ],
111
+ * "State": "OPEN"
112
+ * }
113
+ * }
114
+ * *\/
115
+ * // example id: to-invite-an-account-to-join-an-organization-1472508594110
116
+ * ```
117
+ *
57
118
  */
58
119
  export declare class InviteAccountToOrganizationCommand extends $Command<InviteAccountToOrganizationCommandInput, InviteAccountToOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
59
120
  readonly input: InviteAccountToOrganizationCommandInput;
@@ -92,6 +92,15 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {
92
92
  * @see {@link LeaveOrganizationCommandOutput} for command's `response` shape.
93
93
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
94
94
  *
95
+ * @example To leave an organization as a member account
96
+ * ```javascript
97
+ * // TThe following example shows how to remove your member account from an organization:
98
+ * const input = undefined;
99
+ * const command = new LeaveOrganizationCommand(input);
100
+ * await client.send(command);
101
+ * // example id: to-leave-an-organization-as-a-member-account-1472508784736
102
+ * ```
103
+ *
95
104
  */
96
105
  export declare class LeaveOrganizationCommand extends $Command<LeaveOrganizationCommandInput, LeaveOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
97
106
  readonly input: LeaveOrganizationCommandInput;
@@ -40,6 +40,57 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad
40
40
  * @see {@link ListAccountsCommandOutput} for command's `response` shape.
41
41
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
42
42
  *
43
+ * @example To retrieve a list of all of the accounts in an organization
44
+ * ```javascript
45
+ * // The following example shows you how to request a list of the accounts in an organization:
46
+ * const input = {};
47
+ * const command = new ListAccountsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Accounts": [
52
+ * {
53
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
54
+ * "Email": "bill@example.com",
55
+ * "Id": "111111111111",
56
+ * "JoinedMethod": "INVITED",
57
+ * "JoinedTimestamp": "20161215T193015Z",
58
+ * "Name": "Master Account",
59
+ * "Status": "ACTIVE"
60
+ * },
61
+ * {
62
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222",
63
+ * "Email": "alice@example.com",
64
+ * "Id": "222222222222",
65
+ * "JoinedMethod": "INVITED",
66
+ * "JoinedTimestamp": "20161215T210221Z",
67
+ * "Name": "Developer Account",
68
+ * "Status": "ACTIVE"
69
+ * },
70
+ * {
71
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
72
+ * "Email": "juan@example.com",
73
+ * "Id": "333333333333",
74
+ * "JoinedMethod": "INVITED",
75
+ * "JoinedTimestamp": "20161215T210347Z",
76
+ * "Name": "Test Account",
77
+ * "Status": "ACTIVE"
78
+ * },
79
+ * {
80
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
81
+ * "Email": "anika@example.com",
82
+ * "Id": "444444444444",
83
+ * "JoinedMethod": "INVITED",
84
+ * "JoinedTimestamp": "20161215T210332Z",
85
+ * "Name": "Production Account",
86
+ * "Status": "ACTIVE"
87
+ * }
88
+ * ]
89
+ * }
90
+ * *\/
91
+ * // example id: to-retrieve-a-list-of-all-of-the-accounts-in-an-organization-1472509590974
92
+ * ```
93
+ *
43
94
  */
44
95
  export declare class ListAccountsCommand extends $Command<ListAccountsCommandInput, ListAccountsCommandOutput, OrganizationsClientResolvedConfig> {
45
96
  readonly input: ListAccountsCommandInput;
@@ -43,6 +43,41 @@ export interface ListAccountsForParentCommandOutput extends ListAccountsForParen
43
43
  * @see {@link ListAccountsForParentCommandOutput} for command's `response` shape.
44
44
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
45
45
  *
46
+ * @example To retrieve a list of all of the accounts in a root or OU
47
+ * ```javascript
48
+ * // The following example shows how to request a list of the accounts in an OU:/n/n
49
+ * const input = {
50
+ * "ParentId": "ou-examplerootid111-exampleouid111"
51
+ * };
52
+ * const command = new ListAccountsForParentCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "Accounts": [
57
+ * {
58
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
59
+ * "Email": "juan@example.com",
60
+ * "Id": "333333333333",
61
+ * "JoinedMethod": "INVITED",
62
+ * "JoinedTimestamp": 1481835795.536,
63
+ * "Name": "Development Account",
64
+ * "Status": "ACTIVE"
65
+ * },
66
+ * {
67
+ * "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
68
+ * "Email": "anika@example.com",
69
+ * "Id": "444444444444",
70
+ * "JoinedMethod": "INVITED",
71
+ * "JoinedTimestamp": 1481835812.143,
72
+ * "Name": "Test Account",
73
+ * "Status": "ACTIVE"
74
+ * }
75
+ * ]
76
+ * }
77
+ * *\/
78
+ * // example id: to-retrieve-a-list-of-all-of-the-accounts-in-a-root-or-ou-1472509590974
79
+ * ```
80
+ *
46
81
  */
47
82
  export declare class ListAccountsForParentCommand extends $Command<ListAccountsForParentCommandInput, ListAccountsForParentCommandOutput, OrganizationsClientResolvedConfig> {
48
83
  readonly input: ListAccountsForParentCommandInput;
@@ -41,6 +41,32 @@ export interface ListChildrenCommandOutput extends ListChildrenResponse, __Metad
41
41
  * @see {@link ListChildrenCommandOutput} for command's `response` shape.
42
42
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
43
43
  *
44
+ * @example To retrieve a list of all of the child accounts and OUs in a parent root or OU
45
+ * ```javascript
46
+ * // The following example shows how to request a list of the child OUs in a parent root or OU:/n/n
47
+ * const input = {
48
+ * "ChildType": "ORGANIZATIONAL_UNIT",
49
+ * "ParentId": "ou-examplerootid111-exampleouid111"
50
+ * };
51
+ * const command = new ListChildrenCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "Children": [
56
+ * {
57
+ * "Id": "ou-examplerootid111-exampleouid111",
58
+ * "Type": "ORGANIZATIONAL_UNIT"
59
+ * },
60
+ * {
61
+ * "Id": "ou-examplerootid111-exampleouid222",
62
+ * "Type": "ORGANIZATIONAL_UNIT"
63
+ * }
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: to-retrieve-a-list-of-all-of-the-child-accounts-and-OUs-in-a-parent-container
68
+ * ```
69
+ *
44
70
  */
45
71
  export declare class ListChildrenCommand extends $Command<ListChildrenCommandInput, ListChildrenCommandOutput, OrganizationsClientResolvedConfig> {
46
72
  readonly input: ListChildrenCommandInput;
@@ -40,6 +40,58 @@ export interface ListCreateAccountStatusCommandOutput extends ListCreateAccountS
40
40
  * @see {@link ListCreateAccountStatusCommandOutput} for command's `response` shape.
41
41
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
42
42
  *
43
+ * @example To get a list of completed account creation requests made in the organization
44
+ * ```javascript
45
+ * // The following example shows a user requesting a list of only the completed account creation requests made for the current organization:
46
+ * const input = {
47
+ * "States": [
48
+ * "SUCCEEDED"
49
+ * ]
50
+ * };
51
+ * const command = new ListCreateAccountStatusCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "CreateAccountStatuses": [
56
+ * {
57
+ * "AccountId": "444444444444",
58
+ * "AccountName": "Developer Test Account",
59
+ * "CompletedTimestamp": "2017-01-15T13:45:23.6Z",
60
+ * "Id": "car-exampleaccountcreationrequestid1",
61
+ * "RequestedTimestamp": "2017-01-15T13:45:23.01Z",
62
+ * "State": "SUCCEEDED"
63
+ * }
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: to-get-a-list-of-completed-account-creation-requests-made-in-the-organization
68
+ * ```
69
+ *
70
+ * @example To get a list of all account creation requests made in the organization
71
+ * ```javascript
72
+ * // The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:
73
+ * const input = {
74
+ * "States": [
75
+ * "IN_PROGRESS"
76
+ * ]
77
+ * };
78
+ * const command = new ListCreateAccountStatusCommand(input);
79
+ * const response = await client.send(command);
80
+ * /* response ==
81
+ * {
82
+ * "CreateAccountStatuses": [
83
+ * {
84
+ * "AccountName": "Production Account",
85
+ * "Id": "car-exampleaccountcreationrequestid2",
86
+ * "RequestedTimestamp": "2017-01-15T13:45:23.01Z",
87
+ * "State": "IN_PROGRESS"
88
+ * }
89
+ * ]
90
+ * }
91
+ * *\/
92
+ * // example id: to-get-a-list-of-all-account-creation-requests-made-in-the-organization-1472509174532
93
+ * ```
94
+ *
43
95
  */
44
96
  export declare class ListCreateAccountStatusCommand extends $Command<ListCreateAccountStatusCommandInput, ListCreateAccountStatusCommandOutput, OrganizationsClientResolvedConfig> {
45
97
  readonly input: ListCreateAccountStatusCommandInput;
@@ -43,6 +43,63 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor
43
43
  * @see {@link ListHandshakesForAccountCommandOutput} for command's `response` shape.
44
44
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
45
45
  *
46
+ * @example To retrieve a list of the handshakes sent to an account
47
+ * ```javascript
48
+ * // The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:
49
+ * const input = undefined;
50
+ * const command = new ListHandshakesForAccountCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "Handshakes": [
55
+ * {
56
+ * "Action": "INVITE",
57
+ * "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
58
+ * "ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
59
+ * "Id": "h-examplehandshakeid111",
60
+ * "Parties": [
61
+ * {
62
+ * "Id": "o-exampleorgid",
63
+ * "Type": "ORGANIZATION"
64
+ * },
65
+ * {
66
+ * "Id": "juan@example.com",
67
+ * "Type": "EMAIL"
68
+ * }
69
+ * ],
70
+ * "RequestedTimestamp": "2017-01-13T14:35:23.3Z",
71
+ * "Resources": [
72
+ * {
73
+ * "Resources": [
74
+ * {
75
+ * "Type": "MASTER_EMAIL",
76
+ * "Value": "bill@amazon.com"
77
+ * },
78
+ * {
79
+ * "Type": "MASTER_NAME",
80
+ * "Value": "Org Master Account"
81
+ * },
82
+ * {
83
+ * "Type": "ORGANIZATION_FEATURE_SET",
84
+ * "Value": "FULL"
85
+ * }
86
+ * ],
87
+ * "Type": "ORGANIZATION",
88
+ * "Value": "o-exampleorgid"
89
+ * },
90
+ * {
91
+ * "Type": "EMAIL",
92
+ * "Value": "juan@example.com"
93
+ * }
94
+ * ],
95
+ * "State": "OPEN"
96
+ * }
97
+ * ]
98
+ * }
99
+ * *\/
100
+ * // example id: to-retrieve-a-list-of-the-handshakes-sent-to-an-account-1472510214747
101
+ * ```
102
+ *
46
103
  */
47
104
  export declare class ListHandshakesForAccountCommand extends $Command<ListHandshakesForAccountCommandInput, ListHandshakesForAccountCommandOutput, OrganizationsClientResolvedConfig> {
48
105
  readonly input: ListHandshakesForAccountCommandInput;
@@ -46,6 +46,105 @@ export interface ListHandshakesForOrganizationCommandOutput extends ListHandshak
46
46
  * @see {@link ListHandshakesForOrganizationCommandOutput} for command's `response` shape.
47
47
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
48
48
  *
49
+ * @example To retrieve a list of the handshakes associated with an organization
50
+ * ```javascript
51
+ * // The following example shows you how to get a list of handshakes associated with the current organization:
52
+ * const input = undefined;
53
+ * const command = new ListHandshakesForOrganizationCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Handshakes": [
58
+ * {
59
+ * "Action": "INVITE",
60
+ * "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
61
+ * "ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
62
+ * "Id": "h-examplehandshakeid111",
63
+ * "Parties": [
64
+ * {
65
+ * "Id": "o-exampleorgid",
66
+ * "Type": "ORGANIZATION"
67
+ * },
68
+ * {
69
+ * "Id": "juan@example.com",
70
+ * "Type": "EMAIL"
71
+ * }
72
+ * ],
73
+ * "RequestedTimestamp": "2017-01-13T14:35:23.3Z",
74
+ * "Resources": [
75
+ * {
76
+ * "Resources": [
77
+ * {
78
+ * "Type": "MASTER_EMAIL",
79
+ * "Value": "bill@amazon.com"
80
+ * },
81
+ * {
82
+ * "Type": "MASTER_NAME",
83
+ * "Value": "Org Master Account"
84
+ * },
85
+ * {
86
+ * "Type": "ORGANIZATION_FEATURE_SET",
87
+ * "Value": "FULL"
88
+ * }
89
+ * ],
90
+ * "Type": "ORGANIZATION",
91
+ * "Value": "o-exampleorgid"
92
+ * },
93
+ * {
94
+ * "Type": "EMAIL",
95
+ * "Value": "juan@example.com"
96
+ * }
97
+ * ],
98
+ * "State": "OPEN"
99
+ * },
100
+ * {
101
+ * "Action": "INVITE",
102
+ * "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
103
+ * "ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
104
+ * "Id": "h-examplehandshakeid222",
105
+ * "Parties": [
106
+ * {
107
+ * "Id": "o-exampleorgid",
108
+ * "Type": "ORGANIZATION"
109
+ * },
110
+ * {
111
+ * "Id": "anika@example.com",
112
+ * "Type": "EMAIL"
113
+ * }
114
+ * ],
115
+ * "RequestedTimestamp": "2017-01-13T14:35:23.3Z",
116
+ * "Resources": [
117
+ * {
118
+ * "Resources": [
119
+ * {
120
+ * "Type": "MASTER_EMAIL",
121
+ * "Value": "bill@example.com"
122
+ * },
123
+ * {
124
+ * "Type": "MASTER_NAME",
125
+ * "Value": "Master Account"
126
+ * }
127
+ * ],
128
+ * "Type": "ORGANIZATION",
129
+ * "Value": "o-exampleorgid"
130
+ * },
131
+ * {
132
+ * "Type": "EMAIL",
133
+ * "Value": "anika@example.com"
134
+ * },
135
+ * {
136
+ * "Type": "NOTES",
137
+ * "Value": "This is an invitation to Anika's account to join Bill's organization."
138
+ * }
139
+ * ],
140
+ * "State": "ACCEPTED"
141
+ * }
142
+ * ]
143
+ * }
144
+ * *\/
145
+ * // example id: to-retrieve-a-list-of-the-handshakes-associated-with-an-organization-1472511206653
146
+ * ```
147
+ *
49
148
  */
50
149
  export declare class ListHandshakesForOrganizationCommand extends $Command<ListHandshakesForOrganizationCommandInput, ListHandshakesForOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
51
150
  readonly input: ListHandshakesForOrganizationCommandInput;
@@ -39,6 +39,33 @@ export interface ListOrganizationalUnitsForParentCommandOutput extends ListOrgan
39
39
  * @see {@link ListOrganizationalUnitsForParentCommandOutput} for command's `response` shape.
40
40
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
41
41
  *
42
+ * @example To retrieve a list of all of the child OUs in a parent root or OU
43
+ * ```javascript
44
+ * // The following example shows how to get a list of OUs in a specified root:/n/n
45
+ * const input = {
46
+ * "ParentId": "r-examplerootid111"
47
+ * };
48
+ * const command = new ListOrganizationalUnitsForParentCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "OrganizationalUnits": [
53
+ * {
54
+ * "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111",
55
+ * "Id": "ou-examplerootid111-exampleouid111",
56
+ * "Name": "Development"
57
+ * },
58
+ * {
59
+ * "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222",
60
+ * "Id": "ou-examplerootid111-exampleouid222",
61
+ * "Name": "Production"
62
+ * }
63
+ * ]
64
+ * }
65
+ * *\/
66
+ * // example id: to-retrieve-a-list-of-all-of-the-OUs-in-a-parent-container
67
+ * ```
68
+ *
42
69
  */
43
70
  export declare class ListOrganizationalUnitsForParentCommand extends $Command<ListOrganizationalUnitsForParentCommandInput, ListOrganizationalUnitsForParentCommandOutput, OrganizationsClientResolvedConfig> {
44
71
  readonly input: ListOrganizationalUnitsForParentCommandInput;
@@ -44,6 +44,27 @@ export interface ListParentsCommandOutput extends ListParentsResponse, __Metadat
44
44
  * @see {@link ListParentsCommandOutput} for command's `response` shape.
45
45
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
46
46
  *
47
+ * @example To retrieve a list of all of the parents of a child OU or account
48
+ * ```javascript
49
+ * // The following example shows how to list the root or OUs that contain account 444444444444:/n/n
50
+ * const input = {
51
+ * "ChildId": "444444444444"
52
+ * };
53
+ * const command = new ListParentsCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Parents": [
58
+ * {
59
+ * "Id": "ou-examplerootid111-exampleouid111",
60
+ * "Type": "ORGANIZATIONAL_UNIT"
61
+ * }
62
+ * ]
63
+ * }
64
+ * *\/
65
+ * // example id: to-retrieve-a-list-of-all-of-the-parents-of-a-child-ou-or-account
66
+ * ```
67
+ *
47
68
  */
48
69
  export declare class ListParentsCommand extends $Command<ListParentsCommandInput, ListParentsCommandOutput, OrganizationsClientResolvedConfig> {
49
70
  readonly input: ListParentsCommandInput;
@@ -39,6 +39,47 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad
39
39
  * @see {@link ListPoliciesCommandOutput} for command's `response` shape.
40
40
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
41
41
  *
42
+ * @example To retrieve a list policies in the organization
43
+ * ```javascript
44
+ * // The following example shows how to get a list of service control policies (SCPs):/n/n
45
+ * const input = {
46
+ * "Filter": "SERVICE_CONTROL_POLICY"
47
+ * };
48
+ * const command = new ListPoliciesCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Policies": [
53
+ * {
54
+ * "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
55
+ * "AwsManaged": false,
56
+ * "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts.",
57
+ * "Id": "p-examplepolicyid111",
58
+ * "Name": "AllowAllS3Actions",
59
+ * "Type": "SERVICE_CONTROL_POLICY"
60
+ * },
61
+ * {
62
+ * "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222",
63
+ * "AwsManaged": false,
64
+ * "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.",
65
+ * "Id": "p-examplepolicyid222",
66
+ * "Name": "AllowAllEC2Actions",
67
+ * "Type": "SERVICE_CONTROL_POLICY"
68
+ * },
69
+ * {
70
+ * "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess",
71
+ * "AwsManaged": true,
72
+ * "Description": "Allows access to every operation",
73
+ * "Id": "p-FullAWSAccess",
74
+ * "Name": "FullAWSAccess",
75
+ * "Type": "SERVICE_CONTROL_POLICY"
76
+ * }
77
+ * ]
78
+ * }
79
+ * *\/
80
+ * // example id: to-retrieve-a-list-of--policies-in-the-organization
81
+ * ```
82
+ *
42
83
  */
43
84
  export declare class ListPoliciesCommand extends $Command<ListPoliciesCommandInput, ListPoliciesCommandOutput, OrganizationsClientResolvedConfig> {
44
85
  readonly input: ListPoliciesCommandInput;