appstream.d.ts
107 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
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class AppStream extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AppStream.Types.ClientConfiguration)
config: Config & AppStream.Types.ClientConfiguration;
/**
* Associates the specified fleet with the specified stack.
*/
associateFleet(params: AppStream.Types.AssociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request<AppStream.Types.AssociateFleetResult, AWSError>;
/**
* Associates the specified fleet with the specified stack.
*/
associateFleet(callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request<AppStream.Types.AssociateFleetResult, AWSError>;
/**
* Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
*/
batchAssociateUserStack(params: AppStream.Types.BatchAssociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request<AppStream.Types.BatchAssociateUserStackResult, AWSError>;
/**
* Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
*/
batchAssociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request<AppStream.Types.BatchAssociateUserStackResult, AWSError>;
/**
* Disassociates the specified users from the specified stacks.
*/
batchDisassociateUserStack(params: AppStream.Types.BatchDisassociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request<AppStream.Types.BatchDisassociateUserStackResult, AWSError>;
/**
* Disassociates the specified users from the specified stacks.
*/
batchDisassociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request<AppStream.Types.BatchDisassociateUserStackResult, AWSError>;
/**
* Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
*/
copyImage(params: AppStream.Types.CopyImageRequest, callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request<AppStream.Types.CopyImageResponse, AWSError>;
/**
* Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
*/
copyImage(callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request<AppStream.Types.CopyImageResponse, AWSError>;
/**
* Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
*/
createDirectoryConfig(params: AppStream.Types.CreateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request<AppStream.Types.CreateDirectoryConfigResult, AWSError>;
/**
* Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
*/
createDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request<AppStream.Types.CreateDirectoryConfigResult, AWSError>;
/**
* Creates a fleet. A fleet consists of streaming instances that run a specified image.
*/
createFleet(params: AppStream.Types.CreateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request<AppStream.Types.CreateFleetResult, AWSError>;
/**
* Creates a fleet. A fleet consists of streaming instances that run a specified image.
*/
createFleet(callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request<AppStream.Types.CreateFleetResult, AWSError>;
/**
* Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
*/
createImageBuilder(params: AppStream.Types.CreateImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request<AppStream.Types.CreateImageBuilderResult, AWSError>;
/**
* Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
*/
createImageBuilder(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request<AppStream.Types.CreateImageBuilderResult, AWSError>;
/**
* Creates a URL to start an image builder streaming session.
*/
createImageBuilderStreamingURL(params: AppStream.Types.CreateImageBuilderStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateImageBuilderStreamingURLResult, AWSError>;
/**
* Creates a URL to start an image builder streaming session.
*/
createImageBuilderStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateImageBuilderStreamingURLResult, AWSError>;
/**
* Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
*/
createStack(params: AppStream.Types.CreateStackRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request<AppStream.Types.CreateStackResult, AWSError>;
/**
* Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
*/
createStack(callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request<AppStream.Types.CreateStackResult, AWSError>;
/**
* Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
*/
createStreamingURL(params: AppStream.Types.CreateStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request<AppStream.Types.CreateStreamingURLResult, AWSError>;
/**
* Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
*/
createStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request<AppStream.Types.CreateStreamingURLResult, AWSError>;
/**
* Creates a usage report subscription. Usage reports are generated daily.
*/
createUsageReportSubscription(params: AppStream.Types.CreateUsageReportSubscriptionRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUsageReportSubscriptionResult) => void): Request<AppStream.Types.CreateUsageReportSubscriptionResult, AWSError>;
/**
* Creates a usage report subscription. Usage reports are generated daily.
*/
createUsageReportSubscription(callback?: (err: AWSError, data: AppStream.Types.CreateUsageReportSubscriptionResult) => void): Request<AppStream.Types.CreateUsageReportSubscriptionResult, AWSError>;
/**
* Creates a new user in the user pool.
*/
createUser(params: AppStream.Types.CreateUserRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request<AppStream.Types.CreateUserResult, AWSError>;
/**
* Creates a new user in the user pool.
*/
createUser(callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request<AppStream.Types.CreateUserResult, AWSError>;
/**
* Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
*/
deleteDirectoryConfig(params: AppStream.Types.DeleteDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request<AppStream.Types.DeleteDirectoryConfigResult, AWSError>;
/**
* Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
*/
deleteDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request<AppStream.Types.DeleteDirectoryConfigResult, AWSError>;
/**
* Deletes the specified fleet.
*/
deleteFleet(params: AppStream.Types.DeleteFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request<AppStream.Types.DeleteFleetResult, AWSError>;
/**
* Deletes the specified fleet.
*/
deleteFleet(callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request<AppStream.Types.DeleteFleetResult, AWSError>;
/**
* Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
*/
deleteImage(params: AppStream.Types.DeleteImageRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request<AppStream.Types.DeleteImageResult, AWSError>;
/**
* Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
*/
deleteImage(callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request<AppStream.Types.DeleteImageResult, AWSError>;
/**
* Deletes the specified image builder and releases the capacity.
*/
deleteImageBuilder(params: AppStream.Types.DeleteImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request<AppStream.Types.DeleteImageBuilderResult, AWSError>;
/**
* Deletes the specified image builder and releases the capacity.
*/
deleteImageBuilder(callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request<AppStream.Types.DeleteImageBuilderResult, AWSError>;
/**
* Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
*/
deleteImagePermissions(params: AppStream.Types.DeleteImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request<AppStream.Types.DeleteImagePermissionsResult, AWSError>;
/**
* Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
*/
deleteImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request<AppStream.Types.DeleteImagePermissionsResult, AWSError>;
/**
* Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
*/
deleteStack(params: AppStream.Types.DeleteStackRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request<AppStream.Types.DeleteStackResult, AWSError>;
/**
* Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
*/
deleteStack(callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request<AppStream.Types.DeleteStackResult, AWSError>;
/**
* Disables usage report generation.
*/
deleteUsageReportSubscription(params: AppStream.Types.DeleteUsageReportSubscriptionRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteUsageReportSubscriptionResult) => void): Request<AppStream.Types.DeleteUsageReportSubscriptionResult, AWSError>;
/**
* Disables usage report generation.
*/
deleteUsageReportSubscription(callback?: (err: AWSError, data: AppStream.Types.DeleteUsageReportSubscriptionResult) => void): Request<AppStream.Types.DeleteUsageReportSubscriptionResult, AWSError>;
/**
* Deletes a user from the user pool.
*/
deleteUser(params: AppStream.Types.DeleteUserRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request<AppStream.Types.DeleteUserResult, AWSError>;
/**
* Deletes a user from the user pool.
*/
deleteUser(callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request<AppStream.Types.DeleteUserResult, AWSError>;
/**
* Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
*/
describeDirectoryConfigs(params: AppStream.Types.DescribeDirectoryConfigsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request<AppStream.Types.DescribeDirectoryConfigsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
*/
describeDirectoryConfigs(callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request<AppStream.Types.DescribeDirectoryConfigsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
*/
describeFleets(params: AppStream.Types.DescribeFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
*/
describeFleets(callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
*/
describeImageBuilders(params: AppStream.Types.DescribeImageBuildersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request<AppStream.Types.DescribeImageBuildersResult, AWSError>;
/**
* Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
*/
describeImageBuilders(callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request<AppStream.Types.DescribeImageBuildersResult, AWSError>;
/**
* Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
*/
describeImagePermissions(params: AppStream.Types.DescribeImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request<AppStream.Types.DescribeImagePermissionsResult, AWSError>;
/**
* Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
*/
describeImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request<AppStream.Types.DescribeImagePermissionsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
*/
describeImages(params: AppStream.Types.DescribeImagesRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request<AppStream.Types.DescribeImagesResult, AWSError>;
/**
* Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
*/
describeImages(callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request<AppStream.Types.DescribeImagesResult, AWSError>;
/**
* Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
*/
describeSessions(params: AppStream.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request<AppStream.Types.DescribeSessionsResult, AWSError>;
/**
* Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
*/
describeSessions(callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request<AppStream.Types.DescribeSessionsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
*/
describeStacks(params: AppStream.Types.DescribeStacksRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request<AppStream.Types.DescribeStacksResult, AWSError>;
/**
* Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
*/
describeStacks(callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request<AppStream.Types.DescribeStacksResult, AWSError>;
/**
* Retrieves a list that describes one or more usage report subscriptions.
*/
describeUsageReportSubscriptions(params: AppStream.Types.DescribeUsageReportSubscriptionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUsageReportSubscriptionsResult) => void): Request<AppStream.Types.DescribeUsageReportSubscriptionsResult, AWSError>;
/**
* Retrieves a list that describes one or more usage report subscriptions.
*/
describeUsageReportSubscriptions(callback?: (err: AWSError, data: AppStream.Types.DescribeUsageReportSubscriptionsResult) => void): Request<AppStream.Types.DescribeUsageReportSubscriptionsResult, AWSError>;
/**
* Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user
*/
describeUserStackAssociations(params: AppStream.Types.DescribeUserStackAssociationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request<AppStream.Types.DescribeUserStackAssociationsResult, AWSError>;
/**
* Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user
*/
describeUserStackAssociations(callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request<AppStream.Types.DescribeUserStackAssociationsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified users in the user pool.
*/
describeUsers(params: AppStream.Types.DescribeUsersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request<AppStream.Types.DescribeUsersResult, AWSError>;
/**
* Retrieves a list that describes one or more specified users in the user pool.
*/
describeUsers(callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request<AppStream.Types.DescribeUsersResult, AWSError>;
/**
* Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
*/
disableUser(params: AppStream.Types.DisableUserRequest, callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request<AppStream.Types.DisableUserResult, AWSError>;
/**
* Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
*/
disableUser(callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request<AppStream.Types.DisableUserResult, AWSError>;
/**
* Disassociates the specified fleet from the specified stack.
*/
disassociateFleet(params: AppStream.Types.DisassociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request<AppStream.Types.DisassociateFleetResult, AWSError>;
/**
* Disassociates the specified fleet from the specified stack.
*/
disassociateFleet(callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request<AppStream.Types.DisassociateFleetResult, AWSError>;
/**
* Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
*/
enableUser(params: AppStream.Types.EnableUserRequest, callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request<AppStream.Types.EnableUserResult, AWSError>;
/**
* Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
*/
enableUser(callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request<AppStream.Types.EnableUserResult, AWSError>;
/**
* Immediately stops the specified streaming session.
*/
expireSession(params: AppStream.Types.ExpireSessionRequest, callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request<AppStream.Types.ExpireSessionResult, AWSError>;
/**
* Immediately stops the specified streaming session.
*/
expireSession(callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request<AppStream.Types.ExpireSessionResult, AWSError>;
/**
* Retrieves the name of the fleet that is associated with the specified stack.
*/
listAssociatedFleets(params: AppStream.Types.ListAssociatedFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request<AppStream.Types.ListAssociatedFleetsResult, AWSError>;
/**
* Retrieves the name of the fleet that is associated with the specified stack.
*/
listAssociatedFleets(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request<AppStream.Types.ListAssociatedFleetsResult, AWSError>;
/**
* Retrieves the name of the stack with which the specified fleet is associated.
*/
listAssociatedStacks(params: AppStream.Types.ListAssociatedStacksRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request<AppStream.Types.ListAssociatedStacksResult, AWSError>;
/**
* Retrieves the name of the stack with which the specified fleet is associated.
*/
listAssociatedStacks(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request<AppStream.Types.ListAssociatedStacksResult, AWSError>;
/**
* Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
listTagsForResource(params: AppStream.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request<AppStream.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
listTagsForResource(callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request<AppStream.Types.ListTagsForResourceResponse, AWSError>;
/**
* Starts the specified fleet.
*/
startFleet(params: AppStream.Types.StartFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request<AppStream.Types.StartFleetResult, AWSError>;
/**
* Starts the specified fleet.
*/
startFleet(callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request<AppStream.Types.StartFleetResult, AWSError>;
/**
* Starts the specified image builder.
*/
startImageBuilder(params: AppStream.Types.StartImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request<AppStream.Types.StartImageBuilderResult, AWSError>;
/**
* Starts the specified image builder.
*/
startImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request<AppStream.Types.StartImageBuilderResult, AWSError>;
/**
* Stops the specified fleet.
*/
stopFleet(params: AppStream.Types.StopFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request<AppStream.Types.StopFleetResult, AWSError>;
/**
* Stops the specified fleet.
*/
stopFleet(callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request<AppStream.Types.StopFleetResult, AWSError>;
/**
* Stops the specified image builder.
*/
stopImageBuilder(params: AppStream.Types.StopImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request<AppStream.Types.StopImageBuilderResult, AWSError>;
/**
* Stops the specified image builder.
*/
stopImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request<AppStream.Types.StopImageBuilderResult, AWSError>;
/**
* Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
tagResource(params: AppStream.Types.TagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request<AppStream.Types.TagResourceResponse, AWSError>;
/**
* Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
tagResource(callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request<AppStream.Types.TagResourceResponse, AWSError>;
/**
* Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
untagResource(params: AppStream.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request<AppStream.Types.UntagResourceResponse, AWSError>;
/**
* Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
untagResource(callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request<AppStream.Types.UntagResourceResponse, AWSError>;
/**
* Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
*/
updateDirectoryConfig(params: AppStream.Types.UpdateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request<AppStream.Types.UpdateDirectoryConfigResult, AWSError>;
/**
* Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
*/
updateDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request<AppStream.Types.UpdateDirectoryConfigResult, AWSError>;
/**
* Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.
*/
updateFleet(params: AppStream.Types.UpdateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request<AppStream.Types.UpdateFleetResult, AWSError>;
/**
* Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.
*/
updateFleet(callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request<AppStream.Types.UpdateFleetResult, AWSError>;
/**
* Adds or updates permissions for the specified private image.
*/
updateImagePermissions(params: AppStream.Types.UpdateImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request<AppStream.Types.UpdateImagePermissionsResult, AWSError>;
/**
* Adds or updates permissions for the specified private image.
*/
updateImagePermissions(callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request<AppStream.Types.UpdateImagePermissionsResult, AWSError>;
/**
* Updates the specified fields for the specified stack.
*/
updateStack(params: AppStream.Types.UpdateStackRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request<AppStream.Types.UpdateStackResult, AWSError>;
/**
* Updates the specified fields for the specified stack.
*/
updateStack(callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request<AppStream.Types.UpdateStackResult, AWSError>;
/**
* Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
*/
waitFor(state: "fleetStarted", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
/**
* Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
*/
waitFor(state: "fleetStarted", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
/**
* Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
*/
waitFor(state: "fleetStopped", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
/**
* Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
*/
waitFor(state: "fleetStopped", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
}
declare namespace AppStream {
export interface AccessEndpoint {
/**
* The type of interface endpoint.
*/
EndpointType: AccessEndpointType;
/**
* The identifier (ID) of the VPC in which the interface endpoint is used.
*/
VpceId?: String;
}
export type AccessEndpointList = AccessEndpoint[];
export type AccessEndpointType = "STREAMING"|string;
export type AccountName = string;
export type AccountPassword = string;
export type Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"|"CLIPBOARD_COPY_TO_LOCAL_DEVICE"|"FILE_UPLOAD"|"FILE_DOWNLOAD"|"PRINTING_TO_LOCAL_DEVICE"|string;
export interface Application {
/**
* The name of the application.
*/
Name?: String;
/**
* The application name to display.
*/
DisplayName?: String;
/**
* The URL for the application icon. This URL might be time-limited.
*/
IconURL?: String;
/**
* The path to the application executable in the instance.
*/
LaunchPath?: String;
/**
* The arguments that are passed to the application at launch.
*/
LaunchParameters?: String;
/**
* If there is a problem, the application can be disabled after image creation.
*/
Enabled?: Boolean;
/**
* Additional attributes that describe the application.
*/
Metadata?: Metadata;
}
export interface ApplicationSettings {
/**
* Enables or disables persistent application settings for users during their streaming sessions.
*/
Enabled: Boolean;
/**
* The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
*/
SettingsGroup?: SettingsGroup;
}
export interface ApplicationSettingsResponse {
/**
* Specifies whether persistent application settings are enabled for users during their streaming sessions.
*/
Enabled?: Boolean;
/**
* The path prefix for the S3 bucket where users’ persistent application settings are stored.
*/
SettingsGroup?: SettingsGroup;
/**
* The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
*/
S3BucketName?: String;
}
export type Applications = Application[];
export type AppstreamAgentVersion = string;
export type Arn = string;
export type ArnList = Arn[];
export interface AssociateFleetRequest {
/**
* The name of the fleet.
*/
FleetName: String;
/**
* The name of the stack.
*/
StackName: String;
}
export interface AssociateFleetResult {
}
export type AuthenticationType = "API"|"SAML"|"USERPOOL"|string;
export type AwsAccountId = string;
export type AwsAccountIdList = AwsAccountId[];
export interface BatchAssociateUserStackRequest {
/**
* The list of UserStackAssociation objects.
*/
UserStackAssociations: UserStackAssociationList;
}
export interface BatchAssociateUserStackResult {
/**
* The list of UserStackAssociationError objects.
*/
errors?: UserStackAssociationErrorList;
}
export interface BatchDisassociateUserStackRequest {
/**
* The list of UserStackAssociation objects.
*/
UserStackAssociations: UserStackAssociationList;
}
export interface BatchDisassociateUserStackResult {
/**
* The list of UserStackAssociationError objects.
*/
errors?: UserStackAssociationErrorList;
}
export type Boolean = boolean;
export type BooleanObject = boolean;
export interface ComputeCapacity {
/**
* The desired number of streaming instances.
*/
DesiredInstances: Integer;
}
export interface ComputeCapacityStatus {
/**
* The desired number of streaming instances.
*/
Desired: Integer;
/**
* The total number of simultaneous streaming instances that are running.
*/
Running?: Integer;
/**
* The number of instances in use for streaming.
*/
InUse?: Integer;
/**
* The number of currently available instances that can be used to stream sessions.
*/
Available?: Integer;
}
export interface CopyImageRequest {
/**
* The name of the image to copy.
*/
SourceImageName: Name;
/**
* The name that the image will have when it is copied to the destination.
*/
DestinationImageName: Name;
/**
* The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
*/
DestinationRegion: RegionName;
/**
* The description that the image will have when it is copied to the destination.
*/
DestinationImageDescription?: Description;
}
export interface CopyImageResponse {
/**
* The name of the destination image.
*/
DestinationImageName?: Name;
}
export interface CreateDirectoryConfigRequest {
/**
* The fully qualified name of the directory (for example, corp.example.com).
*/
DirectoryName: DirectoryName;
/**
* The distinguished names of the organizational units for computer accounts.
*/
OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList;
/**
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*/
ServiceAccountCredentials?: ServiceAccountCredentials;
}
export interface CreateDirectoryConfigResult {
/**
* Information about the directory configuration.
*/
DirectoryConfig?: DirectoryConfig;
}
export interface CreateFleetRequest {
/**
* A unique name for the fleet.
*/
Name: Name;
/**
* The name of the image used to create the fleet.
*/
ImageName?: String;
/**
* The ARN of the public, private, or shared image to use.
*/
ImageArn?: Arn;
/**
* The instance type to use when launching fleet instances. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
*/
InstanceType: String;
/**
* The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*/
FleetType?: FleetType;
/**
* The desired capacity for the fleet.
*/
ComputeCapacity: ComputeCapacity;
/**
* The VPC configuration for the fleet.
*/
VpcConfig?: VpcConfig;
/**
* The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 360000.
*/
MaxUserDurationInSeconds?: Integer;
/**
* The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
*/
DisconnectTimeoutInSeconds?: Integer;
/**
* The description to display.
*/
Description?: Description;
/**
* The fleet name to display.
*/
DisplayName?: DisplayName;
/**
* Enables or disables default internet access for the fleet.
*/
EnableDefaultInternetAccess?: BooleanObject;
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*/
DomainJoinInfo?: DomainJoinInfo;
/**
* The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
Tags?: Tags;
/**
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*/
IdleDisconnectTimeoutInSeconds?: Integer;
/**
* The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
*/
IamRoleArn?: Arn;
/**
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
*/
StreamView?: StreamView;
}
export interface CreateFleetResult {
/**
* Information about the fleet.
*/
Fleet?: Fleet;
}
export interface CreateImageBuilderRequest {
/**
* A unique name for the image builder.
*/
Name: Name;
/**
* The name of the image used to create the image builder.
*/
ImageName?: String;
/**
* The ARN of the public, private, or shared image to use.
*/
ImageArn?: Arn;
/**
* The instance type to use when launching the image builder. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
*/
InstanceType: String;
/**
* The description to display.
*/
Description?: Description;
/**
* The image builder name to display.
*/
DisplayName?: DisplayName;
/**
* The VPC configuration for the image builder. You can specify only one subnet.
*/
VpcConfig?: VpcConfig;
/**
* The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
*/
IamRoleArn?: Arn;
/**
* Enables or disables default internet access for the image builder.
*/
EnableDefaultInternetAccess?: BooleanObject;
/**
* The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
*/
DomainJoinInfo?: DomainJoinInfo;
/**
* The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
*/
AppstreamAgentVersion?: AppstreamAgentVersion;
/**
* The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ If you do not specify a value, the value is set to an empty string. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
Tags?: Tags;
/**
* The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
*/
AccessEndpoints?: AccessEndpointList;
}
export interface CreateImageBuilderResult {
/**
* Information about the image builder.
*/
ImageBuilder?: ImageBuilder;
}
export interface CreateImageBuilderStreamingURLRequest {
/**
* The name of the image builder.
*/
Name: String;
/**
* The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
*/
Validity?: Long;
}
export interface CreateImageBuilderStreamingURLResult {
/**
* The URL to start the AppStream 2.0 streaming session.
*/
StreamingURL?: String;
/**
* The elapsed time, in seconds after the Unix epoch, when this URL expires.
*/
Expires?: Timestamp;
}
export interface CreateStackRequest {
/**
* The name of the stack.
*/
Name: Name;
/**
* The description to display.
*/
Description?: Description;
/**
* The stack name to display.
*/
DisplayName?: DisplayName;
/**
* The storage connectors to enable.
*/
StorageConnectors?: StorageConnectorList;
/**
* The URL that users are redirected to after their streaming session ends.
*/
RedirectURL?: RedirectURL;
/**
* The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*/
FeedbackURL?: FeedbackURL;
/**
* The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
*/
UserSettings?: UserSettingList;
/**
* The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
*/
ApplicationSettings?: ApplicationSettings;
/**
* The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
*/
Tags?: Tags;
/**
* The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
*/
AccessEndpoints?: AccessEndpointList;
/**
* The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
*/
EmbedHostDomains?: EmbedHostDomains;
}
export interface CreateStackResult {
/**
* Information about the stack.
*/
Stack?: Stack;
}
export interface CreateStreamingURLRequest {
/**
* The name of the stack.
*/
StackName: String;
/**
* The name of the fleet.
*/
FleetName: String;
/**
* The identifier of the user.
*/
UserId: StreamingUrlUserId;
/**
* The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.
*/
ApplicationId?: String;
/**
* The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
*/
Validity?: Long;
/**
* The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
*/
SessionContext?: String;
}
export interface CreateStreamingURLResult {
/**
* The URL to start the AppStream 2.0 streaming session.
*/
StreamingURL?: String;
/**
* The elapsed time, in seconds after the Unix epoch, when this URL expires.
*/
Expires?: Timestamp;
}
export interface CreateUsageReportSubscriptionRequest {
}
export interface CreateUsageReportSubscriptionResult {
/**
* The Amazon S3 bucket where generated reports are stored. If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
*/
S3BucketName?: String;
/**
* The schedule for generating usage reports.
*/
Schedule?: UsageReportSchedule;
}
export interface CreateUserRequest {
/**
* The email address of the user. Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
*/
UserName: Username;
/**
* The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
*/
MessageAction?: MessageAction;
/**
* The first name, or given name, of the user.
*/
FirstName?: UserAttributeValue;
/**
* The last name, or surname, of the user.
*/
LastName?: UserAttributeValue;
/**
* The authentication type for the user. You must specify USERPOOL.
*/
AuthenticationType: AuthenticationType;
}
export interface CreateUserResult {
}
export interface DeleteDirectoryConfigRequest {
/**
* The name of the directory configuration.
*/
DirectoryName: DirectoryName;
}
export interface DeleteDirectoryConfigResult {
}
export interface DeleteFleetRequest {
/**
* The name of the fleet.
*/
Name: String;
}
export interface DeleteFleetResult {
}
export interface DeleteImageBuilderRequest {
/**
* The name of the image builder.
*/
Name: Name;
}
export interface DeleteImageBuilderResult {
/**
* Information about the image builder.
*/
ImageBuilder?: ImageBuilder;
}
export interface DeleteImagePermissionsRequest {
/**
* The name of the private image.
*/
Name: Name;
/**
* The 12-digit identifier of the AWS account for which to delete image permissions.
*/
SharedAccountId: AwsAccountId;
}
export interface DeleteImagePermissionsResult {
}
export interface DeleteImageRequest {
/**
* The name of the image.
*/
Name: Name;
}
export interface DeleteImageResult {
/**
* Information about the image.
*/
Image?: Image;
}
export interface DeleteStackRequest {
/**
* The name of the stack.
*/
Name: String;
}
export interface DeleteStackResult {
}
export interface DeleteUsageReportSubscriptionRequest {
}
export interface DeleteUsageReportSubscriptionResult {
}
export interface DeleteUserRequest {
/**
* The email address of the user. Users' email addresses are case-sensitive.
*/
UserName: Username;
/**
* The authentication type for the user. You must specify USERPOOL.
*/
AuthenticationType: AuthenticationType;
}
export interface DeleteUserResult {
}
export interface DescribeDirectoryConfigsRequest {
/**
* The directory names.
*/
DirectoryNames?: DirectoryNameList;
/**
* The maximum size of each page of results.
*/
MaxResults?: Integer;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeDirectoryConfigsResult {
/**
* Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
*/
DirectoryConfigs?: DirectoryConfigList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeFleetsRequest {
/**
* The names of the fleets to describe.
*/
Names?: StringList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeFleetsResult {
/**
* Information about the fleets.
*/
Fleets?: FleetList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeImageBuildersRequest {
/**
* The names of the image builders to describe.
*/
Names?: StringList;
/**
* The maximum size of each page of results.
*/
MaxResults?: Integer;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeImageBuildersResult {
/**
* Information about the image builders.
*/
ImageBuilders?: ImageBuilderList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeImagePermissionsRequest {
/**
* The name of the private image for which to describe permissions. The image must be one that you own.
*/
Name: Name;
/**
* The maximum size of each page of results.
*/
MaxResults?: MaxResults;
/**
* The 12-digit identifier of one or more AWS accounts with which the image is shared.
*/
SharedAwsAccountIds?: AwsAccountIdList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeImagePermissionsResult {
/**
* The name of the private image.
*/
Name?: Name;
/**
* The permissions for a private image that you own.
*/
SharedImagePermissionsList?: SharedImagePermissionsList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export type DescribeImagesMaxResults = number;
export interface DescribeImagesRequest {
/**
* The names of the public or private images to describe.
*/
Names?: StringList;
/**
* The ARNs of the public, private, and shared images to describe.
*/
Arns?: ArnList;
/**
* The type of image (public, private, or shared) to describe.
*/
Type?: VisibilityType;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
/**
* The maximum size of each page of results.
*/
MaxResults?: DescribeImagesMaxResults;
}
export interface DescribeImagesResult {
/**
* Information about the images.
*/
Images?: ImageList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeSessionsRequest {
/**
* The name of the stack. This value is case-sensitive.
*/
StackName: String;
/**
* The name of the fleet. This value is case-sensitive.
*/
FleetName: String;
/**
* The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
*/
UserId?: UserId;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
/**
* The size of each page of results. The default value is 20 and the maximum value is 50.
*/
Limit?: Integer;
/**
* The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
*/
AuthenticationType?: AuthenticationType;
}
export interface DescribeSessionsResult {
/**
* Information about the streaming sessions.
*/
Sessions?: SessionList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeStacksRequest {
/**
* The names of the stacks to describe.
*/
Names?: StringList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeStacksResult {
/**
* Information about the stacks.
*/
Stacks?: StackList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeUsageReportSubscriptionsRequest {
/**
* The maximum size of each page of results.
*/
MaxResults?: Integer;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeUsageReportSubscriptionsResult {
/**
* Information about the usage report subscription.
*/
UsageReportSubscriptions?: UsageReportSubscriptionList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeUserStackAssociationsRequest {
/**
* The name of the stack that is associated with the user.
*/
StackName?: String;
/**
* The email address of the user who is associated with the stack. Users' email addresses are case-sensitive.
*/
UserName?: Username;
/**
* The authentication type for the user who is associated with the stack. You must specify USERPOOL.
*/
AuthenticationType?: AuthenticationType;
/**
* The maximum size of each page of results.
*/
MaxResults?: MaxResults;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeUserStackAssociationsResult {
/**
* The UserStackAssociation objects.
*/
UserStackAssociations?: UserStackAssociationList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface DescribeUsersRequest {
/**
* The authentication type for the users in the user pool to describe. You must specify USERPOOL.
*/
AuthenticationType: AuthenticationType;
/**
* The maximum size of each page of results.
*/
MaxResults?: Integer;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface DescribeUsersResult {
/**
* Information about users in the user pool.
*/
Users?: UserList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export type Description = string;
export interface DirectoryConfig {
/**
* The fully qualified name of the directory (for example, corp.example.com).
*/
DirectoryName: DirectoryName;
/**
* The distinguished names of the organizational units for computer accounts.
*/
OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList;
/**
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*/
ServiceAccountCredentials?: ServiceAccountCredentials;
/**
* The time the directory configuration was created.
*/
CreatedTime?: Timestamp;
}
export type DirectoryConfigList = DirectoryConfig[];
export type DirectoryName = string;
export type DirectoryNameList = DirectoryName[];
export interface DisableUserRequest {
/**
* The email address of the user. Users' email addresses are case-sensitive.
*/
UserName: Username;
/**
* The authentication type for the user. You must specify USERPOOL.
*/
AuthenticationType: AuthenticationType;
}
export interface DisableUserResult {
}
export interface DisassociateFleetRequest {
/**
* The name of the fleet.
*/
FleetName: String;
/**
* The name of the stack.
*/
StackName: String;
}
export interface DisassociateFleetResult {
}
export type DisplayName = string;
export type Domain = string;
export interface DomainJoinInfo {
/**
* The fully qualified name of the directory (for example, corp.example.com).
*/
DirectoryName?: DirectoryName;
/**
* The distinguished name of the organizational unit for computer accounts.
*/
OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName;
}
export type DomainList = Domain[];
export type EmbedHostDomain = string;
export type EmbedHostDomains = EmbedHostDomain[];
export interface EnableUserRequest {
/**
* The email address of the user. Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
*/
UserName: Username;
/**
* The authentication type for the user. You must specify USERPOOL.
*/
AuthenticationType: AuthenticationType;
}
export interface EnableUserResult {
}
export interface ExpireSessionRequest {
/**
* The identifier of the streaming session.
*/
SessionId: String;
}
export interface ExpireSessionResult {
}
export type FeedbackURL = string;
export interface Fleet {
/**
* The Amazon Resource Name (ARN) for the fleet.
*/
Arn: Arn;
/**
* The name of the fleet.
*/
Name: String;
/**
* The fleet name to display.
*/
DisplayName?: String;
/**
* The description to display.
*/
Description?: String;
/**
* The name of the image used to create the fleet.
*/
ImageName?: String;
/**
* The ARN for the public, private, or shared image.
*/
ImageArn?: Arn;
/**
* The instance type to use when launching fleet instances. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
*/
InstanceType: String;
/**
* The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
*/
FleetType?: FleetType;
/**
* The capacity status for the fleet.
*/
ComputeCapacityStatus: ComputeCapacityStatus;
/**
* The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 360000.
*/
MaxUserDurationInSeconds?: Integer;
/**
* The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
*/
DisconnectTimeoutInSeconds?: Integer;
/**
* The current state for the fleet.
*/
State: FleetState;
/**
* The VPC configuration for the fleet.
*/
VpcConfig?: VpcConfig;
/**
* The time the fleet was created.
*/
CreatedTime?: Timestamp;
/**
* The fleet errors.
*/
FleetErrors?: FleetErrors;
/**
* Indicates whether default internet access is enabled for the fleet.
*/
EnableDefaultInternetAccess?: BooleanObject;
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*/
DomainJoinInfo?: DomainJoinInfo;
/**
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*/
IdleDisconnectTimeoutInSeconds?: Integer;
/**
* The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
*/
IamRoleArn?: Arn;
/**
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
*/
StreamView?: StreamView;
}
export type FleetAttribute = "VPC_CONFIGURATION"|"VPC_CONFIGURATION_SECURITY_GROUP_IDS"|"DOMAIN_JOIN_INFO"|"IAM_ROLE_ARN"|string;
export type FleetAttributes = FleetAttribute[];
export interface FleetError {
/**
* The error code.
*/
ErrorCode?: FleetErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
}
export type FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"|"NETWORK_INTERFACE_LIMIT_EXCEEDED"|"INTERNAL_SERVICE_ERROR"|"IAM_SERVICE_ROLE_IS_MISSING"|"MACHINE_ROLE_IS_MISSING"|"STS_DISABLED_IN_REGION"|"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"|"SUBNET_NOT_FOUND"|"IMAGE_NOT_FOUND"|"INVALID_SUBNET_CONFIGURATION"|"SECURITY_GROUPS_NOT_FOUND"|"IGW_NOT_ATTACHED"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"|"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"|"DOMAIN_JOIN_ERROR_ACCESS_DENIED"|"DOMAIN_JOIN_ERROR_LOGON_FAILURE"|"DOMAIN_JOIN_ERROR_INVALID_PARAMETER"|"DOMAIN_JOIN_ERROR_MORE_DATA"|"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"|"DOMAIN_JOIN_ERROR_NOT_SUPPORTED"|"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"|"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"|"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"|"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"|"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"|string;
export type FleetErrors = FleetError[];
export type FleetList = Fleet[];
export type FleetState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|string;
export type FleetType = "ALWAYS_ON"|"ON_DEMAND"|string;
export interface Image {
/**
* The name of the image.
*/
Name: String;
/**
* The ARN of the image.
*/
Arn?: Arn;
/**
* The ARN of the image from which this image was created.
*/
BaseImageArn?: Arn;
/**
* The image name to display.
*/
DisplayName?: String;
/**
* The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
*/
State?: ImageState;
/**
* Indicates whether the image is public or private.
*/
Visibility?: VisibilityType;
/**
* Indicates whether an image builder can be launched from this image.
*/
ImageBuilderSupported?: Boolean;
/**
* The name of the image builder that was used to create the private image. If the image is shared, this value is null.
*/
ImageBuilderName?: String;
/**
* The operating system platform of the image.
*/
Platform?: PlatformType;
/**
* The description to display.
*/
Description?: String;
/**
* The reason why the last state change occurred.
*/
StateChangeReason?: ImageStateChangeReason;
/**
* The applications associated with the image.
*/
Applications?: Applications;
/**
* The time the image was created.
*/
CreatedTime?: Timestamp;
/**
* The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
*/
PublicBaseImageReleasedDate?: Timestamp;
/**
* The version of the AppStream 2.0 agent to use for instances that are launched from this image.
*/
AppstreamAgentVersion?: AppstreamAgentVersion;
/**
* The permissions to provide to the destination AWS account for the specified image.
*/
ImagePermissions?: ImagePermissions;
}
export interface ImageBuilder {
/**
* The name of the image builder.
*/
Name: String;
/**
* The ARN for the image builder.
*/
Arn?: Arn;
/**
* The ARN of the image from which this builder was created.
*/
ImageArn?: Arn;
/**
* The description to display.
*/
Description?: String;
/**
* The image builder name to display.
*/
DisplayName?: String;
/**
* The VPC configuration of the image builder.
*/
VpcConfig?: VpcConfig;
/**
* The instance type for the image builder. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
*/
InstanceType?: String;
/**
* The operating system platform of the image builder.
*/
Platform?: PlatformType;
/**
* The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
*/
IamRoleArn?: Arn;
/**
* The state of the image builder.
*/
State?: ImageBuilderState;
/**
* The reason why the last state change occurred.
*/
StateChangeReason?: ImageBuilderStateChangeReason;
/**
* The time stamp when the image builder was created.
*/
CreatedTime?: Timestamp;
/**
* Enables or disables default internet access for the image builder.
*/
EnableDefaultInternetAccess?: BooleanObject;
/**
* The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
*/
DomainJoinInfo?: DomainJoinInfo;
NetworkAccessConfiguration?: NetworkAccessConfiguration;
/**
* The image builder errors.
*/
ImageBuilderErrors?: ResourceErrors;
/**
* The version of the AppStream 2.0 agent that is currently being used by the image builder.
*/
AppstreamAgentVersion?: AppstreamAgentVersion;
/**
* The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
*/
AccessEndpoints?: AccessEndpointList;
}
export type ImageBuilderList = ImageBuilder[];
export type ImageBuilderState = "PENDING"|"UPDATING_AGENT"|"RUNNING"|"STOPPING"|"STOPPED"|"REBOOTING"|"SNAPSHOTTING"|"DELETING"|"FAILED"|string;
export interface ImageBuilderStateChangeReason {
/**
* The state change reason code.
*/
Code?: ImageBuilderStateChangeReasonCode;
/**
* The state change reason message.
*/
Message?: String;
}
export type ImageBuilderStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_UNAVAILABLE"|string;
export type ImageList = Image[];
export interface ImagePermissions {
/**
* Indicates whether the image can be used for a fleet.
*/
allowFleet?: BooleanObject;
/**
* Indicates whether the image can be used for an image builder.
*/
allowImageBuilder?: BooleanObject;
}
export type ImageState = "PENDING"|"AVAILABLE"|"FAILED"|"COPYING"|"DELETING"|string;
export interface ImageStateChangeReason {
/**
* The state change reason code.
*/
Code?: ImageStateChangeReasonCode;
/**
* The state change reason message.
*/
Message?: String;
}
export type ImageStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_BUILDER_NOT_AVAILABLE"|"IMAGE_COPY_FAILURE"|string;
export type Integer = number;
export interface LastReportGenerationExecutionError {
/**
* The error code for the error that is returned when a usage report can't be generated.
*/
ErrorCode?: UsageReportExecutionErrorCode;
/**
* The error message for the error that is returned when a usage report can't be generated.
*/
ErrorMessage?: String;
}
export type LastReportGenerationExecutionErrors = LastReportGenerationExecutionError[];
export interface ListAssociatedFleetsRequest {
/**
* The name of the stack.
*/
StackName: String;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface ListAssociatedFleetsResult {
/**
* The name of the fleet.
*/
Names?: StringList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface ListAssociatedStacksRequest {
/**
* The name of the fleet.
*/
FleetName: String;
/**
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: String;
}
export interface ListAssociatedStacksResult {
/**
* The name of the stack.
*/
Names?: StringList;
/**
* The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: String;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The information about the tags.
*/
Tags?: Tags;
}
export type Long = number;
export type MaxResults = number;
export type MessageAction = "SUPPRESS"|"RESEND"|string;
export type Metadata = {[key: string]: String};
export type Name = string;
export interface NetworkAccessConfiguration {
/**
* The private IP address of the elastic network interface that is attached to instances in your VPC.
*/
EniPrivateIpAddress?: String;
/**
* The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
*/
EniId?: String;
}
export type OrganizationalUnitDistinguishedName = string;
export type OrganizationalUnitDistinguishedNamesList = OrganizationalUnitDistinguishedName[];
export type Permission = "ENABLED"|"DISABLED"|string;
export type PlatformType = "WINDOWS"|"WINDOWS_SERVER_2016"|"WINDOWS_SERVER_2019"|string;
export type RedirectURL = string;
export type RegionName = string;
export interface ResourceError {
/**
* The error code.
*/
ErrorCode?: FleetErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
/**
* The time the error occurred.
*/
ErrorTimestamp?: Timestamp;
}
export type ResourceErrors = ResourceError[];
export type ResourceIdentifier = string;
export type SecurityGroupIdList = String[];
export interface ServiceAccountCredentials {
/**
* The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
*/
AccountName: AccountName;
/**
* The password for the account.
*/
AccountPassword: AccountPassword;
}
export interface Session {
/**
* The identifier of the streaming session.
*/
Id: String;
/**
* The identifier of the user for whom the session was created.
*/
UserId: UserId;
/**
* The name of the stack for the streaming session.
*/
StackName: String;
/**
* The name of the fleet for the streaming session.
*/
FleetName: String;
/**
* The current state of the streaming session.
*/
State: SessionState;
/**
* Specifies whether a user is connected to the streaming session.
*/
ConnectionState?: SessionConnectionState;
/**
* The time when a streaming instance is dedicated for the user.
*/
StartTime?: Timestamp;
/**
* The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
*/
MaxExpirationTime?: Timestamp;
/**
* The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
*/
AuthenticationType?: AuthenticationType;
/**
* The network details for the streaming session.
*/
NetworkAccessConfiguration?: NetworkAccessConfiguration;
}
export type SessionConnectionState = "CONNECTED"|"NOT_CONNECTED"|string;
export type SessionList = Session[];
export type SessionState = "ACTIVE"|"PENDING"|"EXPIRED"|string;
export type SettingsGroup = string;
export interface SharedImagePermissions {
/**
* The 12-digit identifier of the AWS account with which the image is shared.
*/
sharedAccountId: AwsAccountId;
/**
* Describes the permissions for a shared image.
*/
imagePermissions: ImagePermissions;
}
export type SharedImagePermissionsList = SharedImagePermissions[];
export interface Stack {
/**
* The ARN of the stack.
*/
Arn?: Arn;
/**
* The name of the stack.
*/
Name: String;
/**
* The description to display.
*/
Description?: String;
/**
* The stack name to display.
*/
DisplayName?: String;
/**
* The time the stack was created.
*/
CreatedTime?: Timestamp;
/**
* The storage connectors to enable.
*/
StorageConnectors?: StorageConnectorList;
/**
* The URL that users are redirected to after their streaming session ends.
*/
RedirectURL?: RedirectURL;
/**
* The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*/
FeedbackURL?: FeedbackURL;
/**
* The errors for the stack.
*/
StackErrors?: StackErrors;
/**
* The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
*/
UserSettings?: UserSettingList;
/**
* The persistent application settings for users of the stack.
*/
ApplicationSettings?: ApplicationSettingsResponse;
/**
* The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
*/
AccessEndpoints?: AccessEndpointList;
/**
* The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
*/
EmbedHostDomains?: EmbedHostDomains;
}
export type StackAttribute = "STORAGE_CONNECTORS"|"STORAGE_CONNECTOR_HOMEFOLDERS"|"STORAGE_CONNECTOR_GOOGLE_DRIVE"|"STORAGE_CONNECTOR_ONE_DRIVE"|"REDIRECT_URL"|"FEEDBACK_URL"|"THEME_NAME"|"USER_SETTINGS"|"EMBED_HOST_DOMAINS"|"IAM_ROLE_ARN"|"ACCESS_ENDPOINTS"|string;
export type StackAttributes = StackAttribute[];
export interface StackError {
/**
* The error code.
*/
ErrorCode?: StackErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
}
export type StackErrorCode = "STORAGE_CONNECTOR_ERROR"|"INTERNAL_SERVICE_ERROR"|string;
export type StackErrors = StackError[];
export type StackList = Stack[];
export interface StartFleetRequest {
/**
* The name of the fleet.
*/
Name: String;
}
export interface StartFleetResult {
}
export interface StartImageBuilderRequest {
/**
* The name of the image builder.
*/
Name: String;
/**
* The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
*/
AppstreamAgentVersion?: AppstreamAgentVersion;
}
export interface StartImageBuilderResult {
/**
* Information about the image builder.
*/
ImageBuilder?: ImageBuilder;
}
export interface StopFleetRequest {
/**
* The name of the fleet.
*/
Name: String;
}
export interface StopFleetResult {
}
export interface StopImageBuilderRequest {
/**
* The name of the image builder.
*/
Name: String;
}
export interface StopImageBuilderResult {
/**
* Information about the image builder.
*/
ImageBuilder?: ImageBuilder;
}
export interface StorageConnector {
/**
* The type of storage connector.
*/
ConnectorType: StorageConnectorType;
/**
* The ARN of the storage connector.
*/
ResourceIdentifier?: ResourceIdentifier;
/**
* The names of the domains for the account.
*/
Domains?: DomainList;
}
export type StorageConnectorList = StorageConnector[];
export type StorageConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE"|string;
export type StreamView = "APP"|"DESKTOP"|string;
export type StreamingUrlUserId = string;
export type String = string;
export type StringList = String[];
export type SubnetIdList = String[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: Arn;
/**
* The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @
*/
Tags: Tags;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export type Timestamp = Date;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: Arn;
/**
* The tag keys for the tags to disassociate.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateDirectoryConfigRequest {
/**
* The name of the Directory Config object.
*/
DirectoryName: DirectoryName;
/**
* The distinguished names of the organizational units for computer accounts.
*/
OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList;
/**
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*/
ServiceAccountCredentials?: ServiceAccountCredentials;
}
export interface UpdateDirectoryConfigResult {
/**
* Information about the Directory Config object.
*/
DirectoryConfig?: DirectoryConfig;
}
export interface UpdateFleetRequest {
/**
* The name of the image used to create the fleet.
*/
ImageName?: String;
/**
* The ARN of the public, private, or shared image to use.
*/
ImageArn?: Arn;
/**
* A unique name for the fleet.
*/
Name?: String;
/**
* The instance type to use when launching fleet instances. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
*/
InstanceType?: String;
/**
* The desired capacity for the fleet.
*/
ComputeCapacity?: ComputeCapacity;
/**
* The VPC configuration for the fleet.
*/
VpcConfig?: VpcConfig;
/**
* The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 360000.
*/
MaxUserDurationInSeconds?: Integer;
/**
* The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
*/
DisconnectTimeoutInSeconds?: Integer;
/**
* Deletes the VPC association for the specified fleet.
*/
DeleteVpcConfig?: Boolean;
/**
* The description to display.
*/
Description?: Description;
/**
* The fleet name to display.
*/
DisplayName?: DisplayName;
/**
* Enables or disables default internet access for the fleet.
*/
EnableDefaultInternetAccess?: BooleanObject;
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*/
DomainJoinInfo?: DomainJoinInfo;
/**
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
*/
IdleDisconnectTimeoutInSeconds?: Integer;
/**
* The fleet attributes to delete.
*/
AttributesToDelete?: FleetAttributes;
/**
* The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
*/
IamRoleArn?: Arn;
/**
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
*/
StreamView?: StreamView;
}
export interface UpdateFleetResult {
/**
* Information about the fleet.
*/
Fleet?: Fleet;
}
export interface UpdateImagePermissionsRequest {
/**
* The name of the private image.
*/
Name: Name;
/**
* The 12-digit identifier of the AWS account for which you want add or update image permissions.
*/
SharedAccountId: AwsAccountId;
/**
* The permissions for the image.
*/
ImagePermissions: ImagePermissions;
}
export interface UpdateImagePermissionsResult {
}
export interface UpdateStackRequest {
/**
* The stack name to display.
*/
DisplayName?: DisplayName;
/**
* The description to display.
*/
Description?: Description;
/**
* The name of the stack.
*/
Name: String;
/**
* The storage connectors to enable.
*/
StorageConnectors?: StorageConnectorList;
/**
* Deletes the storage connectors currently enabled for the stack.
*/
DeleteStorageConnectors?: Boolean;
/**
* The URL that users are redirected to after their streaming session ends.
*/
RedirectURL?: RedirectURL;
/**
* The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
*/
FeedbackURL?: FeedbackURL;
/**
* The stack attributes to delete.
*/
AttributesToDelete?: StackAttributes;
/**
* The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
*/
UserSettings?: UserSettingList;
/**
* The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
*/
ApplicationSettings?: ApplicationSettings;
/**
* The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
*/
AccessEndpoints?: AccessEndpointList;
/**
* The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
*/
EmbedHostDomains?: EmbedHostDomains;
}
export interface UpdateStackResult {
/**
* Information about the stack.
*/
Stack?: Stack;
}
export type UsageReportExecutionErrorCode = "RESOURCE_NOT_FOUND"|"ACCESS_DENIED"|"INTERNAL_SERVICE_ERROR"|string;
export type UsageReportSchedule = "DAILY"|string;
export interface UsageReportSubscription {
/**
* The Amazon S3 bucket where generated reports are stored. If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
*/
S3BucketName?: String;
/**
* The schedule for generating usage reports.
*/
Schedule?: UsageReportSchedule;
/**
* The time when the last usage report was generated.
*/
LastGeneratedReportDate?: Timestamp;
/**
* The errors that were returned if usage reports couldn't be generated.
*/
SubscriptionErrors?: LastReportGenerationExecutionErrors;
}
export type UsageReportSubscriptionList = UsageReportSubscription[];
export interface User {
/**
* The ARN of the user.
*/
Arn?: Arn;
/**
* The email address of the user. Users' email addresses are case-sensitive.
*/
UserName?: Username;
/**
* Specifies whether the user in the user pool is enabled.
*/
Enabled?: Boolean;
/**
* The status of the user in the user pool. The status can be one of the following: UNCONFIRMED – The user is created but not confirmed. CONFIRMED – The user is confirmed. ARCHIVED – The user is no longer active. COMPROMISED – The user is disabled because of a potential security threat. UNKNOWN – The user status is not known.
*/
Status?: String;
/**
* The first name, or given name, of the user.
*/
FirstName?: UserAttributeValue;
/**
* The last name, or surname, of the user.
*/
LastName?: UserAttributeValue;
/**
* The date and time the user was created in the user pool.
*/
CreatedTime?: Timestamp;
/**
* The authentication type for the user.
*/
AuthenticationType: AuthenticationType;
}
export type UserAttributeValue = string;
export type UserId = string;
export type UserList = User[];
export interface UserSetting {
/**
* The action that is enabled or disabled.
*/
Action: Action;
/**
* Indicates whether the action is enabled or disabled.
*/
Permission: Permission;
}
export type UserSettingList = UserSetting[];
export interface UserStackAssociation {
/**
* The name of the stack that is associated with the user.
*/
StackName: String;
/**
* The email address of the user who is associated with the stack. Users' email addresses are case-sensitive.
*/
UserName: Username;
/**
* The authentication type for the user.
*/
AuthenticationType: AuthenticationType;
/**
* Specifies whether a welcome email is sent to a user after the user is created in the user pool.
*/
SendEmailNotification?: Boolean;
}
export interface UserStackAssociationError {
/**
* Information about the user and associated stack.
*/
UserStackAssociation?: UserStackAssociation;
/**
* The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
*/
ErrorCode?: UserStackAssociationErrorCode;
/**
* The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
*/
ErrorMessage?: String;
}
export type UserStackAssociationErrorCode = "STACK_NOT_FOUND"|"USER_NAME_NOT_FOUND"|"DIRECTORY_NOT_FOUND"|"INTERNAL_ERROR"|string;
export type UserStackAssociationErrorList = UserStackAssociationError[];
export type UserStackAssociationList = UserStackAssociation[];
export type Username = string;
export type VisibilityType = "PUBLIC"|"PRIVATE"|"SHARED"|string;
export interface VpcConfig {
/**
* The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
*/
SubnetIds?: SubnetIdList;
/**
* The identifiers of the security groups for the fleet or image builder.
*/
SecurityGroupIds?: SecurityGroupIdList;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-12-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AppStream client.
*/
export import Types = AppStream;
}
export = AppStream;