@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.
- package/dist-types/commands/AcceptHandshakeCommand.d.ts +57 -0
- package/dist-types/commands/AttachPolicyCommand.d.ts +26 -0
- package/dist-types/commands/CancelHandshakeCommand.d.ts +62 -0
- package/dist-types/commands/CreateAccountCommand.d.ts +22 -0
- package/dist-types/commands/CreateOrganizationCommand.d.ts +55 -0
- package/dist-types/commands/CreateOrganizationalUnitCommand.d.ts +23 -0
- package/dist-types/commands/CreatePolicyCommand.d.ts +29 -0
- package/dist-types/commands/DeclineHandshakeCommand.d.ts +57 -0
- package/dist-types/commands/DeleteOrganizationalUnitCommand.d.ts +13 -0
- package/dist-types/commands/DeletePolicyCommand.d.ts +13 -0
- package/dist-types/commands/DescribeAccountCommand.d.ts +21 -0
- package/dist-types/commands/DescribeCreateAccountStatusCommand.d.ts +20 -0
- package/dist-types/commands/DescribeHandshakeCommand.d.ts +53 -0
- package/dist-types/commands/DescribeOrganizationCommand.d.ts +26 -0
- package/dist-types/commands/DescribeOrganizationalUnitCommand.d.ts +20 -0
- package/dist-types/commands/DescribePolicyCommand.d.ts +26 -0
- package/dist-types/commands/DetachPolicyCommand.d.ts +12 -0
- package/dist-types/commands/DisablePolicyTypeCommand.d.ts +22 -0
- package/dist-types/commands/EnableAllFeaturesCommand.d.ts +33 -0
- package/dist-types/commands/EnablePolicyTypeCommand.d.ts +27 -0
- package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts +61 -0
- package/dist-types/commands/LeaveOrganizationCommand.d.ts +9 -0
- package/dist-types/commands/ListAccountsCommand.d.ts +51 -0
- package/dist-types/commands/ListAccountsForParentCommand.d.ts +35 -0
- package/dist-types/commands/ListChildrenCommand.d.ts +26 -0
- package/dist-types/commands/ListCreateAccountStatusCommand.d.ts +52 -0
- package/dist-types/commands/ListHandshakesForAccountCommand.d.ts +57 -0
- package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts +99 -0
- package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts +27 -0
- package/dist-types/commands/ListParentsCommand.d.ts +21 -0
- package/dist-types/commands/ListPoliciesCommand.d.ts +41 -0
- package/dist-types/commands/ListPoliciesForTargetCommand.d.ts +26 -0
- package/dist-types/commands/ListRootsCommand.d.ts +26 -0
- package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +35 -0
- package/dist-types/commands/MoveAccountCommand.d.ts +13 -0
- package/dist-types/commands/RemoveAccountFromOrganizationCommand.d.ts +11 -0
- package/dist-types/commands/UpdateOrganizationalUnitCommand.d.ts +21 -0
- package/dist-types/commands/UpdatePolicyCommand.d.ts +55 -0
- package/package.json +29 -29
|
@@ -59,6 +59,63 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
|
|
|
59
59
|
* @see {@link AcceptHandshakeCommandOutput} for command's `response` shape.
|
|
60
60
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
61
61
|
*
|
|
62
|
+
* @example To accept a handshake from another account
|
|
63
|
+
* ```javascript
|
|
64
|
+
* // Bill is the owner of an organization, and he invites Juan's account (222222222222) to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation.
|
|
65
|
+
* const input = {
|
|
66
|
+
* "HandshakeId": "h-examplehandshakeid111"
|
|
67
|
+
* };
|
|
68
|
+
* const command = new AcceptHandshakeCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* /* response ==
|
|
71
|
+
* {
|
|
72
|
+
* "Handshake": {
|
|
73
|
+
* "Action": "INVITE",
|
|
74
|
+
* "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
75
|
+
* "ExpirationTimestamp": "20170228T1215Z",
|
|
76
|
+
* "Id": "h-examplehandshakeid111",
|
|
77
|
+
* "Parties": [
|
|
78
|
+
* {
|
|
79
|
+
* "Id": "o-exampleorgid",
|
|
80
|
+
* "Type": "ORGANIZATION"
|
|
81
|
+
* },
|
|
82
|
+
* {
|
|
83
|
+
* "Id": "juan@example.com",
|
|
84
|
+
* "Type": "EMAIL"
|
|
85
|
+
* }
|
|
86
|
+
* ],
|
|
87
|
+
* "RequestedTimestamp": "20170214T1215Z",
|
|
88
|
+
* "Resources": [
|
|
89
|
+
* {
|
|
90
|
+
* "Resources": [
|
|
91
|
+
* {
|
|
92
|
+
* "Type": "MASTER_EMAIL",
|
|
93
|
+
* "Value": "bill@amazon.com"
|
|
94
|
+
* },
|
|
95
|
+
* {
|
|
96
|
+
* "Type": "MASTER_NAME",
|
|
97
|
+
* "Value": "Org Master Account"
|
|
98
|
+
* },
|
|
99
|
+
* {
|
|
100
|
+
* "Type": "ORGANIZATION_FEATURE_SET",
|
|
101
|
+
* "Value": "ALL"
|
|
102
|
+
* }
|
|
103
|
+
* ],
|
|
104
|
+
* "Type": "ORGANIZATION",
|
|
105
|
+
* "Value": "o-exampleorgid"
|
|
106
|
+
* },
|
|
107
|
+
* {
|
|
108
|
+
* "Type": "ACCOUNT",
|
|
109
|
+
* "Value": "222222222222"
|
|
110
|
+
* }
|
|
111
|
+
* ],
|
|
112
|
+
* "State": "ACCEPTED"
|
|
113
|
+
* }
|
|
114
|
+
* }
|
|
115
|
+
* *\/
|
|
116
|
+
* // example id: to-accept-a-handshake-from-another-account-1472500561150
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
62
119
|
*/
|
|
63
120
|
export declare class AcceptHandshakeCommand extends $Command<AcceptHandshakeCommandInput, AcceptHandshakeCommandOutput, OrganizationsClientResolvedConfig> {
|
|
64
121
|
readonly input: AcceptHandshakeCommandInput;
|
|
@@ -54,6 +54,32 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {
|
|
|
54
54
|
* @see {@link AttachPolicyCommandOutput} for command's `response` shape.
|
|
55
55
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
56
56
|
*
|
|
57
|
+
* @example To attach a policy to an OU
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // The following example shows how to attach a service control policy (SCP) to an OU:
|
|
60
|
+
* //
|
|
61
|
+
* const input = {
|
|
62
|
+
* "PolicyId": "p-examplepolicyid111",
|
|
63
|
+
* "TargetId": "ou-examplerootid111-exampleouid111"
|
|
64
|
+
* };
|
|
65
|
+
* const command = new AttachPolicyCommand(input);
|
|
66
|
+
* await client.send(command);
|
|
67
|
+
* // example id: to-attach-a-policy-to-an-ou
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @example To attach a policy to an account
|
|
71
|
+
* ```javascript
|
|
72
|
+
* // The following example shows how to attach a service control policy (SCP) to an account:
|
|
73
|
+
* //
|
|
74
|
+
* const input = {
|
|
75
|
+
* "PolicyId": "p-examplepolicyid111",
|
|
76
|
+
* "TargetId": "333333333333"
|
|
77
|
+
* };
|
|
78
|
+
* const command = new AttachPolicyCommand(input);
|
|
79
|
+
* await client.send(command);
|
|
80
|
+
* // example id: to-attach-a-policy-to-an-account
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
57
83
|
*/
|
|
58
84
|
export declare class AttachPolicyCommand extends $Command<AttachPolicyCommandInput, AttachPolicyCommandOutput, OrganizationsClientResolvedConfig> {
|
|
59
85
|
readonly input: AttachPolicyCommandInput;
|
|
@@ -34,6 +34,68 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
|
|
|
34
34
|
* @see {@link CancelHandshakeCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @example To cancel a handshake sent to a member account
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
|
|
40
|
+
* //
|
|
41
|
+
* const input = {
|
|
42
|
+
* "HandshakeId": "h-examplehandshakeid111"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CancelHandshakeCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "Handshake": {
|
|
49
|
+
* "Action": "INVITE",
|
|
50
|
+
* "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
51
|
+
* "ExpirationTimestamp": "20170228T1215Z",
|
|
52
|
+
* "Id": "h-examplehandshakeid111",
|
|
53
|
+
* "Parties": [
|
|
54
|
+
* {
|
|
55
|
+
* "Id": "o-exampleorgid",
|
|
56
|
+
* "Type": "ORGANIZATION"
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "Id": "susan@example.com",
|
|
60
|
+
* "Type": "EMAIL"
|
|
61
|
+
* }
|
|
62
|
+
* ],
|
|
63
|
+
* "RequestedTimestamp": "20170214T1215Z",
|
|
64
|
+
* "Resources": [
|
|
65
|
+
* {
|
|
66
|
+
* "Resources": [
|
|
67
|
+
* {
|
|
68
|
+
* "Type": "MASTER_EMAIL",
|
|
69
|
+
* "Value": "bill@example.com"
|
|
70
|
+
* },
|
|
71
|
+
* {
|
|
72
|
+
* "Type": "MASTER_NAME",
|
|
73
|
+
* "Value": "Master Account"
|
|
74
|
+
* },
|
|
75
|
+
* {
|
|
76
|
+
* "Type": "ORGANIZATION_FEATURE_SET",
|
|
77
|
+
* "Value": "CONSOLIDATED_BILLING"
|
|
78
|
+
* }
|
|
79
|
+
* ],
|
|
80
|
+
* "Type": "ORGANIZATION",
|
|
81
|
+
* "Value": "o-exampleorgid"
|
|
82
|
+
* },
|
|
83
|
+
* {
|
|
84
|
+
* "Type": "ACCOUNT",
|
|
85
|
+
* "Value": "222222222222"
|
|
86
|
+
* },
|
|
87
|
+
* {
|
|
88
|
+
* "Type": "NOTES",
|
|
89
|
+
* "Value": "This is a request for Susan's account to join Bob's organization."
|
|
90
|
+
* }
|
|
91
|
+
* ],
|
|
92
|
+
* "State": "CANCELED"
|
|
93
|
+
* }
|
|
94
|
+
* }
|
|
95
|
+
* *\/
|
|
96
|
+
* // example id: to-cancel-a-handshake-sent-to-a-member-account-1472501320506
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
37
99
|
*/
|
|
38
100
|
export declare class CancelHandshakeCommand extends $Command<CancelHandshakeCommandInput, CancelHandshakeCommandOutput, OrganizationsClientResolvedConfig> {
|
|
39
101
|
readonly input: CancelHandshakeCommandInput;
|
|
@@ -103,6 +103,28 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
|
|
|
103
103
|
* @see {@link CreateAccountCommandOutput} for command's `response` shape.
|
|
104
104
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
105
105
|
*
|
|
106
|
+
* @example To create a new account that is automatically part of the organization
|
|
107
|
+
* ```javascript
|
|
108
|
+
* // The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name "Production Account" and an owner email address of susan@example.com. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a "Welcome to AWS" email:
|
|
109
|
+
* //
|
|
110
|
+
* //
|
|
111
|
+
* const input = {
|
|
112
|
+
* "AccountName": "Production Account",
|
|
113
|
+
* "Email": "susan@example.com"
|
|
114
|
+
* };
|
|
115
|
+
* const command = new CreateAccountCommand(input);
|
|
116
|
+
* const response = await client.send(command);
|
|
117
|
+
* /* response ==
|
|
118
|
+
* {
|
|
119
|
+
* "CreateAccountStatus": {
|
|
120
|
+
* "Id": "car-examplecreateaccountrequestid111",
|
|
121
|
+
* "State": "IN_PROGRESS"
|
|
122
|
+
* }
|
|
123
|
+
* }
|
|
124
|
+
* *\/
|
|
125
|
+
* // example id: to-create-a-new-account-that-is-automatically-part-of-the-organization-1472501463507
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
106
128
|
*/
|
|
107
129
|
export declare class CreateAccountCommand extends $Command<CreateAccountCommandInput, CreateAccountCommandOutput, OrganizationsClientResolvedConfig> {
|
|
108
130
|
readonly input: CreateAccountCommandInput;
|
|
@@ -39,6 +39,61 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
|
|
|
39
39
|
* @see {@link CreateOrganizationCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To create a new organization with all features enabled
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:
|
|
45
|
+
* //
|
|
46
|
+
* //
|
|
47
|
+
* const input = {};
|
|
48
|
+
* const command = new CreateOrganizationCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "Organization": {
|
|
53
|
+
* "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
|
|
54
|
+
* "AvailablePolicyTypes": [
|
|
55
|
+
* {
|
|
56
|
+
* "Status": "ENABLED",
|
|
57
|
+
* "Type": "SERVICE_CONTROL_POLICY"
|
|
58
|
+
* }
|
|
59
|
+
* ],
|
|
60
|
+
* "FeatureSet": "ALL",
|
|
61
|
+
* "Id": "o-exampleorgid",
|
|
62
|
+
* "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
|
|
63
|
+
* "MasterAccountEmail": "bill@example.com",
|
|
64
|
+
* "MasterAccountId": "111111111111"
|
|
65
|
+
* }
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-create-a-new-organization-with-all-features enabled
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @example To create a new organization with consolidated billing features only
|
|
72
|
+
* ```javascript
|
|
73
|
+
* // In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:
|
|
74
|
+
* //
|
|
75
|
+
* //
|
|
76
|
+
* const input = {
|
|
77
|
+
* "FeatureSet": "CONSOLIDATED_BILLING"
|
|
78
|
+
* };
|
|
79
|
+
* const command = new CreateOrganizationCommand(input);
|
|
80
|
+
* const response = await client.send(command);
|
|
81
|
+
* /* response ==
|
|
82
|
+
* {
|
|
83
|
+
* "Organization": {
|
|
84
|
+
* "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
|
|
85
|
+
* "AvailablePolicyTypes": [],
|
|
86
|
+
* "FeatureSet": "CONSOLIDATED_BILLING",
|
|
87
|
+
* "Id": "o-exampleorgid",
|
|
88
|
+
* "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
|
|
89
|
+
* "MasterAccountEmail": "bill@example.com",
|
|
90
|
+
* "MasterAccountId": "111111111111"
|
|
91
|
+
* }
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* // example id: to-create-a-new-organization-with-consolidated-billing-features-only
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
42
97
|
*/
|
|
43
98
|
export declare class CreateOrganizationCommand extends $Command<CreateOrganizationCommandInput, CreateOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
|
|
44
99
|
readonly input: CreateOrganizationCommandInput;
|
|
@@ -39,6 +39,29 @@ export interface CreateOrganizationalUnitCommandOutput extends CreateOrganizatio
|
|
|
39
39
|
* @see {@link CreateOrganizationalUnitCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To create a new organization unit
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:
|
|
45
|
+
* //
|
|
46
|
+
* //
|
|
47
|
+
* const input = {
|
|
48
|
+
* "Name": "AccountingOU",
|
|
49
|
+
* "ParentId": "r-examplerootid111"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new CreateOrganizationalUnitCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* /* response ==
|
|
54
|
+
* {
|
|
55
|
+
* "OrganizationalUnit": {
|
|
56
|
+
* "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
|
|
57
|
+
* "Id": "ou-examplerootid111-exampleouid111",
|
|
58
|
+
* "Name": "AccountingOU"
|
|
59
|
+
* }
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: to-create-a-new-organizational-unit
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
42
65
|
*/
|
|
43
66
|
export declare class CreateOrganizationalUnitCommand extends $Command<CreateOrganizationalUnitCommandInput, CreateOrganizationalUnitCommandOutput, OrganizationsClientResolvedConfig> {
|
|
44
67
|
readonly input: CreateOrganizationalUnitCommandInput;
|
|
@@ -35,6 +35,35 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
|
|
|
35
35
|
* @see {@link CreatePolicyCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example To create a service control policy
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:
|
|
41
|
+
* //
|
|
42
|
+
* //
|
|
43
|
+
* const input = {
|
|
44
|
+
* "Content": "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}",
|
|
45
|
+
* "Description": "Enables admins of attached accounts to delegate all S3 permissions",
|
|
46
|
+
* "Name": "AllowAllS3Actions",
|
|
47
|
+
* "Type": "SERVICE_CONTROL_POLICY"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new CreatePolicyCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "Policy": {
|
|
54
|
+
* "Content": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}",
|
|
55
|
+
* "PolicySummary": {
|
|
56
|
+
* "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
|
|
57
|
+
* "Description": "Allows delegation of all S3 actions",
|
|
58
|
+
* "Name": "AllowAllS3Actions",
|
|
59
|
+
* "Type": "SERVICE_CONTROL_POLICY"
|
|
60
|
+
* }
|
|
61
|
+
* }
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: to-create-a-service-control-policy
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
38
67
|
*/
|
|
39
68
|
export declare class CreatePolicyCommand extends $Command<CreatePolicyCommandInput, CreatePolicyCommandOutput, OrganizationsClientResolvedConfig> {
|
|
40
69
|
readonly input: CreatePolicyCommandInput;
|
|
@@ -35,6 +35,63 @@ export interface DeclineHandshakeCommandOutput extends DeclineHandshakeResponse,
|
|
|
35
35
|
* @see {@link DeclineHandshakeCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example To decline a handshake sent from the master account
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:
|
|
41
|
+
* const input = {
|
|
42
|
+
* "HandshakeId": "h-examplehandshakeid111"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DeclineHandshakeCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "Handshake": {
|
|
49
|
+
* "Action": "INVITE",
|
|
50
|
+
* "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
51
|
+
* "ExpirationTimestamp": "2016-12-15T19:27:58Z",
|
|
52
|
+
* "Id": "h-examplehandshakeid111",
|
|
53
|
+
* "Parties": [
|
|
54
|
+
* {
|
|
55
|
+
* "Id": "222222222222",
|
|
56
|
+
* "Type": "ACCOUNT"
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "Id": "o-exampleorgid",
|
|
60
|
+
* "Type": "ORGANIZATION"
|
|
61
|
+
* }
|
|
62
|
+
* ],
|
|
63
|
+
* "RequestedTimestamp": "2016-11-30T19:27:58Z",
|
|
64
|
+
* "Resources": [
|
|
65
|
+
* {
|
|
66
|
+
* "Resources": [
|
|
67
|
+
* {
|
|
68
|
+
* "Type": "MASTER_EMAIL",
|
|
69
|
+
* "Value": "bill@example.com"
|
|
70
|
+
* },
|
|
71
|
+
* {
|
|
72
|
+
* "Type": "MASTER_NAME",
|
|
73
|
+
* "Value": "Master Account"
|
|
74
|
+
* }
|
|
75
|
+
* ],
|
|
76
|
+
* "Type": "ORGANIZATION",
|
|
77
|
+
* "Value": "o-exampleorgid"
|
|
78
|
+
* },
|
|
79
|
+
* {
|
|
80
|
+
* "Type": "ACCOUNT",
|
|
81
|
+
* "Value": "222222222222"
|
|
82
|
+
* },
|
|
83
|
+
* {
|
|
84
|
+
* "Type": "NOTES",
|
|
85
|
+
* "Value": "This is an invitation to Susan's account to join the Bill's organization."
|
|
86
|
+
* }
|
|
87
|
+
* ],
|
|
88
|
+
* "State": "DECLINED"
|
|
89
|
+
* }
|
|
90
|
+
* }
|
|
91
|
+
* *\/
|
|
92
|
+
* // example id: to-decline-a-handshake-sent-from-the-master-account-1472502666967
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
38
95
|
*/
|
|
39
96
|
export declare class DeclineHandshakeCommand extends $Command<DeclineHandshakeCommandInput, DeclineHandshakeCommandOutput, OrganizationsClientResolvedConfig> {
|
|
40
97
|
readonly input: DeclineHandshakeCommandInput;
|
|
@@ -31,6 +31,19 @@ export interface DeleteOrganizationalUnitCommandOutput extends __MetadataBearer
|
|
|
31
31
|
* @see {@link DeleteOrganizationalUnitCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To delete an organization unit
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:
|
|
37
|
+
* //
|
|
38
|
+
* //
|
|
39
|
+
* const input = {
|
|
40
|
+
* "OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteOrganizationalUnitCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: to-delete-an-organizational-unit
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
34
47
|
*/
|
|
35
48
|
export declare class DeleteOrganizationalUnitCommand extends $Command<DeleteOrganizationalUnitCommandInput, DeleteOrganizationalUnitCommandOutput, OrganizationsClientResolvedConfig> {
|
|
36
49
|
readonly input: DeleteOrganizationalUnitCommandInput;
|
|
@@ -32,6 +32,19 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* @see {@link DeletePolicyCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To delete a policy
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:
|
|
38
|
+
* //
|
|
39
|
+
* //
|
|
40
|
+
* const input = {
|
|
41
|
+
* "PolicyId": "p-examplepolicyid111"
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeletePolicyCommand(input);
|
|
44
|
+
* await client.send(command);
|
|
45
|
+
* // example id: to-delete-a-policy
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
35
48
|
*/
|
|
36
49
|
export declare class DeletePolicyCommand extends $Command<DeletePolicyCommandInput, DeletePolicyCommandOutput, OrganizationsClientResolvedConfig> {
|
|
37
50
|
readonly input: DeletePolicyCommandInput;
|
|
@@ -31,6 +31,27 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResponse, _
|
|
|
31
31
|
* @see {@link DescribeAccountCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To get the details about an account
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example shows a user in the master account (111111111111) asking for details about account 555555555555:
|
|
37
|
+
* const input = {
|
|
38
|
+
* "AccountId": "555555555555"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeAccountCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "Account": {
|
|
45
|
+
* "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555",
|
|
46
|
+
* "Email": "anika@example.com",
|
|
47
|
+
* "Id": "555555555555",
|
|
48
|
+
* "Name": "Beta Account"
|
|
49
|
+
* }
|
|
50
|
+
* }
|
|
51
|
+
* *\/
|
|
52
|
+
* // example id: to-get-the-details-about-an-account-1472503166868
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
34
55
|
*/
|
|
35
56
|
export declare class DescribeAccountCommand extends $Command<DescribeAccountCommandInput, DescribeAccountCommandOutput, OrganizationsClientResolvedConfig> {
|
|
36
57
|
readonly input: DescribeAccountCommandInput;
|
|
@@ -31,6 +31,26 @@ export interface DescribeCreateAccountStatusCommandOutput extends DescribeCreate
|
|
|
31
31
|
* @see {@link DescribeCreateAccountStatusCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To get information about a request to create an account
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // 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":
|
|
37
|
+
* const input = {
|
|
38
|
+
* "CreateAccountRequestId": "car-exampleaccountcreationrequestid"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeCreateAccountStatusCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "CreateAccountStatus": {
|
|
45
|
+
* "AccountId": "333333333333",
|
|
46
|
+
* "Id": "car-exampleaccountcreationrequestid",
|
|
47
|
+
* "State": "SUCCEEDED"
|
|
48
|
+
* }
|
|
49
|
+
* }
|
|
50
|
+
* *\/
|
|
51
|
+
* // example id: to-get-information-about-a-request-to-create-an-account-1472503727223
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
34
54
|
*/
|
|
35
55
|
export declare class DescribeCreateAccountStatusCommand extends $Command<DescribeCreateAccountStatusCommandInput, DescribeCreateAccountStatusCommandOutput, OrganizationsClientResolvedConfig> {
|
|
36
56
|
readonly input: DescribeCreateAccountStatusCommandInput;
|
|
@@ -35,6 +35,59 @@ export interface DescribeHandshakeCommandOutput extends DescribeHandshakeRespons
|
|
|
35
35
|
* @see {@link DescribeHandshakeCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example To get information about a handshake
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // 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":
|
|
41
|
+
* const input = {
|
|
42
|
+
* "HandshakeId": "h-examplehandshakeid111"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DescribeHandshakeCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "Handshake": {
|
|
49
|
+
* "Action": "INVITE",
|
|
50
|
+
* "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
|
|
51
|
+
* "ExpirationTimestamp": "2016-11-30T17:24:58.046Z",
|
|
52
|
+
* "Id": "h-examplehandshakeid111",
|
|
53
|
+
* "Parties": [
|
|
54
|
+
* {
|
|
55
|
+
* "Id": "o-exampleorgid",
|
|
56
|
+
* "Type": "ORGANIZATION"
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "Id": "333333333333",
|
|
60
|
+
* "Type": "ACCOUNT"
|
|
61
|
+
* }
|
|
62
|
+
* ],
|
|
63
|
+
* "RequestedTimestamp": "2016-11-30T17:24:58.046Z",
|
|
64
|
+
* "Resources": [
|
|
65
|
+
* {
|
|
66
|
+
* "Resources": [
|
|
67
|
+
* {
|
|
68
|
+
* "Type": "MASTER_EMAIL",
|
|
69
|
+
* "Value": "bill@example.com"
|
|
70
|
+
* },
|
|
71
|
+
* {
|
|
72
|
+
* "Type": "MASTER_NAME",
|
|
73
|
+
* "Value": "Master Account"
|
|
74
|
+
* }
|
|
75
|
+
* ],
|
|
76
|
+
* "Type": "ORGANIZATION",
|
|
77
|
+
* "Value": "o-exampleorgid"
|
|
78
|
+
* },
|
|
79
|
+
* {
|
|
80
|
+
* "Type": "ACCOUNT",
|
|
81
|
+
* "Value": "333333333333"
|
|
82
|
+
* }
|
|
83
|
+
* ],
|
|
84
|
+
* "State": "OPEN"
|
|
85
|
+
* }
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* // example id: to-get-information-about-a-handshake-1472503400505
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
38
91
|
*/
|
|
39
92
|
export declare class DescribeHandshakeCommand extends $Command<DescribeHandshakeCommandInput, DescribeHandshakeCommandOutput, OrganizationsClientResolvedConfig> {
|
|
40
93
|
readonly input: DescribeHandshakeCommandInput;
|
|
@@ -36,6 +36,32 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
|
|
|
36
36
|
* @see {@link DescribeOrganizationCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @example To get information about an organization
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // The following example shows how to request information about the current user's organization:/n/n
|
|
42
|
+
* const input = undefined;
|
|
43
|
+
* const command = new DescribeOrganizationCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* /* response ==
|
|
46
|
+
* {
|
|
47
|
+
* "Organization": {
|
|
48
|
+
* "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
|
|
49
|
+
* "AvailablePolicyTypes": [
|
|
50
|
+
* {
|
|
51
|
+
* "Status": "ENABLED",
|
|
52
|
+
* "Type": "SERVICE_CONTROL_POLICY"
|
|
53
|
+
* }
|
|
54
|
+
* ],
|
|
55
|
+
* "FeatureSet": "ALL",
|
|
56
|
+
* "Id": "o-exampleorgid",
|
|
57
|
+
* "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
|
|
58
|
+
* "MasterAccountEmail": "bill@example.com"
|
|
59
|
+
* }
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: to-get-information-about-an-organization-1472503400505
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
39
65
|
*/
|
|
40
66
|
export declare class DescribeOrganizationCommand extends $Command<DescribeOrganizationCommandInput, DescribeOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
|
|
41
67
|
readonly input: DescribeOrganizationCommandInput;
|
|
@@ -31,6 +31,26 @@ export interface DescribeOrganizationalUnitCommandOutput extends DescribeOrganiz
|
|
|
31
31
|
* @see {@link DescribeOrganizationalUnitCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To get information about an organizational unit
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example shows how to request details about an OU:/n/n
|
|
37
|
+
* const input = {
|
|
38
|
+
* "OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeOrganizationalUnitCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "OrganizationalUnit": {
|
|
45
|
+
* "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
|
|
46
|
+
* "Id": "ou-examplerootid111-exampleouid111",
|
|
47
|
+
* "Name": "Accounting Group"
|
|
48
|
+
* }
|
|
49
|
+
* }
|
|
50
|
+
* *\/
|
|
51
|
+
* // example id: to-get-information-about-an-organizational-unit
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
34
54
|
*/
|
|
35
55
|
export declare class DescribeOrganizationalUnitCommand extends $Command<DescribeOrganizationalUnitCommandInput, DescribeOrganizationalUnitCommandOutput, OrganizationsClientResolvedConfig> {
|
|
36
56
|
readonly input: DescribeOrganizationalUnitCommandInput;
|
|
@@ -31,6 +31,32 @@ export interface DescribePolicyCommandOutput extends DescribePolicyResponse, __M
|
|
|
31
31
|
* @see {@link DescribePolicyCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To get information about a policy
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example shows how to request information about a policy:/n/n
|
|
37
|
+
* const input = {
|
|
38
|
+
* "PolicyId": "p-examplepolicyid111"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribePolicyCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "Policy": {
|
|
45
|
+
* "Content": "{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": \\\"*\\\",\\n \\\"Resource\\\": \\\"*\\\"\\n }\\n ]\\n}",
|
|
46
|
+
* "PolicySummary": {
|
|
47
|
+
* "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
|
|
48
|
+
* "AwsManaged": false,
|
|
49
|
+
* "Description": "Enables admins to delegate S3 permissions",
|
|
50
|
+
* "Id": "p-examplepolicyid111",
|
|
51
|
+
* "Name": "AllowAllS3Actions",
|
|
52
|
+
* "Type": "SERVICE_CONTROL_POLICY"
|
|
53
|
+
* }
|
|
54
|
+
* }
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: to-get-information-about-a-policy
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
34
60
|
*/
|
|
35
61
|
export declare class DescribePolicyCommand extends $Command<DescribePolicyCommandInput, DescribePolicyCommandOutput, OrganizationsClientResolvedConfig> {
|
|
36
62
|
readonly input: DescribePolicyCommandInput;
|
|
@@ -43,6 +43,18 @@ export interface DetachPolicyCommandOutput extends __MetadataBearer {
|
|
|
43
43
|
* @see {@link DetachPolicyCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To detach a policy from a root, OU, or account
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following example shows how to detach a policy from an OU:/n/n
|
|
49
|
+
* const input = {
|
|
50
|
+
* "PolicyId": "p-examplepolicyid111",
|
|
51
|
+
* "TargetId": "ou-examplerootid111-exampleouid111"
|
|
52
|
+
* };
|
|
53
|
+
* const command = new DetachPolicyCommand(input);
|
|
54
|
+
* await client.send(command);
|
|
55
|
+
* // example id: to-detach-a-policy-from-a-root-ou-or-account
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
46
58
|
*/
|
|
47
59
|
export declare class DetachPolicyCommand extends $Command<DetachPolicyCommandInput, DetachPolicyCommandOutput, OrganizationsClientResolvedConfig> {
|
|
48
60
|
readonly input: DetachPolicyCommandInput;
|