organizations-2016-11-28.examples.json
48.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
{
"version": "1.0",
"examples": {
"AcceptHandshake": [
{
"input": {
"HandshakeId": "h-examplehandshakeid111"
},
"output": {
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "20170228T1215Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "juan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "20170214T1215Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@amazon.com"
},
{
"Type": "MASTER_NAME",
"Value": "Org Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "ALL"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "ACCOUNT",
"Value": "222222222222"
}
],
"State": "ACCEPTED"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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.",
"id": "to-accept-a-handshake-from-another-account-1472500561150",
"title": "To accept a handshake from another account"
}
],
"AttachPolicy": [
{
"input": {
"PolicyId": "p-examplepolicyid111",
"TargetId": "ou-examplerootid111-exampleouid111"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to attach a service control policy (SCP) to an OU:\n",
"id": "to-attach-a-policy-to-an-ou",
"title": "To attach a policy to an OU"
},
{
"input": {
"PolicyId": "p-examplepolicyid111",
"TargetId": "333333333333"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to attach a service control policy (SCP) to an account:\n",
"id": "to-attach-a-policy-to-an-account",
"title": "To attach a policy to an account"
}
],
"CancelHandshake": [
{
"input": {
"HandshakeId": "h-examplehandshakeid111"
},
"output": {
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "20170228T1215Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "susan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "20170214T1215Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@example.com"
},
{
"Type": "MASTER_NAME",
"Value": "Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "CONSOLIDATED_BILLING"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "ACCOUNT",
"Value": "222222222222"
},
{
"Type": "NOTES",
"Value": "This is a request for Susan's account to join Bob's organization."
}
],
"State": "CANCELED"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:\n",
"id": "to-cancel-a-handshake-sent-to-a-member-account-1472501320506",
"title": "To cancel a handshake sent to a member account"
}
],
"CreateAccount": [
{
"input": {
"AccountName": "Production Account",
"Email": "susan@example.com"
},
"output": {
"CreateAccountStatus": {
"Id": "car-examplecreateaccountrequestid111",
"State": "IN_PROGRESS"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:\n\n",
"id": "to-create-a-new-account-that-is-automatically-part-of-the-organization-1472501463507",
"title": "To create a new account that is automatically part of the organization"
}
],
"CreateOrganization": [
{
"input": {
},
"output": {
"Organization": {
"Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
"AvailablePolicyTypes": [
{
"Status": "ENABLED",
"Type": "SERVICE_CONTROL_POLICY"
}
],
"FeatureSet": "ALL",
"Id": "o-exampleorgid",
"MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
"MasterAccountEmail": "bill@example.com",
"MasterAccountId": "111111111111"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:\n\n",
"id": "to-create-a-new-organization-with-all-features enabled",
"title": "To create a new organization with all features enabled"
},
{
"input": {
"FeatureSet": "CONSOLIDATED_BILLING"
},
"output": {
"Organization": {
"Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
"AvailablePolicyTypes": [
],
"FeatureSet": "CONSOLIDATED_BILLING",
"Id": "o-exampleorgid",
"MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
"MasterAccountEmail": "bill@example.com",
"MasterAccountId": "111111111111"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:\n\n",
"id": "to-create-a-new-organization-with-consolidated-billing-features-only",
"title": "To create a new organization with consolidated billing features only"
}
],
"CreateOrganizationalUnit": [
{
"input": {
"Name": "AccountingOU",
"ParentId": "r-examplerootid111"
},
"output": {
"OrganizationalUnit": {
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
"Id": "ou-examplerootid111-exampleouid111",
"Name": "AccountingOU"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:\n\n",
"id": "to-create-a-new-organizational-unit",
"title": "To create a new organization unit"
}
],
"CreatePolicy": [
{
"input": {
"Content": "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}",
"Description": "Enables admins of attached accounts to delegate all S3 permissions",
"Name": "AllowAllS3Actions",
"Type": "SERVICE_CONTROL_POLICY"
},
"output": {
"Policy": {
"Content": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}",
"PolicySummary": {
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
"Description": "Allows delegation of all S3 actions",
"Name": "AllowAllS3Actions",
"Type": "SERVICE_CONTROL_POLICY"
}
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:\n\n",
"id": "to-create-a-service-control-policy",
"title": "To create a service control policy"
}
],
"DeclineHandshake": [
{
"input": {
"HandshakeId": "h-examplehandshakeid111"
},
"output": {
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2016-12-15T19:27:58Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "222222222222",
"Type": "ACCOUNT"
},
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
}
],
"RequestedTimestamp": "2016-11-30T19:27:58Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@example.com"
},
{
"Type": "MASTER_NAME",
"Value": "Master Account"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "ACCOUNT",
"Value": "222222222222"
},
{
"Type": "NOTES",
"Value": "This is an invitation to Susan's account to join the Bill's organization."
}
],
"State": "DECLINED"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:",
"id": "to-decline-a-handshake-sent-from-the-master-account-1472502666967",
"title": "To decline a handshake sent from the master account"
}
],
"DeleteOrganizationalUnit": [
{
"input": {
"OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:\n\n",
"id": "to-delete-an-organizational-unit",
"title": "To delete an organization unit"
}
],
"DeletePolicy": [
{
"input": {
"PolicyId": "p-examplepolicyid111"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:\n\n",
"id": "to-delete-a-policy",
"title": "To delete a policy"
}
],
"DescribeAccount": [
{
"input": {
"AccountId": "555555555555"
},
"output": {
"Account": {
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555",
"Email": "anika@example.com",
"Id": "555555555555",
"Name": "Beta Account"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows a user in the master account (111111111111) asking for details about account 555555555555:",
"id": "to-get-the-details-about-an-account-1472503166868",
"title": "To get the details about an account"
}
],
"DescribeCreateAccountStatus": [
{
"input": {
"CreateAccountRequestId": "car-exampleaccountcreationrequestid"
},
"output": {
"CreateAccountStatus": {
"AccountId": "333333333333",
"Id": "car-exampleaccountcreationrequestid",
"State": "SUCCEEDED"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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\":",
"id": "to-get-information-about-a-request-to-create-an-account-1472503727223",
"title": "To get information about a request to create an account"
}
],
"DescribeHandshake": [
{
"input": {
"HandshakeId": "h-examplehandshakeid111"
},
"output": {
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2016-11-30T17:24:58.046Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "333333333333",
"Type": "ACCOUNT"
}
],
"RequestedTimestamp": "2016-11-30T17:24:58.046Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@example.com"
},
{
"Type": "MASTER_NAME",
"Value": "Master Account"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "ACCOUNT",
"Value": "333333333333"
}
],
"State": "OPEN"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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\":",
"id": "to-get-information-about-a-handshake-1472503400505",
"title": "To get information about a handshake"
}
],
"DescribeOrganization": [
{
"output": {
"Organization": {
"Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
"AvailablePolicyTypes": [
{
"Status": "ENABLED",
"Type": "SERVICE_CONTROL_POLICY"
}
],
"FeatureSet": "ALL",
"Id": "o-exampleorgid",
"MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
"MasterAccountEmail": "bill@example.com"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to request information about the current user's organization:/n/n",
"id": "to-get-information-about-an-organization-1472503400505",
"title": "To get information about an organization"
}
],
"DescribeOrganizationalUnit": [
{
"input": {
"OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
},
"output": {
"OrganizationalUnit": {
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
"Id": "ou-examplerootid111-exampleouid111",
"Name": "Accounting Group"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to request details about an OU:/n/n",
"id": "to-get-information-about-an-organizational-unit",
"title": "To get information about an organizational unit"
}
],
"DescribePolicy": [
{
"input": {
"PolicyId": "p-examplepolicyid111"
},
"output": {
"Policy": {
"Content": "{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": \\\"*\\\",\\n \\\"Resource\\\": \\\"*\\\"\\n }\\n ]\\n}",
"PolicySummary": {
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
"AwsManaged": false,
"Description": "Enables admins to delegate S3 permissions",
"Id": "p-examplepolicyid111",
"Name": "AllowAllS3Actions",
"Type": "SERVICE_CONTROL_POLICY"
}
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to request information about a policy:/n/n",
"id": "to-get-information-about-a-policy",
"title": "To get information about a policy"
}
],
"DetachPolicy": [
{
"input": {
"PolicyId": "p-examplepolicyid111",
"TargetId": "ou-examplerootid111-exampleouid111"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to detach a policy from an OU:/n/n",
"id": "to-detach-a-policy-from-a-root-ou-or-account",
"title": "To detach a policy from a root, OU, or account"
}
],
"DisablePolicyType": [
{
"input": {
"PolicyType": "SERVICE_CONTROL_POLICY",
"RootId": "r-examplerootid111"
},
"output": {
"Root": {
"Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
"Id": "r-examplerootid111",
"Name": "Root",
"PolicyTypes": [
]
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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",
"id": "to-disable-a-policy-type-in-a-root",
"title": "To disable a policy type in a root"
}
],
"EnableAllFeatures": [
{
"input": {
},
"output": {
"Handshake": {
"Action": "ENABLE_ALL_FEATURES",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111",
"ExpirationTimestamp": "2017-02-28T09:35:40.05Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
}
],
"RequestedTimestamp": "2017-02-13T09:35:40.05Z",
"Resources": [
{
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
}
],
"State": "REQUESTED"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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",
"id": "to-enable-all-features-in-an-organization",
"title": "To enable all features in an organization"
}
],
"EnablePolicyType": [
{
"input": {
"PolicyType": "SERVICE_CONTROL_POLICY",
"RootId": "r-examplerootid111"
},
"output": {
"Root": {
"Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
"Id": "r-examplerootid111",
"Name": "Root",
"PolicyTypes": [
{
"Status": "ENABLED",
"Type": "SERVICE_CONTROL_POLICY"
}
]
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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",
"id": "to-enable-a-policy-type-in-a-root",
"title": "To enable a policy type in a root"
}
],
"InviteAccountToOrganization": [
{
"input": {
"Notes": "This is a request for Juan's account to join Bill's organization",
"Target": {
"Id": "juan@example.com",
"Type": "EMAIL"
}
},
"output": {
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2017-02-16T09:36:05.02Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "juan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "2017-02-01T09:36:05.02Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@amazon.com"
},
{
"Type": "MASTER_NAME",
"Value": "Org Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "FULL"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "EMAIL",
"Value": "juan@example.com"
}
],
"State": "OPEN"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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.",
"id": "to-invite-an-account-to-join-an-organization-1472508594110",
"title": "To invite an account to join an organization"
}
],
"LeaveOrganization": [
{
"comments": {
"input": {
},
"output": {
}
},
"description": "TThe following example shows how to remove your member account from an organization:",
"id": "to-leave-an-organization-as-a-member-account-1472508784736",
"title": "To leave an organization as a member account"
}
],
"ListAccounts": [
{
"input": {
},
"output": {
"Accounts": [
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
"Email": "bill@example.com",
"Id": "111111111111",
"JoinedMethod": "INVITED",
"JoinedTimestamp": "20161215T193015Z",
"Name": "Master Account",
"Status": "ACTIVE"
},
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222",
"Email": "alice@example.com",
"Id": "222222222222",
"JoinedMethod": "INVITED",
"JoinedTimestamp": "20161215T210221Z",
"Name": "Developer Account",
"Status": "ACTIVE"
},
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
"Email": "juan@example.com",
"Id": "333333333333",
"JoinedMethod": "INVITED",
"JoinedTimestamp": "20161215T210347Z",
"Name": "Test Account",
"Status": "ACTIVE"
},
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
"Email": "anika@example.com",
"Id": "444444444444",
"JoinedMethod": "INVITED",
"JoinedTimestamp": "20161215T210332Z",
"Name": "Production Account",
"Status": "ACTIVE"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows you how to request a list of the accounts in an organization:",
"id": "to-retrieve-a-list-of-all-of-the-accounts-in-an-organization-1472509590974",
"title": "To retrieve a list of all of the accounts in an organization"
}
],
"ListAccountsForParent": [
{
"input": {
"ParentId": "ou-examplerootid111-exampleouid111"
},
"output": {
"Accounts": [
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
"Email": "juan@example.com",
"Id": "333333333333",
"JoinedMethod": "INVITED",
"JoinedTimestamp": 1481835795.536,
"Name": "Development Account",
"Status": "ACTIVE"
},
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
"Email": "anika@example.com",
"Id": "444444444444",
"JoinedMethod": "INVITED",
"JoinedTimestamp": 1481835812.143,
"Name": "Test Account",
"Status": "ACTIVE"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to request a list of the accounts in an OU:/n/n",
"id": "to-retrieve-a-list-of-all-of-the-accounts-in-a-root-or-ou-1472509590974",
"title": "To retrieve a list of all of the accounts in a root or OU"
}
],
"ListChildren": [
{
"input": {
"ChildType": "ORGANIZATIONAL_UNIT",
"ParentId": "ou-examplerootid111-exampleouid111"
},
"output": {
"Children": [
{
"Id": "ou-examplerootid111-exampleouid111",
"Type": "ORGANIZATIONAL_UNIT"
},
{
"Id": "ou-examplerootid111-exampleouid222",
"Type": "ORGANIZATIONAL_UNIT"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to request a list of the child OUs in a parent root or OU:/n/n",
"id": "to-retrieve-a-list-of-all-of-the-child-accounts-and-OUs-in-a-parent-container",
"title": "To retrieve a list of all of the child accounts and OUs in a parent root or OU"
}
],
"ListCreateAccountStatus": [
{
"input": {
"States": [
"SUCCEEDED"
]
},
"output": {
"CreateAccountStatuses": [
{
"AccountId": "444444444444",
"AccountName": "Developer Test Account",
"CompletedTimestamp": "2017-01-15T13:45:23.6Z",
"Id": "car-exampleaccountcreationrequestid1",
"RequestedTimestamp": "2017-01-15T13:45:23.01Z",
"State": "SUCCEEDED"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:",
"id": "to-get-a-list-of-completed-account-creation-requests-made-in-the-organization",
"title": "To get a list of completed account creation requests made in the organization"
},
{
"input": {
"States": [
"IN_PROGRESS"
]
},
"output": {
"CreateAccountStatuses": [
{
"AccountName": "Production Account",
"Id": "car-exampleaccountcreationrequestid2",
"RequestedTimestamp": "2017-01-15T13:45:23.01Z",
"State": "IN_PROGRESS"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:",
"id": "to-get-a-list-of-all-account-creation-requests-made-in-the-organization-1472509174532",
"title": "To get a list of all account creation requests made in the organization"
}
],
"ListHandshakesForAccount": [
{
"output": {
"Handshakes": [
{
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "juan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "2017-01-13T14:35:23.3Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@amazon.com"
},
{
"Type": "MASTER_NAME",
"Value": "Org Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "FULL"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "EMAIL",
"Value": "juan@example.com"
}
],
"State": "OPEN"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "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:",
"id": "to-retrieve-a-list-of-the-handshakes-sent-to-an-account-1472510214747",
"title": "To retrieve a list of the handshakes sent to an account"
}
],
"ListHandshakesForOrganization": [
{
"output": {
"Handshakes": [
{
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "juan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "2017-01-13T14:35:23.3Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@amazon.com"
},
{
"Type": "MASTER_NAME",
"Value": "Org Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "FULL"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "EMAIL",
"Value": "juan@example.com"
}
],
"State": "OPEN"
},
{
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": "2017-01-28T14:35:23.3Z",
"Id": "h-examplehandshakeid222",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "anika@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": "2017-01-13T14:35:23.3Z",
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@example.com"
},
{
"Type": "MASTER_NAME",
"Value": "Master Account"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "EMAIL",
"Value": "anika@example.com"
},
{
"Type": "NOTES",
"Value": "This is an invitation to Anika's account to join Bill's organization."
}
],
"State": "ACCEPTED"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows you how to get a list of handshakes associated with the current organization:",
"id": "to-retrieve-a-list-of-the-handshakes-associated-with-an-organization-1472511206653",
"title": "To retrieve a list of the handshakes associated with an organization"
}
],
"ListOrganizationalUnitsForParent": [
{
"input": {
"ParentId": "r-examplerootid111"
},
"output": {
"OrganizationalUnits": [
{
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111",
"Id": "ou-examplerootid111-exampleouid111",
"Name": "Development"
},
{
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222",
"Id": "ou-examplerootid111-exampleouid222",
"Name": "Production"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to get a list of OUs in a specified root:/n/n",
"id": "to-retrieve-a-list-of-all-of-the-OUs-in-a-parent-container",
"title": "To retrieve a list of all of the child OUs in a parent root or OU"
}
],
"ListParents": [
{
"input": {
"ChildId": "444444444444"
},
"output": {
"Parents": [
{
"Id": "ou-examplerootid111-exampleouid111",
"Type": "ORGANIZATIONAL_UNIT"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to list the root or OUs that contain account 444444444444:/n/n",
"id": "to-retrieve-a-list-of-all-of-the-parents-of-a-child-ou-or-account",
"title": "To retrieve a list of all of the parents of a child OU or account"
}
],
"ListPolicies": [
{
"input": {
"Filter": "SERVICE_CONTROL_POLICY"
},
"output": {
"Policies": [
{
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
"AwsManaged": false,
"Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts.",
"Id": "p-examplepolicyid111",
"Name": "AllowAllS3Actions",
"Type": "SERVICE_CONTROL_POLICY"
},
{
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222",
"AwsManaged": false,
"Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.",
"Id": "p-examplepolicyid222",
"Name": "AllowAllEC2Actions",
"Type": "SERVICE_CONTROL_POLICY"
},
{
"Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess",
"AwsManaged": true,
"Description": "Allows access to every operation",
"Id": "p-FullAWSAccess",
"Name": "FullAWSAccess",
"Type": "SERVICE_CONTROL_POLICY"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to get a list of service control policies (SCPs):/n/n",
"id": "to-retrieve-a-list-of--policies-in-the-organization",
"title": "To retrieve a list policies in the organization"
}
],
"ListPoliciesForTarget": [
{
"input": {
"Filter": "SERVICE_CONTROL_POLICY",
"TargetId": "444444444444"
},
"output": {
"Policies": [
{
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222",
"AwsManaged": false,
"Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.",
"Id": "p-examplepolicyid222",
"Name": "AllowAllEC2Actions",
"Type": "SERVICE_CONTROL_POLICY"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n",
"id": "to-retrieve-a-list-of-policies-attached-to-a-root-ou-or-account",
"title": "To retrieve a list policies attached to a root, OU, or account"
}
],
"ListRoots": [
{
"input": {
},
"output": {
"Roots": [
{
"Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
"Id": "r-examplerootid111",
"Name": "Root",
"PolicyTypes": [
{
"Status": "ENABLED",
"Type": "SERVICE_CONTROL_POLICY"
}
]
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to get the list of the roots in the current organization:/n/n",
"id": "to-retrieve-a-list-of-roots-in-the-organization",
"title": "To retrieve a list of roots in the organization"
}
],
"ListTargetsForPolicy": [
{
"input": {
"PolicyId": "p-FullAWSAccess"
},
"output": {
"Targets": [
{
"Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
"Name": "Root",
"TargetId": "r-examplerootid111",
"Type": "ROOT"
},
{
"Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;",
"Name": "Developer Test Account",
"TargetId": "333333333333",
"Type": "ACCOUNT"
},
{
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
"Name": "Accounting",
"TargetId": "ou-examplerootid111-exampleouid111",
"Type": "ORGANIZATIONAL_UNIT"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n",
"id": "to-retrieve-a-list-of-roots-ous-and-accounts-to-which-a-policy-is-attached",
"title": "To retrieve a list of roots, OUs, and accounts to which a policy is attached"
}
],
"MoveAccount": [
{
"input": {
"AccountId": "333333333333",
"DestinationParentId": "ou-examplerootid111-exampleouid111",
"SourceParentId": "r-examplerootid111"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to move a member account from the root to an OU:/n/n",
"id": "to-move-an-ou-or-account-to-another-ou-or-the-root",
"title": "To move an OU or account to another OU or the root"
}
],
"RemoveAccountFromOrganization": [
{
"input": {
"AccountId": "333333333333"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows you how to remove an account from an organization:",
"id": "to-remove-an-account-from-an-organization-as-the-master-account",
"title": "To remove an account from an organization as the master account"
}
],
"UpdateOrganizationalUnit": [
{
"input": {
"Name": "AccountingOU",
"OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
},
"output": {
"OrganizationalUnit": {
"Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
"Id": "ou-examplerootid111-exampleouid111",
"Name": "AccountingOU"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to rename an OU. The output confirms the new name:/n/n",
"id": "to-rename-an-organizational-unit",
"title": "To rename an organizational unit"
}
],
"UpdatePolicy": [
{
"input": {
"Description": "This description replaces the original.",
"Name": "Renamed-Policy",
"PolicyId": "p-examplepolicyid111"
},
"output": {
"Policy": {
"Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }",
"PolicySummary": {
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
"AwsManaged": false,
"Description": "This description replaces the original.",
"Id": "p-examplepolicyid111",
"Name": "Renamed-Policy",
"Type": "SERVICE_CONTROL_POLICY"
}
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n",
"id": "to-update-the-details-of-a-policy",
"title": "To update the details of a policy"
},
{
"input": {
"Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }",
"PolicyId": "p-examplepolicyid111"
},
"output": {
"Policy": {
"Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }",
"PolicySummary": {
"Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
"AwsManaged": false,
"Description": "This description replaces the original.",
"Id": "p-examplepolicyid111",
"Name": "Renamed-Policy",
"Type": "SERVICE_CONTROL_POLICY"
}
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n",
"id": "to-update-the-content-of-a-policy",
"title": "To update the content of a policy"
}
]
}
}