workspaces.d.ts
99.3 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class WorkSpaces extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: WorkSpaces.Types.ClientConfiguration)
config: Config & WorkSpaces.Types.ClientConfiguration;
/**
* Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
*/
associateConnectionAlias(params: WorkSpaces.Types.AssociateConnectionAliasRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AssociateConnectionAliasResult) => void): Request<WorkSpaces.Types.AssociateConnectionAliasResult, AWSError>;
/**
* Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
*/
associateConnectionAlias(callback?: (err: AWSError, data: WorkSpaces.Types.AssociateConnectionAliasResult) => void): Request<WorkSpaces.Types.AssociateConnectionAliasResult, AWSError>;
/**
* Associates the specified IP access control group with the specified directory.
*/
associateIpGroups(params: WorkSpaces.Types.AssociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request<WorkSpaces.Types.AssociateIpGroupsResult, AWSError>;
/**
* Associates the specified IP access control group with the specified directory.
*/
associateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request<WorkSpaces.Types.AssociateIpGroupsResult, AWSError>;
/**
* Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
*/
authorizeIpRules(params: WorkSpaces.Types.AuthorizeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request<WorkSpaces.Types.AuthorizeIpRulesResult, AWSError>;
/**
* Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
*/
authorizeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request<WorkSpaces.Types.AuthorizeIpRulesResult, AWSError>;
/**
* Copies the specified image from the specified Region to the current Region.
*/
copyWorkspaceImage(params: WorkSpaces.Types.CopyWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CopyWorkspaceImageResult) => void): Request<WorkSpaces.Types.CopyWorkspaceImageResult, AWSError>;
/**
* Copies the specified image from the specified Region to the current Region.
*/
copyWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.CopyWorkspaceImageResult) => void): Request<WorkSpaces.Types.CopyWorkspaceImageResult, AWSError>;
/**
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
createConnectionAlias(params: WorkSpaces.Types.CreateConnectionAliasRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateConnectionAliasResult) => void): Request<WorkSpaces.Types.CreateConnectionAliasResult, AWSError>;
/**
* Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
createConnectionAlias(callback?: (err: AWSError, data: WorkSpaces.Types.CreateConnectionAliasResult) => void): Request<WorkSpaces.Types.CreateConnectionAliasResult, AWSError>;
/**
* Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
*/
createIpGroup(params: WorkSpaces.Types.CreateIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request<WorkSpaces.Types.CreateIpGroupResult, AWSError>;
/**
* Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
*/
createIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request<WorkSpaces.Types.CreateIpGroupResult, AWSError>;
/**
* Creates the specified tags for the specified WorkSpaces resource.
*/
createTags(params: WorkSpaces.Types.CreateTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>;
/**
* Creates the specified tags for the specified WorkSpaces resource.
*/
createTags(callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>;
/**
* Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
*/
createWorkspaces(params: WorkSpaces.Types.CreateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>;
/**
* Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
*/
createWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>;
/**
* Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
*/
deleteConnectionAlias(params: WorkSpaces.Types.DeleteConnectionAliasRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteConnectionAliasResult) => void): Request<WorkSpaces.Types.DeleteConnectionAliasResult, AWSError>;
/**
* Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
*/
deleteConnectionAlias(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteConnectionAliasResult) => void): Request<WorkSpaces.Types.DeleteConnectionAliasResult, AWSError>;
/**
* Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
*/
deleteIpGroup(params: WorkSpaces.Types.DeleteIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request<WorkSpaces.Types.DeleteIpGroupResult, AWSError>;
/**
* Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
*/
deleteIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request<WorkSpaces.Types.DeleteIpGroupResult, AWSError>;
/**
* Deletes the specified tags from the specified WorkSpaces resource.
*/
deleteTags(params: WorkSpaces.Types.DeleteTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>;
/**
* Deletes the specified tags from the specified WorkSpaces resource.
*/
deleteTags(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>;
/**
* Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
*/
deleteWorkspaceImage(params: WorkSpaces.Types.DeleteWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request<WorkSpaces.Types.DeleteWorkspaceImageResult, AWSError>;
/**
* Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
*/
deleteWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request<WorkSpaces.Types.DeleteWorkspaceImageResult, AWSError>;
/**
* Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
*/
deregisterWorkspaceDirectory(params: WorkSpaces.Types.DeregisterWorkspaceDirectoryRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeregisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.DeregisterWorkspaceDirectoryResult, AWSError>;
/**
* Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
*/
deregisterWorkspaceDirectory(callback?: (err: AWSError, data: WorkSpaces.Types.DeregisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.DeregisterWorkspaceDirectoryResult, AWSError>;
/**
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*/
describeAccount(params: WorkSpaces.Types.DescribeAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
/**
* Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
*/
describeAccount(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
/**
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
*/
describeAccountModifications(params: WorkSpaces.Types.DescribeAccountModificationsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
/**
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
*/
describeAccountModifications(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*/
describeClientProperties(params: WorkSpaces.Types.DescribeClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
/**
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
*/
describeClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
/**
* Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
describeConnectionAliasPermissions(params: WorkSpaces.Types.DescribeConnectionAliasPermissionsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeConnectionAliasPermissionsResult) => void): Request<WorkSpaces.Types.DescribeConnectionAliasPermissionsResult, AWSError>;
/**
* Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
describeConnectionAliasPermissions(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeConnectionAliasPermissionsResult) => void): Request<WorkSpaces.Types.DescribeConnectionAliasPermissionsResult, AWSError>;
/**
* Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
describeConnectionAliases(params: WorkSpaces.Types.DescribeConnectionAliasesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeConnectionAliasesResult) => void): Request<WorkSpaces.Types.DescribeConnectionAliasesResult, AWSError>;
/**
* Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
*/
describeConnectionAliases(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeConnectionAliasesResult) => void): Request<WorkSpaces.Types.DescribeConnectionAliasesResult, AWSError>;
/**
* Describes one or more of your IP access control groups.
*/
describeIpGroups(params: WorkSpaces.Types.DescribeIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
/**
* Describes one or more of your IP access control groups.
*/
describeIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
/**
* Describes the specified tags for the specified WorkSpaces resource.
*/
describeTags(params: WorkSpaces.Types.DescribeTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
/**
* Describes the specified tags for the specified WorkSpaces resource.
*/
describeTags(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
/**
* Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
*/
describeWorkspaceBundles(params: WorkSpaces.Types.DescribeWorkspaceBundlesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
/**
* Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
*/
describeWorkspaceBundles(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
/**
* Describes the available directories that are registered with Amazon WorkSpaces.
*/
describeWorkspaceDirectories(params: WorkSpaces.Types.DescribeWorkspaceDirectoriesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
/**
* Describes the available directories that are registered with Amazon WorkSpaces.
*/
describeWorkspaceDirectories(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
/**
* Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
*/
describeWorkspaceImagePermissions(params: WorkSpaces.Types.DescribeWorkspaceImagePermissionsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagePermissionsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagePermissionsResult, AWSError>;
/**
* Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
*/
describeWorkspaceImagePermissions(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagePermissionsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagePermissionsResult, AWSError>;
/**
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
*/
describeWorkspaceImages(params: WorkSpaces.Types.DescribeWorkspaceImagesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
/**
* Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
*/
describeWorkspaceImages(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
/**
* Describes the snapshots for the specified WorkSpace.
*/
describeWorkspaceSnapshots(params: WorkSpaces.Types.DescribeWorkspaceSnapshotsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
/**
* Describes the snapshots for the specified WorkSpace.
*/
describeWorkspaceSnapshots(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
/**
* Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
*/
describeWorkspaces(params: WorkSpaces.Types.DescribeWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
/**
* Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
*/
describeWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
/**
* Describes the connection status of the specified WorkSpaces.
*/
describeWorkspacesConnectionStatus(params: WorkSpaces.Types.DescribeWorkspacesConnectionStatusRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
/**
* Describes the connection status of the specified WorkSpaces.
*/
describeWorkspacesConnectionStatus(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
/**
* Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
*/
disassociateConnectionAlias(params: WorkSpaces.Types.DisassociateConnectionAliasRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateConnectionAliasResult) => void): Request<WorkSpaces.Types.DisassociateConnectionAliasResult, AWSError>;
/**
* Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
*/
disassociateConnectionAlias(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateConnectionAliasResult) => void): Request<WorkSpaces.Types.DisassociateConnectionAliasResult, AWSError>;
/**
* Disassociates the specified IP access control group from the specified directory.
*/
disassociateIpGroups(params: WorkSpaces.Types.DisassociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
/**
* Disassociates the specified IP access control group from the specified directory.
*/
disassociateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
/**
* Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
*/
importWorkspaceImage(params: WorkSpaces.Types.ImportWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
/**
* Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
*/
importWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
/**
* Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
*/
listAvailableManagementCidrRanges(params: WorkSpaces.Types.ListAvailableManagementCidrRangesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
/**
* Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
*/
listAvailableManagementCidrRanges(callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
/**
* Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
*/
migrateWorkspace(params: WorkSpaces.Types.MigrateWorkspaceRequest, callback?: (err: AWSError, data: WorkSpaces.Types.MigrateWorkspaceResult) => void): Request<WorkSpaces.Types.MigrateWorkspaceResult, AWSError>;
/**
* Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
*/
migrateWorkspace(callback?: (err: AWSError, data: WorkSpaces.Types.MigrateWorkspaceResult) => void): Request<WorkSpaces.Types.MigrateWorkspaceResult, AWSError>;
/**
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*/
modifyAccount(params: WorkSpaces.Types.ModifyAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
/**
* Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
*/
modifyAccount(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
/**
* Modifies the properties of the specified Amazon WorkSpaces clients.
*/
modifyClientProperties(params: WorkSpaces.Types.ModifyClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
/**
* Modifies the properties of the specified Amazon WorkSpaces clients.
*/
modifyClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
/**
* Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
*/
modifySelfservicePermissions(params: WorkSpaces.Types.ModifySelfservicePermissionsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifySelfservicePermissionsResult) => void): Request<WorkSpaces.Types.ModifySelfservicePermissionsResult, AWSError>;
/**
* Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
*/
modifySelfservicePermissions(callback?: (err: AWSError, data: WorkSpaces.Types.ModifySelfservicePermissionsResult) => void): Request<WorkSpaces.Types.ModifySelfservicePermissionsResult, AWSError>;
/**
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
*/
modifyWorkspaceAccessProperties(params: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult, AWSError>;
/**
* Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
*/
modifyWorkspaceAccessProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult, AWSError>;
/**
* Modify the default properties used to create WorkSpaces.
*/
modifyWorkspaceCreationProperties(params: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult, AWSError>;
/**
* Modify the default properties used to create WorkSpaces.
*/
modifyWorkspaceCreationProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult, AWSError>;
/**
* Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
*/
modifyWorkspaceProperties(params: WorkSpaces.Types.ModifyWorkspacePropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
/**
* Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
*/
modifyWorkspaceProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
/**
* Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
*/
modifyWorkspaceState(params: WorkSpaces.Types.ModifyWorkspaceStateRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
/**
* Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
*/
modifyWorkspaceState(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
/**
* Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted.
*/
rebootWorkspaces(params: WorkSpaces.Types.RebootWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
/**
* Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted.
*/
rebootWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
/**
* Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
*/
rebuildWorkspaces(params: WorkSpaces.Types.RebuildWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
/**
* Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
*/
rebuildWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
/**
* Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
*/
registerWorkspaceDirectory(params: WorkSpaces.Types.RegisterWorkspaceDirectoryRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RegisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.RegisterWorkspaceDirectoryResult, AWSError>;
/**
* Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
*/
registerWorkspaceDirectory(callback?: (err: AWSError, data: WorkSpaces.Types.RegisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.RegisterWorkspaceDirectoryResult, AWSError>;
/**
* Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored.
*/
restoreWorkspace(params: WorkSpaces.Types.RestoreWorkspaceRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
/**
* Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored.
*/
restoreWorkspace(callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
/**
* Removes one or more rules from the specified IP access control group.
*/
revokeIpRules(params: WorkSpaces.Types.RevokeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
/**
* Removes one or more rules from the specified IP access control group.
*/
revokeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
/**
* Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
*/
startWorkspaces(params: WorkSpaces.Types.StartWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
/**
* Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
*/
startWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
/**
* Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
*/
stopWorkspaces(params: WorkSpaces.Types.StopWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
/**
* Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
*/
stopWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
/**
* Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
*/
terminateWorkspaces(params: WorkSpaces.Types.TerminateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
/**
* Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
*/
terminateWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
/**
* Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
*/
updateConnectionAliasPermission(params: WorkSpaces.Types.UpdateConnectionAliasPermissionRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateConnectionAliasPermissionResult) => void): Request<WorkSpaces.Types.UpdateConnectionAliasPermissionResult, AWSError>;
/**
* Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
*/
updateConnectionAliasPermission(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateConnectionAliasPermissionResult) => void): Request<WorkSpaces.Types.UpdateConnectionAliasPermissionResult, AWSError>;
/**
* Replaces the current rules of the specified IP access control group with the specified rules.
*/
updateRulesOfIpGroup(params: WorkSpaces.Types.UpdateRulesOfIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
/**
* Replaces the current rules of the specified IP access control group with the specified rules.
*/
updateRulesOfIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
/**
* Shares or unshares an image with one account by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
*/
updateWorkspaceImagePermission(params: WorkSpaces.Types.UpdateWorkspaceImagePermissionRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateWorkspaceImagePermissionResult) => void): Request<WorkSpaces.Types.UpdateWorkspaceImagePermissionResult, AWSError>;
/**
* Shares or unshares an image with one account by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
*/
updateWorkspaceImagePermission(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateWorkspaceImagePermissionResult) => void): Request<WorkSpaces.Types.UpdateWorkspaceImagePermissionResult, AWSError>;
}
declare namespace WorkSpaces {
export type ARN = string;
export type AccessPropertyValue = "ALLOW"|"DENY"|string;
export interface AccountModification {
/**
* The state of the modification to the configuration of BYOL.
*/
ModificationState?: DedicatedTenancyModificationStateEnum;
/**
* The status of BYOL (whether BYOL is being enabled or disabled).
*/
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
/**
* The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
*/
DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
/**
* The timestamp when the modification of the BYOL configuration was started.
*/
StartTime?: Timestamp;
/**
* The error code that is returned if the configuration of BYOL cannot be modified.
*/
ErrorCode?: WorkspaceErrorCode;
/**
* The text of the error message that is returned if the configuration of BYOL cannot be modified.
*/
ErrorMessage?: Description;
}
export type AccountModificationList = AccountModification[];
export type Alias = string;
export type Application = "Microsoft_Office_2016"|"Microsoft_Office_2019"|string;
export type ApplicationList = Application[];
export interface AssociateConnectionAliasRequest {
/**
* The identifier of the connection alias.
*/
AliasId: ConnectionAliasId;
/**
* The identifier of the directory to associate the connection alias with.
*/
ResourceId: NonEmptyString;
}
export interface AssociateConnectionAliasResult {
/**
* The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
*/
ConnectionIdentifier?: ConnectionIdentifier;
}
export interface AssociateIpGroupsRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The identifiers of one or more IP access control groups.
*/
GroupIds: IpGroupIdList;
}
export interface AssociateIpGroupsResult {
}
export type AssociationStatus = "NOT_ASSOCIATED"|"ASSOCIATED_WITH_OWNER_ACCOUNT"|"ASSOCIATED_WITH_SHARED_ACCOUNT"|"PENDING_ASSOCIATION"|"PENDING_DISASSOCIATION"|string;
export interface AuthorizeIpRulesRequest {
/**
* The identifier of the group.
*/
GroupId: IpGroupId;
/**
* The rules to add to the group.
*/
UserRules: IpRuleList;
}
export interface AuthorizeIpRulesResult {
}
export type AwsAccount = string;
export type BooleanObject = boolean;
export type BundleId = string;
export type BundleIdList = BundleId[];
export type BundleList = WorkspaceBundle[];
export type BundleOwner = string;
export interface ClientProperties {
/**
* Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
*/
ReconnectEnabled?: ReconnectEnum;
}
export type ClientPropertiesList = ClientPropertiesResult[];
export interface ClientPropertiesResult {
/**
* The resource identifier, in the form of a directory ID.
*/
ResourceId?: NonEmptyString;
/**
* Information about the Amazon WorkSpaces client.
*/
ClientProperties?: ClientProperties;
}
export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|string;
export interface ComputeType {
/**
* The compute type.
*/
Name?: Compute;
}
export type ComputerName = string;
export interface ConnectionAlias {
/**
* The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
*/
ConnectionString?: ConnectionString;
/**
* The identifier of the connection alias.
*/
AliasId?: ConnectionAliasId;
/**
* The current state of the connection alias.
*/
State?: ConnectionAliasState;
/**
* The identifier of the AWS account that owns the connection alias.
*/
OwnerAccountId?: AwsAccount;
/**
* The association status of the connection alias.
*/
Associations?: ConnectionAliasAssociationList;
}
export interface ConnectionAliasAssociation {
/**
* The association status of the connection alias.
*/
AssociationStatus?: AssociationStatus;
/**
* The identifier of the AWS account that associated the connection alias with a directory.
*/
AssociatedAccountId?: AwsAccount;
/**
* The identifier of the directory associated with a connection alias.
*/
ResourceId?: NonEmptyString;
/**
* The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
*/
ConnectionIdentifier?: ConnectionIdentifier;
}
export type ConnectionAliasAssociationList = ConnectionAliasAssociation[];
export type ConnectionAliasId = string;
export type ConnectionAliasIdList = ConnectionAliasId[];
export type ConnectionAliasList = ConnectionAlias[];
export interface ConnectionAliasPermission {
/**
* The identifier of the AWS account that the connection alias is shared with.
*/
SharedAccountId: AwsAccount;
/**
* Indicates whether the specified AWS account is allowed to associate the connection alias with a directory.
*/
AllowAssociation: BooleanObject;
}
export type ConnectionAliasPermissions = ConnectionAliasPermission[];
export type ConnectionAliasState = "CREATING"|"CREATED"|"DELETING"|string;
export type ConnectionIdentifier = string;
export type ConnectionState = "CONNECTED"|"DISCONNECTED"|"UNKNOWN"|string;
export type ConnectionString = string;
export interface CopyWorkspaceImageRequest {
/**
* The name of the image.
*/
Name: WorkspaceImageName;
/**
* A description of the image.
*/
Description?: WorkspaceImageDescription;
/**
* The identifier of the source image.
*/
SourceImageId: WorkspaceImageId;
/**
* The identifier of the source Region.
*/
SourceRegion: Region;
/**
* The tags for the image.
*/
Tags?: TagList;
}
export interface CopyWorkspaceImageResult {
/**
* The identifier of the image.
*/
ImageId?: WorkspaceImageId;
}
export interface CreateConnectionAliasRequest {
/**
* A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com. After you create a connection string, it is always associated to your AWS account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
*/
ConnectionString: ConnectionString;
/**
* The tags to associate with the connection alias.
*/
Tags?: TagList;
}
export interface CreateConnectionAliasResult {
/**
* The identifier of the connection alias.
*/
AliasId?: ConnectionAliasId;
}
export interface CreateIpGroupRequest {
/**
* The name of the group.
*/
GroupName: IpGroupName;
/**
* The description of the group.
*/
GroupDesc?: IpGroupDesc;
/**
* The rules to add to the group.
*/
UserRules?: IpRuleList;
/**
* The tags. Each WorkSpaces resource can have a maximum of 50 tags.
*/
Tags?: TagList;
}
export interface CreateIpGroupResult {
/**
* The identifier of the group.
*/
GroupId?: IpGroupId;
}
export interface CreateTagsRequest {
/**
* The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
*/
ResourceId: NonEmptyString;
/**
* The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to add new tags to a set of existing tags, you must submit all of the existing tags along with the new ones.
*/
Tags: TagList;
}
export interface CreateTagsResult {
}
export interface CreateWorkspacesRequest {
/**
* The WorkSpaces to create. You can specify up to 25 WorkSpaces.
*/
Workspaces: WorkspaceRequestList;
}
export interface CreateWorkspacesResult {
/**
* Information about the WorkSpaces that could not be created.
*/
FailedRequests?: FailedCreateWorkspaceRequests;
/**
* Information about the WorkSpaces that were created. Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
*/
PendingRequests?: WorkspaceList;
}
export type DedicatedTenancyCidrRangeList = DedicatedTenancyManagementCidrRange[];
export type DedicatedTenancyManagementCidrRange = string;
export type DedicatedTenancyModificationStateEnum = "PENDING"|"COMPLETED"|"FAILED"|string;
export type DedicatedTenancySupportEnum = "ENABLED"|string;
export type DedicatedTenancySupportResultEnum = "ENABLED"|"DISABLED"|string;
export type DefaultOu = string;
export interface DefaultWorkspaceCreationProperties {
/**
* Specifies whether the directory is enabled for Amazon WorkDocs.
*/
EnableWorkDocs?: BooleanObject;
/**
* Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
*/
EnableInternetAccess?: BooleanObject;
/**
* The organizational unit (OU) in the directory for the WorkSpace machine accounts.
*/
DefaultOu?: DefaultOu;
/**
* The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
*/
CustomSecurityGroupId?: SecurityGroupId;
/**
* Specifies whether WorkSpace users are local administrators on their WorkSpaces.
*/
UserEnabledAsLocalAdministrator?: BooleanObject;
/**
* Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
*/
EnableMaintenanceMode?: BooleanObject;
}
export interface DeleteConnectionAliasRequest {
/**
* The identifier of the connection alias to delete.
*/
AliasId: ConnectionAliasId;
}
export interface DeleteConnectionAliasResult {
}
export interface DeleteIpGroupRequest {
/**
* The identifier of the IP access control group.
*/
GroupId: IpGroupId;
}
export interface DeleteIpGroupResult {
}
export interface DeleteTagsRequest {
/**
* The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
*/
ResourceId: NonEmptyString;
/**
* The tag keys.
*/
TagKeys: TagKeyList;
}
export interface DeleteTagsResult {
}
export interface DeleteWorkspaceImageRequest {
/**
* The identifier of the image.
*/
ImageId: WorkspaceImageId;
}
export interface DeleteWorkspaceImageResult {
}
export interface DeregisterWorkspaceDirectoryRequest {
/**
* The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
*/
DirectoryId: DirectoryId;
}
export interface DeregisterWorkspaceDirectoryResult {
}
export interface DescribeAccountModificationsRequest {
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface DescribeAccountModificationsResult {
/**
* The list of modifications to the configuration of BYOL.
*/
AccountModifications?: AccountModificationList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeAccountRequest {
}
export interface DescribeAccountResult {
/**
* The status of BYOL (whether BYOL is enabled or disabled).
*/
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
/**
* The IP address range, specified as an IPv4 CIDR block, used for the management network interface. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
*/
DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
}
export interface DescribeClientPropertiesRequest {
/**
* The resource identifier, in the form of directory IDs.
*/
ResourceIds: ResourceIdList;
}
export interface DescribeClientPropertiesResult {
/**
* Information about the specified Amazon WorkSpaces clients.
*/
ClientPropertiesList?: ClientPropertiesList;
}
export interface DescribeConnectionAliasPermissionsRequest {
/**
* The identifier of the connection alias.
*/
AliasId: ConnectionAliasId;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
/**
* The maximum number of results to return.
*/
MaxResults?: Limit;
}
export interface DescribeConnectionAliasPermissionsResult {
/**
* The identifier of the connection alias.
*/
AliasId?: ConnectionAliasId;
/**
* The permissions associated with a connection alias.
*/
ConnectionAliasPermissions?: ConnectionAliasPermissions;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeConnectionAliasesRequest {
/**
* The identifiers of the connection aliases to describe.
*/
AliasIds?: ConnectionAliasIdList;
/**
* The identifier of the directory associated with the connection alias.
*/
ResourceId?: NonEmptyString;
/**
* The maximum number of connection aliases to return.
*/
Limit?: Limit;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface DescribeConnectionAliasesResult {
/**
* Information about the specified connection aliases.
*/
ConnectionAliases?: ConnectionAliasList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeIpGroupsRequest {
/**
* The identifiers of one or more IP access control groups.
*/
GroupIds?: IpGroupIdList;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
/**
* The maximum number of items to return.
*/
MaxResults?: Limit;
}
export interface DescribeIpGroupsResult {
/**
* Information about the IP access control groups.
*/
Result?: WorkspacesIpGroupsList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeTagsRequest {
/**
* The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
*/
ResourceId: NonEmptyString;
}
export interface DescribeTagsResult {
/**
* The tags.
*/
TagList?: TagList;
}
export interface DescribeWorkspaceBundlesRequest {
/**
* The identifiers of the bundles. You cannot combine this parameter with any other filter.
*/
BundleIds?: BundleIdList;
/**
* The owner of the bundles. You cannot combine this parameter with any other filter. Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.
*/
Owner?: BundleOwner;
/**
* The token for the next set of results. (You received this token from a previous call.)
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceBundlesResult {
/**
* Information about the bundles.
*/
Bundles?: BundleList;
/**
* The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceDirectoriesRequest {
/**
* The identifiers of the directories. If the value is null, all directories are retrieved.
*/
DirectoryIds?: DirectoryIdList;
/**
* The maximum number of directories to return.
*/
Limit?: Limit;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceDirectoriesResult {
/**
* Information about the directories.
*/
Directories?: DirectoryList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceImagePermissionsRequest {
/**
* The identifier of the image.
*/
ImageId: WorkspaceImageId;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
/**
* The maximum number of items to return.
*/
MaxResults?: Limit;
}
export interface DescribeWorkspaceImagePermissionsResult {
/**
* The identifier of the image.
*/
ImageId?: WorkspaceImageId;
/**
* The identifiers of the AWS accounts that the image has been shared with.
*/
ImagePermissions?: ImagePermissions;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceImagesRequest {
/**
* The identifier of the image.
*/
ImageIds?: WorkspaceImageIdList;
/**
* The type (owned or shared) of the image.
*/
ImageType?: ImageType;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
/**
* The maximum number of items to return.
*/
MaxResults?: Limit;
}
export interface DescribeWorkspaceImagesResult {
/**
* Information about the images.
*/
Images?: WorkspaceImageList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspaceSnapshotsRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
}
export interface DescribeWorkspaceSnapshotsResult {
/**
* Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
*/
RebuildSnapshots?: SnapshotList;
/**
* Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
*/
RestoreSnapshots?: SnapshotList;
}
export interface DescribeWorkspacesConnectionStatusRequest {
/**
* The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
*/
WorkspaceIds?: WorkspaceIdList;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspacesConnectionStatusResult {
/**
* Information about the connection status of the WorkSpace.
*/
WorkspacesConnectionStatus?: WorkspaceConnectionStatusList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspacesRequest {
/**
* The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
*/
WorkspaceIds?: WorkspaceIdList;
/**
* The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.
*/
DirectoryId?: DirectoryId;
/**
* The name of the directory user. You must specify this parameter with DirectoryId.
*/
UserName?: UserName;
/**
* The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
*/
BundleId?: BundleId;
/**
* The maximum number of items to return.
*/
Limit?: Limit;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface DescribeWorkspacesResult {
/**
* Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
*/
Workspaces?: WorkspaceList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export type Description = string;
export type DirectoryId = string;
export type DirectoryIdList = DirectoryId[];
export type DirectoryList = WorkspaceDirectory[];
export type DirectoryName = string;
export interface DisassociateConnectionAliasRequest {
/**
* The identifier of the connection alias to disassociate.
*/
AliasId: ConnectionAliasId;
}
export interface DisassociateConnectionAliasResult {
}
export interface DisassociateIpGroupsRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The identifiers of one or more IP access control groups.
*/
GroupIds: IpGroupIdList;
}
export interface DisassociateIpGroupsResult {
}
export type DnsIpAddresses = IpAddress[];
export type Ec2ImageId = string;
export type ErrorType = string;
export interface FailedCreateWorkspaceRequest {
/**
* Information about the WorkSpace.
*/
WorkspaceRequest?: WorkspaceRequest;
/**
* The error code that is returned if the WorkSpace cannot be created.
*/
ErrorCode?: ErrorType;
/**
* The text of the error message that is returned if the WorkSpace cannot be created.
*/
ErrorMessage?: Description;
}
export type FailedCreateWorkspaceRequests = FailedCreateWorkspaceRequest[];
export type FailedRebootWorkspaceRequests = FailedWorkspaceChangeRequest[];
export type FailedRebuildWorkspaceRequests = FailedWorkspaceChangeRequest[];
export type FailedStartWorkspaceRequests = FailedWorkspaceChangeRequest[];
export type FailedStopWorkspaceRequests = FailedWorkspaceChangeRequest[];
export type FailedTerminateWorkspaceRequests = FailedWorkspaceChangeRequest[];
export interface FailedWorkspaceChangeRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId?: WorkspaceId;
/**
* The error code that is returned if the WorkSpace cannot be rebooted.
*/
ErrorCode?: ErrorType;
/**
* The text of the error message that is returned if the WorkSpace cannot be rebooted.
*/
ErrorMessage?: Description;
}
export interface ImagePermission {
/**
* The identifier of the AWS account that an image has been shared with.
*/
SharedAccountId?: AwsAccount;
}
export type ImagePermissions = ImagePermission[];
export type ImageType = "OWNED"|"SHARED"|string;
export interface ImportWorkspaceImageRequest {
/**
* The identifier of the EC2 image.
*/
Ec2ImageId: Ec2ImageId;
/**
* The ingestion process to be used when importing the image. For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR.
*/
IngestionProcess: WorkspaceImageIngestionProcess;
/**
* The name of the WorkSpace image.
*/
ImageName: WorkspaceImageName;
/**
* The description of the WorkSpace image.
*/
ImageDescription: WorkspaceImageDescription;
/**
* The tags. Each WorkSpaces resource can have a maximum of 50 tags.
*/
Tags?: TagList;
/**
* If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses. Although this parameter is an array, only one item is allowed at this time.
*/
Applications?: ApplicationList;
}
export interface ImportWorkspaceImageResult {
/**
* The identifier of the WorkSpace image.
*/
ImageId?: WorkspaceImageId;
}
export type IpAddress = string;
export type IpGroupDesc = string;
export type IpGroupId = string;
export type IpGroupIdList = IpGroupId[];
export type IpGroupName = string;
export type IpRevokedRuleList = IpRule[];
export type IpRule = string;
export type IpRuleDesc = string;
export interface IpRuleItem {
/**
* The IP address range, in CIDR notation.
*/
ipRule?: IpRule;
/**
* The description.
*/
ruleDesc?: IpRuleDesc;
}
export type IpRuleList = IpRuleItem[];
export type Limit = number;
export interface ListAvailableManagementCidrRangesRequest {
/**
* The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
*/
ManagementCidrRangeConstraint: ManagementCidrRangeConstraint;
/**
* The maximum number of items to return.
*/
MaxResults?: ManagementCidrRangeMaxResults;
/**
* If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
*/
NextToken?: PaginationToken;
}
export interface ListAvailableManagementCidrRangesResult {
/**
* The list of available IP address ranges, specified as IPv4 CIDR blocks.
*/
ManagementCidrRanges?: DedicatedTenancyCidrRangeList;
/**
* The token to use to retrieve the next set of results, or null if no more results are available.
*/
NextToken?: PaginationToken;
}
export type ManagementCidrRangeConstraint = string;
export type ManagementCidrRangeMaxResults = number;
export interface MigrateWorkspaceRequest {
/**
* The identifier of the WorkSpace to migrate from.
*/
SourceWorkspaceId: WorkspaceId;
/**
* The identifier of the target bundle type to migrate the WorkSpace to.
*/
BundleId: BundleId;
}
export interface MigrateWorkspaceResult {
/**
* The original identifier of the WorkSpace that is being migrated.
*/
SourceWorkspaceId?: WorkspaceId;
/**
* The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
*/
TargetWorkspaceId?: WorkspaceId;
}
export type ModificationResourceEnum = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE"|string;
export interface ModificationState {
/**
* The resource.
*/
Resource?: ModificationResourceEnum;
/**
* The modification state.
*/
State?: ModificationStateEnum;
}
export type ModificationStateEnum = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"|string;
export type ModificationStateList = ModificationState[];
export interface ModifyAccountRequest {
/**
* The status of BYOL.
*/
DedicatedTenancySupport?: DedicatedTenancySupportEnum;
/**
* The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.
*/
DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
}
export interface ModifyAccountResult {
}
export interface ModifyClientPropertiesRequest {
/**
* The resource identifiers, in the form of directory IDs.
*/
ResourceId: NonEmptyString;
/**
* Information about the Amazon WorkSpaces client.
*/
ClientProperties: ClientProperties;
}
export interface ModifyClientPropertiesResult {
}
export interface ModifySelfservicePermissionsRequest {
/**
* The identifier of the directory.
*/
ResourceId: DirectoryId;
/**
* The permissions to enable or disable self-service capabilities.
*/
SelfservicePermissions: SelfservicePermissions;
}
export interface ModifySelfservicePermissionsResult {
}
export interface ModifyWorkspaceAccessPropertiesRequest {
/**
* The identifier of the directory.
*/
ResourceId: DirectoryId;
/**
* The device types and operating systems to enable or disable for access.
*/
WorkspaceAccessProperties: WorkspaceAccessProperties;
}
export interface ModifyWorkspaceAccessPropertiesResult {
}
export interface ModifyWorkspaceCreationPropertiesRequest {
/**
* The identifier of the directory.
*/
ResourceId: DirectoryId;
/**
* The default properties for creating WorkSpaces.
*/
WorkspaceCreationProperties: WorkspaceCreationProperties;
}
export interface ModifyWorkspaceCreationPropertiesResult {
}
export interface ModifyWorkspacePropertiesRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
/**
* The properties of the WorkSpace.
*/
WorkspaceProperties: WorkspaceProperties;
}
export interface ModifyWorkspacePropertiesResult {
}
export interface ModifyWorkspaceStateRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
/**
* The WorkSpace state.
*/
WorkspaceState: TargetWorkspaceState;
}
export interface ModifyWorkspaceStateResult {
}
export type NonEmptyString = string;
export interface OperatingSystem {
/**
* The operating system.
*/
Type?: OperatingSystemType;
}
export type OperatingSystemType = "WINDOWS"|"LINUX"|string;
export type PaginationToken = string;
export interface RebootRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
}
export type RebootWorkspaceRequests = RebootRequest[];
export interface RebootWorkspacesRequest {
/**
* The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
*/
RebootWorkspaceRequests: RebootWorkspaceRequests;
}
export interface RebootWorkspacesResult {
/**
* Information about the WorkSpaces that could not be rebooted.
*/
FailedRequests?: FailedRebootWorkspaceRequests;
}
export interface RebuildRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
}
export type RebuildWorkspaceRequests = RebuildRequest[];
export interface RebuildWorkspacesRequest {
/**
* The WorkSpace to rebuild. You can specify a single WorkSpace.
*/
RebuildWorkspaceRequests: RebuildWorkspaceRequests;
}
export interface RebuildWorkspacesResult {
/**
* Information about the WorkSpace that could not be rebuilt.
*/
FailedRequests?: FailedRebuildWorkspaceRequests;
}
export type ReconnectEnum = "ENABLED"|"DISABLED"|string;
export type Region = string;
export interface RegisterWorkspaceDirectoryRequest {
/**
* The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
*/
DirectoryId: DirectoryId;
/**
* The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
*/
SubnetIds?: SubnetIds;
/**
* Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
*/
EnableWorkDocs: BooleanObject;
/**
* Indicates whether self-service capabilities are enabled or disabled.
*/
EnableSelfService?: BooleanObject;
/**
* Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
*/
Tenancy?: Tenancy;
/**
* The tags associated with the directory.
*/
Tags?: TagList;
}
export interface RegisterWorkspaceDirectoryResult {
}
export type RegistrationCode = string;
export type ResourceIdList = NonEmptyString[];
export interface RestoreWorkspaceRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
}
export interface RestoreWorkspaceResult {
}
export interface RevokeIpRulesRequest {
/**
* The identifier of the group.
*/
GroupId: IpGroupId;
/**
* The rules to remove from the group.
*/
UserRules: IpRevokedRuleList;
}
export interface RevokeIpRulesResult {
}
export interface RootStorage {
/**
* The size of the root volume.
*/
Capacity?: NonEmptyString;
}
export type RootVolumeSizeGib = number;
export type RunningMode = "AUTO_STOP"|"ALWAYS_ON"|string;
export type RunningModeAutoStopTimeoutInMinutes = number;
export type SecurityGroupId = string;
export interface SelfservicePermissions {
/**
* Specifies whether users can restart their WorkSpace.
*/
RestartWorkspace?: ReconnectEnum;
/**
* Specifies whether users can increase the volume size of the drives on their WorkSpace.
*/
IncreaseVolumeSize?: ReconnectEnum;
/**
* Specifies whether users can change the compute type (bundle) for their WorkSpace.
*/
ChangeComputeType?: ReconnectEnum;
/**
* Specifies whether users can switch the running mode of their WorkSpace.
*/
SwitchRunningMode?: ReconnectEnum;
/**
* Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
*/
RebuildWorkspace?: ReconnectEnum;
}
export interface Snapshot {
/**
* The time when the snapshot was created.
*/
SnapshotTime?: Timestamp;
}
export type SnapshotList = Snapshot[];
export interface StartRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId?: WorkspaceId;
}
export type StartWorkspaceRequests = StartRequest[];
export interface StartWorkspacesRequest {
/**
* The WorkSpaces to start. You can specify up to 25 WorkSpaces.
*/
StartWorkspaceRequests: StartWorkspaceRequests;
}
export interface StartWorkspacesResult {
/**
* Information about the WorkSpaces that could not be started.
*/
FailedRequests?: FailedStartWorkspaceRequests;
}
export interface StopRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId?: WorkspaceId;
}
export type StopWorkspaceRequests = StopRequest[];
export interface StopWorkspacesRequest {
/**
* The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
*/
StopWorkspaceRequests: StopWorkspaceRequests;
}
export interface StopWorkspacesResult {
/**
* Information about the WorkSpaces that could not be stopped.
*/
FailedRequests?: FailedStopWorkspaceRequests;
}
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export interface Tag {
/**
* The key of the tag.
*/
Key: TagKey;
/**
* The value of the tag.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = NonEmptyString[];
export type TagList = Tag[];
export type TagValue = string;
export type TargetWorkspaceState = "AVAILABLE"|"ADMIN_MAINTENANCE"|string;
export type Tenancy = "DEDICATED"|"SHARED"|string;
export interface TerminateRequest {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId: WorkspaceId;
}
export type TerminateWorkspaceRequests = TerminateRequest[];
export interface TerminateWorkspacesRequest {
/**
* The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
*/
TerminateWorkspaceRequests: TerminateWorkspaceRequests;
}
export interface TerminateWorkspacesResult {
/**
* Information about the WorkSpaces that could not be terminated.
*/
FailedRequests?: FailedTerminateWorkspaceRequests;
}
export type Timestamp = Date;
export interface UpdateConnectionAliasPermissionRequest {
/**
* The identifier of the connection alias that you want to update permissions for.
*/
AliasId: ConnectionAliasId;
/**
* Indicates whether to share or unshare the connection alias with the specified AWS account.
*/
ConnectionAliasPermission: ConnectionAliasPermission;
}
export interface UpdateConnectionAliasPermissionResult {
}
export interface UpdateRulesOfIpGroupRequest {
/**
* The identifier of the group.
*/
GroupId: IpGroupId;
/**
* One or more rules.
*/
UserRules: IpRuleList;
}
export interface UpdateRulesOfIpGroupResult {
}
export interface UpdateWorkspaceImagePermissionRequest {
/**
* The identifier of the image.
*/
ImageId: WorkspaceImageId;
/**
* The permission to copy the image. This permission can be revoked only after an image has been shared.
*/
AllowCopyImage: BooleanObject;
/**
* The identifier of the AWS account to share or unshare the image with.
*/
SharedAccountId: AwsAccount;
}
export interface UpdateWorkspaceImagePermissionResult {
}
export type UserName = string;
export interface UserStorage {
/**
* The size of the user storage.
*/
Capacity?: NonEmptyString;
}
export type UserVolumeSizeGib = number;
export type VolumeEncryptionKey = string;
export interface Workspace {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId?: WorkspaceId;
/**
* The identifier of the AWS Directory Service directory for the WorkSpace.
*/
DirectoryId?: DirectoryId;
/**
* The user for the WorkSpace.
*/
UserName?: UserName;
/**
* The IP address of the WorkSpace.
*/
IpAddress?: IpAddress;
/**
* The operational state of the WorkSpace.
*/
State?: WorkspaceState;
/**
* The identifier of the bundle used to create the WorkSpace.
*/
BundleId?: BundleId;
/**
* The identifier of the subnet for the WorkSpace.
*/
SubnetId?: SubnetId;
/**
* The text of the error message that is returned if the WorkSpace cannot be created.
*/
ErrorMessage?: Description;
/**
* The error code that is returned if the WorkSpace cannot be created.
*/
ErrorCode?: WorkspaceErrorCode;
/**
* The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
*/
ComputerName?: ComputerName;
/**
* The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
*/
VolumeEncryptionKey?: VolumeEncryptionKey;
/**
* Indicates whether the data stored on the user volume is encrypted.
*/
UserVolumeEncryptionEnabled?: BooleanObject;
/**
* Indicates whether the data stored on the root volume is encrypted.
*/
RootVolumeEncryptionEnabled?: BooleanObject;
/**
* The properties of the WorkSpace.
*/
WorkspaceProperties?: WorkspaceProperties;
/**
* The modification states of the WorkSpace.
*/
ModificationStates?: ModificationStateList;
}
export interface WorkspaceAccessProperties {
/**
* Indicates whether users can use Windows clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of TRUST. For more information, see Restrict WorkSpaces Access to Trusted Devices.
*/
DeviceTypeWindows?: AccessPropertyValue;
/**
* Indicates whether users can use macOS clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of TRUST. For more information, see Restrict WorkSpaces Access to Trusted Devices.
*/
DeviceTypeOsx?: AccessPropertyValue;
/**
* Indicates whether users can access their WorkSpaces through a web browser.
*/
DeviceTypeWeb?: AccessPropertyValue;
/**
* Indicates whether users can use iOS devices to access their WorkSpaces.
*/
DeviceTypeIos?: AccessPropertyValue;
/**
* Indicates whether users can use Android devices to access their WorkSpaces.
*/
DeviceTypeAndroid?: AccessPropertyValue;
/**
* Indicates whether users can use Chromebooks to access their WorkSpaces.
*/
DeviceTypeChromeOs?: AccessPropertyValue;
/**
* Indicates whether users can use zero client devices to access their WorkSpaces.
*/
DeviceTypeZeroClient?: AccessPropertyValue;
}
export interface WorkspaceBundle {
/**
* The bundle identifier.
*/
BundleId?: BundleId;
/**
* The name of the bundle.
*/
Name?: NonEmptyString;
/**
* The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
*/
Owner?: BundleOwner;
/**
* A description.
*/
Description?: Description;
/**
* The image identifier of the bundle.
*/
ImageId?: WorkspaceImageId;
/**
* The size of the root volume.
*/
RootStorage?: RootStorage;
/**
* The size of the user storage.
*/
UserStorage?: UserStorage;
/**
* The compute type. For more information, see Amazon WorkSpaces Bundles.
*/
ComputeType?: ComputeType;
/**
* The last time that the bundle was updated.
*/
LastUpdatedTime?: Timestamp;
}
export interface WorkspaceConnectionStatus {
/**
* The identifier of the WorkSpace.
*/
WorkspaceId?: WorkspaceId;
/**
* The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
*/
ConnectionState?: ConnectionState;
/**
* The timestamp of the connection status check.
*/
ConnectionStateCheckTimestamp?: Timestamp;
/**
* The timestamp of the last known user connection.
*/
LastKnownUserConnectionTimestamp?: Timestamp;
}
export type WorkspaceConnectionStatusList = WorkspaceConnectionStatus[];
export interface WorkspaceCreationProperties {
/**
* Indicates whether Amazon WorkDocs is enabled for your WorkSpaces. If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide. If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
*/
EnableWorkDocs?: BooleanObject;
/**
* Indicates whether internet access is enabled for your WorkSpaces.
*/
EnableInternetAccess?: BooleanObject;
/**
* The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com. To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation. The API doesn't validate whether the OU exists.
*/
DefaultOu?: DefaultOu;
/**
* The identifier of your custom security group.
*/
CustomSecurityGroupId?: SecurityGroupId;
/**
* Indicates whether users are local administrators of their WorkSpaces.
*/
UserEnabledAsLocalAdministrator?: BooleanObject;
/**
* Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
*/
EnableMaintenanceMode?: BooleanObject;
}
export interface WorkspaceDirectory {
/**
* The directory identifier.
*/
DirectoryId?: DirectoryId;
/**
* The directory alias.
*/
Alias?: Alias;
/**
* The name of the directory.
*/
DirectoryName?: DirectoryName;
/**
* The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
*/
RegistrationCode?: RegistrationCode;
/**
* The identifiers of the subnets used with the directory.
*/
SubnetIds?: SubnetIds;
/**
* The IP addresses of the DNS servers for the directory.
*/
DnsIpAddresses?: DnsIpAddresses;
/**
* The user name for the service account.
*/
CustomerUserName?: UserName;
/**
* The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
*/
IamRoleId?: ARN;
/**
* The directory type.
*/
DirectoryType?: WorkspaceDirectoryType;
/**
* The identifier of the security group that is assigned to new WorkSpaces.
*/
WorkspaceSecurityGroupId?: SecurityGroupId;
/**
* The state of the directory's registration with Amazon WorkSpaces.
*/
State?: WorkspaceDirectoryState;
/**
* The default creation properties for all WorkSpaces in the directory.
*/
WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties;
/**
* The identifiers of the IP access control groups associated with the directory.
*/
ipGroupIds?: IpGroupIdList;
/**
* The devices and operating systems that users can use to access WorkSpaces.
*/
WorkspaceAccessProperties?: WorkspaceAccessProperties;
/**
* Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
*/
Tenancy?: Tenancy;
/**
* The default self-service permissions for WorkSpaces in the directory.
*/
SelfservicePermissions?: SelfservicePermissions;
}
export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string;
export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|string;
export type WorkspaceErrorCode = string;
export type WorkspaceId = string;
export type WorkspaceIdList = WorkspaceId[];
export interface WorkspaceImage {
/**
* The identifier of the image.
*/
ImageId?: WorkspaceImageId;
/**
* The name of the image.
*/
Name?: WorkspaceImageName;
/**
* The description of the image.
*/
Description?: WorkspaceImageDescription;
/**
* The operating system that the image is running.
*/
OperatingSystem?: OperatingSystem;
/**
* The status of the image.
*/
State?: WorkspaceImageState;
/**
* Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
*/
RequiredTenancy?: WorkspaceImageRequiredTenancy;
/**
* The error code that is returned for the image.
*/
ErrorCode?: WorkspaceImageErrorCode;
/**
* The text of the error message that is returned for the image.
*/
ErrorMessage?: Description;
/**
* The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
*/
Created?: Timestamp;
/**
* The identifier of the AWS account that owns the image.
*/
OwnerAccountId?: AwsAccount;
}
export type WorkspaceImageDescription = string;
export type WorkspaceImageErrorCode = string;
export type WorkspaceImageId = string;
export type WorkspaceImageIdList = WorkspaceImageId[];
export type WorkspaceImageIngestionProcess = "BYOL_REGULAR"|"BYOL_GRAPHICS"|"BYOL_GRAPHICSPRO"|string;
export type WorkspaceImageList = WorkspaceImage[];
export type WorkspaceImageName = string;
export type WorkspaceImageRequiredTenancy = "DEFAULT"|"DEDICATED"|string;
export type WorkspaceImageState = "AVAILABLE"|"PENDING"|"ERROR"|string;
export type WorkspaceList = Workspace[];
export interface WorkspaceProperties {
/**
* The running mode. For more information, see Manage the WorkSpace Running Mode.
*/
RunningMode?: RunningMode;
/**
* The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
*/
RunningModeAutoStopTimeoutInMinutes?: RunningModeAutoStopTimeoutInMinutes;
/**
* The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
*/
RootVolumeSizeGib?: RootVolumeSizeGib;
/**
* The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
*/
UserVolumeSizeGib?: UserVolumeSizeGib;
/**
* The compute type. For more information, see Amazon WorkSpaces Bundles.
*/
ComputeTypeName?: Compute;
}
export interface WorkspaceRequest {
/**
* The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
*/
DirectoryId: DirectoryId;
/**
* The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.
*/
UserName: UserName;
/**
* The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
*/
BundleId: BundleId;
/**
* The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
*/
VolumeEncryptionKey?: VolumeEncryptionKey;
/**
* Indicates whether the data stored on the user volume is encrypted.
*/
UserVolumeEncryptionEnabled?: BooleanObject;
/**
* Indicates whether the data stored on the root volume is encrypted.
*/
RootVolumeEncryptionEnabled?: BooleanObject;
/**
* The WorkSpace properties.
*/
WorkspaceProperties?: WorkspaceProperties;
/**
* The tags for the WorkSpace.
*/
Tags?: TagList;
}
export type WorkspaceRequestList = WorkspaceRequest[];
export type WorkspaceState = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"RESTORING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|string;
export interface WorkspacesIpGroup {
/**
* The identifier of the group.
*/
groupId?: IpGroupId;
/**
* The name of the group.
*/
groupName?: IpGroupName;
/**
* The description of the group.
*/
groupDesc?: IpGroupDesc;
/**
* The rules.
*/
userRules?: IpRuleList;
}
export type WorkspacesIpGroupsList = WorkspacesIpGroup[];
/**
* 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 = "2015-04-08"|"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 WorkSpaces client.
*/
export import Types = WorkSpaces;
}
export = WorkSpaces;