robomaker.d.ts
87.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
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
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';
interface Blob {}
declare class RoboMaker extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: RoboMaker.Types.ClientConfiguration)
config: Config & RoboMaker.Types.ClientConfiguration;
/**
* Describes one or more simulation jobs.
*/
batchDescribeSimulationJob(params: RoboMaker.Types.BatchDescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
/**
* Describes one or more simulation jobs.
*/
batchDescribeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
/**
* Cancels the specified deployment job.
*/
cancelDeploymentJob(params: RoboMaker.Types.CancelDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
/**
* Cancels the specified deployment job.
*/
cancelDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
/**
* Cancels the specified simulation job.
*/
cancelSimulationJob(params: RoboMaker.Types.CancelSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
/**
* Cancels the specified simulation job.
*/
cancelSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
/**
* Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
*/
createDeploymentJob(params: RoboMaker.Types.CreateDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
/**
* Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
*/
createDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
/**
* Creates a fleet, a logical group of robots running the same robot application.
*/
createFleet(params: RoboMaker.Types.CreateFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
/**
* Creates a fleet, a logical group of robots running the same robot application.
*/
createFleet(callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
/**
* Creates a robot.
*/
createRobot(params: RoboMaker.Types.CreateRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
/**
* Creates a robot.
*/
createRobot(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
/**
* Creates a robot application.
*/
createRobotApplication(params: RoboMaker.Types.CreateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
/**
* Creates a robot application.
*/
createRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
/**
* Creates a version of a robot application.
*/
createRobotApplicationVersion(params: RoboMaker.Types.CreateRobotApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
/**
* Creates a version of a robot application.
*/
createRobotApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
/**
* Creates a simulation application.
*/
createSimulationApplication(params: RoboMaker.Types.CreateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
/**
* Creates a simulation application.
*/
createSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
/**
* Creates a simulation application with a specific revision id.
*/
createSimulationApplicationVersion(params: RoboMaker.Types.CreateSimulationApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
/**
* Creates a simulation application with a specific revision id.
*/
createSimulationApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
/**
* Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
*/
createSimulationJob(params: RoboMaker.Types.CreateSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
/**
* Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
*/
createSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
/**
* Deletes a fleet.
*/
deleteFleet(params: RoboMaker.Types.DeleteFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
/**
* Deletes a fleet.
*/
deleteFleet(callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
/**
* Deletes a robot.
*/
deleteRobot(params: RoboMaker.Types.DeleteRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
/**
* Deletes a robot.
*/
deleteRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
/**
* Deletes a robot application.
*/
deleteRobotApplication(params: RoboMaker.Types.DeleteRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
/**
* Deletes a robot application.
*/
deleteRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
/**
* Deletes a simulation application.
*/
deleteSimulationApplication(params: RoboMaker.Types.DeleteSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
/**
* Deletes a simulation application.
*/
deleteSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
/**
* Deregisters a robot.
*/
deregisterRobot(params: RoboMaker.Types.DeregisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
/**
* Deregisters a robot.
*/
deregisterRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
/**
* Describes a deployment job.
*/
describeDeploymentJob(params: RoboMaker.Types.DescribeDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
/**
* Describes a deployment job.
*/
describeDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
/**
* Describes a fleet.
*/
describeFleet(params: RoboMaker.Types.DescribeFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
/**
* Describes a fleet.
*/
describeFleet(callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
/**
* Describes a robot.
*/
describeRobot(params: RoboMaker.Types.DescribeRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
/**
* Describes a robot.
*/
describeRobot(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
/**
* Describes a robot application.
*/
describeRobotApplication(params: RoboMaker.Types.DescribeRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
/**
* Describes a robot application.
*/
describeRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
/**
* Describes a simulation application.
*/
describeSimulationApplication(params: RoboMaker.Types.DescribeSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
/**
* Describes a simulation application.
*/
describeSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
/**
* Describes a simulation job.
*/
describeSimulationJob(params: RoboMaker.Types.DescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
/**
* Describes a simulation job.
*/
describeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
/**
* Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
*/
listDeploymentJobs(params: RoboMaker.Types.ListDeploymentJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
/**
* Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
*/
listDeploymentJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
/**
* Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
*/
listFleets(params: RoboMaker.Types.ListFleetsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
/**
* Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
*/
listFleets(callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
/**
* Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
*/
listRobotApplications(params: RoboMaker.Types.ListRobotApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
/**
* Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
*/
listRobotApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
/**
* Returns a list of robots. You can optionally provide filters to retrieve specific robots.
*/
listRobots(params: RoboMaker.Types.ListRobotsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
/**
* Returns a list of robots. You can optionally provide filters to retrieve specific robots.
*/
listRobots(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
/**
* Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
*/
listSimulationApplications(params: RoboMaker.Types.ListSimulationApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
/**
* Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
*/
listSimulationApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
/**
* Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
*/
listSimulationJobs(params: RoboMaker.Types.ListSimulationJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
/**
* Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
*/
listSimulationJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
/**
* Lists all tags on a AWS RoboMaker resource.
*/
listTagsForResource(params: RoboMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all tags on a AWS RoboMaker resource.
*/
listTagsForResource(callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Registers a robot with a fleet.
*/
registerRobot(params: RoboMaker.Types.RegisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
/**
* Registers a robot with a fleet.
*/
registerRobot(callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
/**
* Restarts a running simulation job.
*/
restartSimulationJob(params: RoboMaker.Types.RestartSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
/**
* Restarts a running simulation job.
*/
restartSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
/**
* Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
*/
syncDeploymentJob(params: RoboMaker.Types.SyncDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
/**
* Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
*/
syncDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
/**
* Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
*/
tagResource(params: RoboMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
/**
* Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
*/
tagResource(callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
*/
untagResource(params: RoboMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
*/
untagResource(callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
/**
* Updates a robot application.
*/
updateRobotApplication(params: RoboMaker.Types.UpdateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
/**
* Updates a robot application.
*/
updateRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
/**
* Updates a simulation application.
*/
updateSimulationApplication(params: RoboMaker.Types.UpdateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
/**
* Updates a simulation application.
*/
updateSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
}
declare namespace RoboMaker {
export type Architecture = "X86_64"|"ARM64"|"ARMHF"|string;
export type Arn = string;
export type Arns = Arn[];
export interface BatchDescribeSimulationJobRequest {
/**
* A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
*/
jobs: Arns;
}
export interface BatchDescribeSimulationJobResponse {
/**
* A list of simulation jobs.
*/
jobs?: SimulationJobs;
/**
* A list of unprocessed simulation job Amazon Resource Names (ARNs).
*/
unprocessedJobs?: Arns;
}
export type Boolean = boolean;
export type BoxedBoolean = boolean;
export interface CancelDeploymentJobRequest {
/**
* The deployment job ARN to cancel.
*/
job: Arn;
}
export interface CancelDeploymentJobResponse {
}
export interface CancelSimulationJobRequest {
/**
* The simulation job ARN to cancel.
*/
job: Arn;
}
export interface CancelSimulationJobResponse {
}
export type ClientRequestToken = string;
export type Command = string;
export interface CreateDeploymentJobRequest {
/**
* The requested deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken: ClientRequestToken;
/**
* The Amazon Resource Name (ARN) of the fleet to deploy.
*/
fleet: Arn;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs: DeploymentApplicationConfigs;
/**
* A map that contains tag keys and tag values that are attached to the deployment job.
*/
tags?: TagMap;
}
export interface CreateDeploymentJobResponse {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The target fleet for the deployment job.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* The failure reason of the deployment job if it failed.
*/
failureReason?: GenericString;
/**
* The failure code of the simulation job if it failed: BadPermissionError AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy. ExtractingBundleFailure The robot application could not be extracted from the bundle. FailureThresholdBreached The percentage of robots that could not be updated exceeded the percentage set for the deployment. GreengrassDeploymentFailed The robot application could not be deployed to the robot. GreengrassGroupVersionDoesNotExist The AWS Greengrass group or version associated with a robot is missing. InternalServerError An internal error has occurred. Retry your request, but if the problem persists, contact us with details. MissingRobotApplicationArchitecture The robot application does not have a source that matches the architecture of the robot. MissingRobotDeploymentResource One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file? PostLaunchFileFailure The post-launch script failed. PreLaunchFileFailure The pre-launch script failed. ResourceNotFound One or more deployment resources are missing. For example, do robot application source bundles still exist? RobotDeploymentNoResponse There is no response from the robot. It might not be powered on or connected to the internet.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* The list of all tags added to the deployment job.
*/
tags?: TagMap;
}
export interface CreateFleetRequest {
/**
* The name of the fleet.
*/
name: Name;
/**
* A map that contains tag keys and tag values that are attached to the fleet.
*/
tags?: TagMap;
}
export interface CreateFleetResponse {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
arn?: Arn;
/**
* The name of the fleet.
*/
name?: Name;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The list of all tags added to the fleet.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationRequest {
/**
* The name of the robot application.
*/
name: Name;
/**
* The sources of the robot application.
*/
sources: SourceConfigs;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* A map that contains tag keys and tag values that are attached to the robot application.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
/**
* The list of all tags added to the robot application.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationVersionRequest {
/**
* The application information for the robot application.
*/
application: Arn;
/**
* The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.
*/
currentRevisionId?: RevisionId;
}
export interface CreateRobotApplicationVersionResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
}
export interface CreateRobotRequest {
/**
* The name for the robot.
*/
name: Name;
/**
* The target architecture of the robot.
*/
architecture: Architecture;
/**
* The Greengrass group id.
*/
greengrassGroupId: Id;
/**
* A map that contains tag keys and tag values that are attached to the robot.
*/
tags?: TagMap;
}
export interface CreateRobotResponse {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The name of the robot.
*/
name?: Name;
/**
* The time, in milliseconds since the epoch, when the robot was created.
*/
createdAt?: CreatedAt;
/**
* The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
*/
greengrassGroupId?: Id;
/**
* The target architecture of the robot.
*/
architecture?: Architecture;
/**
* The list of all tags added to the robot.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationRequest {
/**
* The name of the simulation application.
*/
name: Name;
/**
* The sources of the simulation application.
*/
sources: SourceConfigs;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite: SimulationSoftwareSuite;
/**
* The robot software suite of the simulation application.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* A map that contains tag keys and tag values that are attached to the simulation application.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the simulation application.
*/
revisionId?: RevisionId;
/**
* The list of all tags added to the simulation application.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationVersionRequest {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.
*/
currentRevisionId?: RevisionId;
}
export interface CreateSimulationApplicationVersionResponse {
/**
* The Amazon Resource Name (ARN) of the simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision ID of the simulation application.
*/
revisionId?: RevisionId;
}
export interface CreateSimulationJobRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Location for output files generated by the simulation job.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.
*/
maxJobDurationInSeconds: JobDuration;
/**
* The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
*/
iamRole: IamRole;
/**
* The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance.
*/
failureBehavior?: FailureBehavior;
/**
* The robot application to use in the simulation job.
*/
robotApplications?: RobotApplicationConfigs;
/**
* The simulation application to use in the simulation job.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job. There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
*/
dataSources?: DataSourceConfigs;
/**
* A map that contains tag keys and tag values that are attached to the simulation job.
*/
tags?: TagMap;
/**
* If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
*/
vpcConfig?: VPCConfig;
}
export interface CreateSimulationJobResponse {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* The time, in milliseconds since the epoch, when the simulation job was last started.
*/
lastStartedAt?: LastStartedAt;
/**
* The time, in milliseconds since the epoch, when the simulation job was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* the failure behavior for the simulation job.
*/
failureBehavior?: FailureBehavior;
/**
* The failure code of the simulation job if it failed: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation.
*/
failureCode?: SimulationJobErrorCode;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Simulation job output files location.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* The maximum simulation job duration in seconds.
*/
maxJobDurationInSeconds?: JobDuration;
/**
* The simulation job execution duration in milliseconds.
*/
simulationTimeMillis?: SimulationTimeMillis;
/**
* The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
*/
iamRole?: IamRole;
/**
* The robot application used by the simulation job.
*/
robotApplications?: RobotApplicationConfigs;
/**
* The simulation application used by the simulation job.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job.
*/
dataSources?: DataSources;
/**
* The list of all tags added to the simulation job.
*/
tags?: TagMap;
/**
* Information about the vpc configuration.
*/
vpcConfig?: VPCConfigResponse;
}
export type CreatedAt = Date;
export interface DataSource {
/**
* The name of the data source.
*/
name?: Name;
/**
* The S3 bucket where the data files are located.
*/
s3Bucket?: S3Bucket;
/**
* The list of S3 keys identifying the data source files.
*/
s3Keys?: S3KeyOutputs;
}
export interface DataSourceConfig {
/**
* The name of the data source.
*/
name: Name;
/**
* The S3 bucket where the data files are located.
*/
s3Bucket: S3Bucket;
/**
* The list of S3 keys identifying the data source files.
*/
s3Keys: S3Keys;
}
export type DataSourceConfigs = DataSourceConfig[];
export type DataSourceNames = Name[];
export type DataSources = DataSource[];
export interface DeleteFleetRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
}
export interface DeleteFleetResponse {
}
export interface DeleteRobotApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the the robot application.
*/
application: Arn;
/**
* The version of the robot application to delete.
*/
applicationVersion?: Version;
}
export interface DeleteRobotApplicationResponse {
}
export interface DeleteRobotRequest {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot: Arn;
}
export interface DeleteRobotResponse {
}
export interface DeleteSimulationApplicationRequest {
/**
* The application information for the simulation application to delete.
*/
application: Arn;
/**
* The version of the simulation application to delete.
*/
applicationVersion?: Version;
}
export interface DeleteSimulationApplicationResponse {
}
export interface DeploymentApplicationConfig {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
application: Arn;
/**
* The version of the application.
*/
applicationVersion: DeploymentVersion;
/**
* The launch configuration.
*/
launchConfig: DeploymentLaunchConfig;
}
export type DeploymentApplicationConfigs = DeploymentApplicationConfig[];
export interface DeploymentConfig {
/**
* The percentage of robots receiving the deployment at the same time.
*/
concurrentDeploymentPercentage?: Percentage;
/**
* The percentage of deployments that need to fail before stopping deployment.
*/
failureThresholdPercentage?: Percentage;
/**
* The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
*/
robotDeploymentTimeoutInSeconds?: DeploymentTimeout;
/**
* The download condition file.
*/
downloadConditionFile?: S3Object;
}
export interface DeploymentJob {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* A short description of the reason why the deployment job failed.
*/
failureReason?: GenericString;
/**
* The deployment job failure code.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the deployment job was created.
*/
createdAt?: CreatedAt;
}
export type DeploymentJobErrorCode = "ResourceNotFound"|"EnvironmentSetupError"|"EtagMismatch"|"FailureThresholdBreached"|"RobotDeploymentAborted"|"RobotDeploymentNoResponse"|"RobotAgentConnectionTimeout"|"GreengrassDeploymentFailed"|"MissingRobotArchitecture"|"MissingRobotApplicationArchitecture"|"MissingRobotDeploymentResource"|"GreengrassGroupVersionDoesNotExist"|"ExtractingBundleFailure"|"PreLaunchFileFailure"|"PostLaunchFileFailure"|"BadPermissionError"|"DownloadConditionFailed"|"InternalServerError"|string;
export type DeploymentJobs = DeploymentJob[];
export interface DeploymentLaunchConfig {
/**
* The package name.
*/
packageName: Command;
/**
* The deployment pre-launch file. This file will be executed prior to the launch file.
*/
preLaunchFile?: Path;
/**
* The launch file name.
*/
launchFile: Command;
/**
* The deployment post-launch file. This file will be executed after the launch file.
*/
postLaunchFile?: Path;
/**
* An array of key/value pairs specifying environment variables for the robot application
*/
environmentVariables?: EnvironmentVariableMap;
}
export type DeploymentStatus = "Pending"|"Preparing"|"InProgress"|"Failed"|"Succeeded"|"Canceled"|string;
export type DeploymentTimeout = number;
export type DeploymentVersion = string;
export interface DeregisterRobotRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot: Arn;
}
export interface DeregisterRobotResponse {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot?: Arn;
}
export interface DescribeDeploymentJobRequest {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
job: Arn;
}
export interface DescribeDeploymentJobResponse {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* A short description of the reason why the deployment job failed.
*/
failureReason?: GenericString;
/**
* The deployment job failure code.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the deployment job was created.
*/
createdAt?: CreatedAt;
/**
* A list of robot deployment summaries.
*/
robotDeploymentSummary?: RobotDeploymentSummary;
/**
* The list of all tags added to the specified deployment job.
*/
tags?: TagMap;
}
export interface DescribeFleetRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
}
export interface DescribeFleetResponse {
/**
* The name of the fleet.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
arn?: Arn;
/**
* A list of robots.
*/
robots?: Robots;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The status of the last deployment.
*/
lastDeploymentStatus?: DeploymentStatus;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment.
*/
lastDeploymentTime?: CreatedAt;
/**
* The list of all tags added to the specified fleet.
*/
tags?: TagMap;
}
export interface DescribeRobotApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
application: Arn;
/**
* The version of the robot application to describe.
*/
applicationVersion?: Version;
}
export interface DescribeRobotApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The list of all tags added to the specified robot application.
*/
tags?: TagMap;
}
export interface DescribeRobotRequest {
/**
* The Amazon Resource Name (ARN) of the robot to be described.
*/
robot: Arn;
}
export interface DescribeRobotResponse {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The name of the robot.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleetArn?: Arn;
/**
* The status of the fleet.
*/
status?: RobotStatus;
/**
* The Greengrass group id.
*/
greengrassGroupId?: Id;
/**
* The time, in milliseconds since the epoch, when the robot was created.
*/
createdAt?: CreatedAt;
/**
* The target architecture of the robot application.
*/
architecture?: Architecture;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment job.
*/
lastDeploymentTime?: CreatedAt;
/**
* The list of all tags added to the specified robot.
*/
tags?: TagMap;
}
export interface DescribeSimulationApplicationRequest {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* The version of the simulation application to describe.
*/
applicationVersion?: Version;
}
export interface DescribeSimulationApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The revision id of the simulation application.
*/
revisionId?: RevisionId;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The list of all tags added to the specified simulation application.
*/
tags?: TagMap;
}
export interface DescribeSimulationJobRequest {
/**
* The Amazon Resource Name (ARN) of the simulation job to be described.
*/
job: Arn;
}
export interface DescribeSimulationJobResponse {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The name of the simulation job.
*/
name?: Name;
/**
* The status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* The time, in milliseconds since the epoch, when the simulation job was last started.
*/
lastStartedAt?: LastStartedAt;
/**
* The time, in milliseconds since the epoch, when the simulation job was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The failure behavior for the simulation job.
*/
failureBehavior?: FailureBehavior;
/**
* The failure code of the simulation job if it failed: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation.
*/
failureCode?: SimulationJobErrorCode;
/**
* Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
*/
failureReason?: GenericString;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Location for output files generated by the simulation job.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
*/
maxJobDurationInSeconds?: JobDuration;
/**
* The simulation job execution duration in milliseconds.
*/
simulationTimeMillis?: SimulationTimeMillis;
/**
* The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
*/
iamRole?: IamRole;
/**
* A list of robot applications.
*/
robotApplications?: RobotApplicationConfigs;
/**
* A list of simulation applications.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job.
*/
dataSources?: DataSources;
/**
* The list of all tags added to the specified simulation job.
*/
tags?: TagMap;
/**
* The VPC configuration.
*/
vpcConfig?: VPCConfigResponse;
/**
* The network interface information for the simulation job.
*/
networkInterface?: NetworkInterface;
}
export type EnvironmentVariableKey = string;
export type EnvironmentVariableMap = {[key: string]: EnvironmentVariableValue};
export type EnvironmentVariableValue = string;
export type FailureBehavior = "Fail"|"Continue"|string;
export interface Filter {
/**
* The name of the filter.
*/
name?: Name;
/**
* A list of values.
*/
values?: FilterValues;
}
export type FilterValues = Name[];
export type Filters = Filter[];
export interface Fleet {
/**
* The name of the fleet.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
arn?: Arn;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The status of the last fleet deployment.
*/
lastDeploymentStatus?: DeploymentStatus;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment.
*/
lastDeploymentTime?: CreatedAt;
}
export type Fleets = Fleet[];
export type GenericInteger = number;
export type GenericString = string;
export type IamRole = string;
export type Id = string;
export type JobDuration = number;
export type LastStartedAt = Date;
export type LastUpdatedAt = Date;
export interface LaunchConfig {
/**
* The package name.
*/
packageName: Command;
/**
* The launch file name.
*/
launchFile: Command;
/**
* The environment variables for the application launch.
*/
environmentVariables?: EnvironmentVariableMap;
/**
* The port forwarding configuration.
*/
portForwardingConfig?: PortForwardingConfig;
}
export interface ListDeploymentJobsRequest {
/**
* Optional filters to limit results. The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.
*/
filters?: Filters;
/**
* The nextToken value returned from a previous paginated ListDeploymentJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListDeploymentJobs in paginated output. When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListDeploymentJobs returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
}
export interface ListDeploymentJobsResponse {
/**
* A list of deployment jobs that meet the criteria of the request.
*/
deploymentJobs?: DeploymentJobs;
/**
* The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListFleetsRequest {
/**
* The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListFleets in paginated output. When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListFleets returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
/**
* Optional filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
*/
filters?: Filters;
}
export interface ListFleetsResponse {
/**
* A list of fleet details meeting the request criteria.
*/
fleetDetails?: Fleets;
/**
* The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListRobotApplicationsRequest {
/**
* The version qualifier of the robot application.
*/
versionQualifier?: VersionQualifier;
/**
* The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListRobotApplications in paginated output. When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
/**
* Optional filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
*/
filters?: Filters;
}
export interface ListRobotApplicationsResponse {
/**
* A list of robot application summaries that meet the criteria of the request.
*/
robotApplicationSummaries?: RobotApplicationSummaries;
/**
* The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListRobotsRequest {
/**
* The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
/**
* Optional filters to limit results. The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.
*/
filters?: Filters;
}
export interface ListRobotsResponse {
/**
* A list of robots that meet the criteria of the request.
*/
robots?: Robots;
/**
* The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListSimulationApplicationsRequest {
/**
* The version qualifier of the simulation application.
*/
versionQualifier?: VersionQualifier;
/**
* The nextToken value returned from a previous paginated ListSimulationApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListSimulationApplications in paginated output. When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
/**
* Optional list of filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
*/
filters?: Filters;
}
export interface ListSimulationApplicationsResponse {
/**
* A list of simulation application summaries that meet the criteria of the request.
*/
simulationApplicationSummaries?: SimulationApplicationSummaries;
/**
* The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListSimulationJobsRequest {
/**
* The nextToken value returned from a previous paginated ListSimulationJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The maximum number of deployment job results returned by ListSimulationJobs in paginated output. When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable.
*/
maxResults?: MaxResults;
/**
* Optional filters to limit results. The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.
*/
filters?: Filters;
}
export interface ListSimulationJobsResponse {
/**
* A list of simulation job summaries that meet the criteria of the request.
*/
simulationJobSummaries: SimulationJobSummaries;
/**
* The nextToken value to include in a future ListSimulationJobs request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
*/
resourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The list of all tags added to the specified resource.
*/
tags?: TagMap;
}
export interface LoggingConfig {
/**
* A boolean indicating whether to record all ROS topics.
*/
recordAllRosTopics: BoxedBoolean;
}
export type MaxResults = number;
export type Name = string;
export interface NetworkInterface {
/**
* The ID of the network interface.
*/
networkInterfaceId?: GenericString;
/**
* The IPv4 address of the network interface within the subnet.
*/
privateIpAddress?: GenericString;
/**
* The IPv4 public address of the network interface.
*/
publicIpAddress?: GenericString;
}
export type NonEmptyString = string;
export type NonSystemPort = number;
export interface OutputLocation {
/**
* The S3 bucket for output.
*/
s3Bucket?: S3Bucket;
/**
* The S3 folder in the s3Bucket where output files will be placed.
*/
s3Prefix?: S3Key;
}
export type PaginationToken = string;
export type Path = string;
export type PercentDone = number;
export type Percentage = number;
export type Port = number;
export interface PortForwardingConfig {
/**
* The port mappings for the configuration.
*/
portMappings?: PortMappingList;
}
export interface PortMapping {
/**
* The port number on the simulation job instance to use as a remote connection point.
*/
jobPort: Port;
/**
* The port number on the application.
*/
applicationPort: NonSystemPort;
/**
* A Boolean indicating whether to enable this port mapping on public IP.
*/
enableOnPublicIp?: Boolean;
}
export type PortMappingList = PortMapping[];
export interface ProgressDetail {
/**
* The current progress status. Validating Validating the deployment. DownloadingExtracting Downloading and extracting the bundle on the robot. ExecutingPreLaunch Executing pre-launch script(s) if provided. Launching Launching the robot application. ExecutingPostLaunch Executing post-launch script(s) if provided. Finished Deployment is complete.
*/
currentProgress?: RobotDeploymentStep;
/**
* Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.
*/
percentDone?: PercentDone;
/**
* Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.
*/
estimatedTimeRemainingSeconds?: GenericInteger;
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
targetResource?: GenericString;
}
export interface RegisterRobotRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot: Arn;
}
export interface RegisterRobotResponse {
/**
* The Amazon Resource Name (ARN) of the fleet that the robot will join.
*/
fleet?: Arn;
/**
* Information about the robot registration.
*/
robot?: Arn;
}
export interface RenderingEngine {
/**
* The name of the rendering engine.
*/
name?: RenderingEngineType;
/**
* The version of the rendering engine.
*/
version?: RenderingEngineVersionType;
}
export type RenderingEngineType = "OGRE"|string;
export type RenderingEngineVersionType = string;
export interface RestartSimulationJobRequest {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
job: Arn;
}
export interface RestartSimulationJobResponse {
}
export type RevisionId = string;
export interface Robot {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The name of the robot.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleetArn?: Arn;
/**
* The status of the robot.
*/
status?: RobotStatus;
/**
* The Greengrass group associated with the robot.
*/
greenGrassGroupId?: Id;
/**
* The time, in milliseconds since the epoch, when the robot was created.
*/
createdAt?: CreatedAt;
/**
* The architecture of the robot.
*/
architecture?: Architecture;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment.
*/
lastDeploymentTime?: CreatedAt;
}
export interface RobotApplicationConfig {
/**
* The application information for the robot application.
*/
application: Arn;
/**
* The version of the robot application.
*/
applicationVersion?: Version;
/**
* The launch configuration for the robot application.
*/
launchConfig: LaunchConfig;
}
export type RobotApplicationConfigs = RobotApplicationConfig[];
export type RobotApplicationNames = Name[];
export type RobotApplicationSummaries = RobotApplicationSummary[];
export interface RobotApplicationSummary {
/**
* The name of the robot application.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* Information about a robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
}
export interface RobotDeployment {
/**
* The robot deployment Amazon Resource Name (ARN).
*/
arn?: Arn;
/**
* The time, in milliseconds since the epoch, when the deployment was started.
*/
deploymentStartTime?: CreatedAt;
/**
* The time, in milliseconds since the epoch, when the deployment finished.
*/
deploymentFinishTime?: CreatedAt;
/**
* The status of the robot deployment.
*/
status?: RobotStatus;
/**
* Information about how the deployment is progressing.
*/
progressDetail?: ProgressDetail;
/**
* A short description of the reason why the robot deployment failed.
*/
failureReason?: GenericString;
/**
* The robot deployment failure code.
*/
failureCode?: DeploymentJobErrorCode;
}
export type RobotDeploymentStep = "Validating"|"DownloadingExtracting"|"ExecutingDownloadCondition"|"ExecutingPreLaunch"|"Launching"|"ExecutingPostLaunch"|"Finished"|string;
export type RobotDeploymentSummary = RobotDeployment[];
export interface RobotSoftwareSuite {
/**
* The name of the robot software suite.
*/
name?: RobotSoftwareSuiteType;
/**
* The version of the robot software suite.
*/
version?: RobotSoftwareSuiteVersionType;
}
export type RobotSoftwareSuiteType = "ROS"|"ROS2"|string;
export type RobotSoftwareSuiteVersionType = "Kinetic"|"Melodic"|"Dashing"|string;
export type RobotStatus = "Available"|"Registered"|"PendingNewDeployment"|"Deploying"|"Failed"|"InSync"|"NoResponse"|string;
export type Robots = Robot[];
export type S3Bucket = string;
export type S3Etag = string;
export type S3Key = string;
export interface S3KeyOutput {
/**
* The S3 key.
*/
s3Key?: S3Key;
/**
* The etag for the object.
*/
etag?: S3Etag;
}
export type S3KeyOutputs = S3KeyOutput[];
export type S3Keys = S3Key[];
export interface S3Object {
/**
* The bucket containing the object.
*/
bucket: S3Bucket;
/**
* The key of the object.
*/
key: S3Key;
/**
* The etag of the object.
*/
etag?: S3Etag;
}
export type SecurityGroups = NonEmptyString[];
export interface SimulationApplicationConfig {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* The version of the simulation application.
*/
applicationVersion?: Version;
/**
* The launch configuration for the simulation application.
*/
launchConfig: LaunchConfig;
}
export type SimulationApplicationConfigs = SimulationApplicationConfig[];
export type SimulationApplicationNames = Name[];
export type SimulationApplicationSummaries = SimulationApplicationSummary[];
export interface SimulationApplicationSummary {
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the simulation application.
*/
arn?: Arn;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* Information about a robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* Information about a simulation software suite.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
}
export interface SimulationJob {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The name of the simulation job.
*/
name?: Name;
/**
* Status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* The time, in milliseconds since the epoch, when the simulation job was last started.
*/
lastStartedAt?: LastStartedAt;
/**
* The time, in milliseconds since the epoch, when the simulation job was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance.
*/
failureBehavior?: FailureBehavior;
/**
* The failure code of the simulation job if it failed.
*/
failureCode?: SimulationJobErrorCode;
/**
* The reason why the simulation job failed.
*/
failureReason?: GenericString;
/**
* A unique identifier for this SimulationJob request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Location for output files generated by the simulation job.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
*/
maxJobDurationInSeconds?: JobDuration;
/**
* The simulation job execution duration in milliseconds.
*/
simulationTimeMillis?: SimulationTimeMillis;
/**
* The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
*/
iamRole?: IamRole;
/**
* A list of robot applications.
*/
robotApplications?: RobotApplicationConfigs;
/**
* A list of simulation applications.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job.
*/
dataSources?: DataSources;
/**
* A map that contains tag keys and tag values that are attached to the simulation job.
*/
tags?: TagMap;
/**
* VPC configuration information.
*/
vpcConfig?: VPCConfigResponse;
/**
* Information about a network interface.
*/
networkInterface?: NetworkInterface;
}
export type SimulationJobErrorCode = "InternalServiceError"|"RobotApplicationCrash"|"SimulationApplicationCrash"|"BadPermissionsRobotApplication"|"BadPermissionsSimulationApplication"|"BadPermissionsS3Object"|"BadPermissionsS3Output"|"BadPermissionsCloudwatchLogs"|"SubnetIpLimitExceeded"|"ENILimitExceeded"|"BadPermissionsUserCredentials"|"InvalidBundleRobotApplication"|"InvalidBundleSimulationApplication"|"InvalidS3Resource"|"MismatchedEtag"|"RobotApplicationVersionMismatchedEtag"|"SimulationApplicationVersionMismatchedEtag"|"ResourceNotFound"|"InvalidInput"|"WrongRegionS3Bucket"|"WrongRegionS3Output"|"WrongRegionRobotApplication"|"WrongRegionSimulationApplication"|string;
export type SimulationJobStatus = "Pending"|"Preparing"|"Running"|"Restarting"|"Completed"|"Failed"|"RunningFailed"|"Terminating"|"Terminated"|"Canceled"|string;
export type SimulationJobSummaries = SimulationJobSummary[];
export interface SimulationJobSummary {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The time, in milliseconds since the epoch, when the simulation job was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The name of the simulation job.
*/
name?: Name;
/**
* The status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* A list of simulation job simulation application names.
*/
simulationApplicationNames?: SimulationApplicationNames;
/**
* A list of simulation job robot application names.
*/
robotApplicationNames?: RobotApplicationNames;
/**
* The names of the data sources.
*/
dataSourceNames?: DataSourceNames;
}
export type SimulationJobs = SimulationJob[];
export interface SimulationSoftwareSuite {
/**
* The name of the simulation software suite.
*/
name?: SimulationSoftwareSuiteType;
/**
* The version of the simulation software suite.
*/
version?: SimulationSoftwareSuiteVersionType;
}
export type SimulationSoftwareSuiteType = "Gazebo"|"RosbagPlay"|string;
export type SimulationSoftwareSuiteVersionType = string;
export type SimulationTimeMillis = number;
export interface Source {
/**
* The s3 bucket name.
*/
s3Bucket?: S3Bucket;
/**
* The s3 object key.
*/
s3Key?: S3Key;
/**
* A hash of the object specified by s3Bucket and s3Key.
*/
etag?: S3Etag;
/**
* The taget processor architecture for the application.
*/
architecture?: Architecture;
}
export interface SourceConfig {
/**
* The Amazon S3 bucket name.
*/
s3Bucket?: S3Bucket;
/**
* The s3 object key.
*/
s3Key?: S3Key;
/**
* The target processor architecture for the application.
*/
architecture?: Architecture;
}
export type SourceConfigs = SourceConfig[];
export type Sources = Source[];
export type Subnets = NonEmptyString[];
export interface SyncDeploymentJobRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken: ClientRequestToken;
/**
* The target fleet for the synchronization.
*/
fleet: Arn;
}
export interface SyncDeploymentJobResponse {
/**
* The Amazon Resource Name (ARN) of the synchronization request.
*/
arn?: Arn;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The status of the synchronization job.
*/
status?: DeploymentStatus;
/**
* Information about the deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* Information about the deployment application configurations.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* The failure reason if the job fails.
*/
failureReason?: GenericString;
/**
* The failure code if the job fails: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
*/
resourceArn: Arn;
/**
* A map that contains tag keys and tag values that are attached to the resource.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
*/
resourceArn: Arn;
/**
* A map that contains tag keys and tag values that will be unattached from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateRobotApplicationRequest {
/**
* The application information for the robot application.
*/
application: Arn;
/**
* The sources of the robot application.
*/
sources: SourceConfigs;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* The revision id for the robot application.
*/
currentRevisionId?: RevisionId;
}
export interface UpdateRobotApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the updated robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
}
export interface UpdateSimulationApplicationRequest {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* The sources of the simulation application.
*/
sources: SourceConfigs;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The revision id for the robot application.
*/
currentRevisionId?: RevisionId;
}
export interface UpdateSimulationApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the updated simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the simulation application.
*/
revisionId?: RevisionId;
}
export interface VPCConfig {
/**
* A list of one or more subnet IDs in your VPC.
*/
subnets: Subnets;
/**
* A list of one or more security groups IDs in your VPC.
*/
securityGroups?: SecurityGroups;
/**
* A boolean indicating whether to assign a public IP address.
*/
assignPublicIp?: Boolean;
}
export interface VPCConfigResponse {
/**
* A list of subnet IDs associated with the simulation job.
*/
subnets?: Subnets;
/**
* A list of security group IDs associated with the simulation job.
*/
securityGroups?: SecurityGroups;
/**
* The VPC ID associated with your simulation job.
*/
vpcId?: GenericString;
/**
* A boolean indicating if a public IP was assigned.
*/
assignPublicIp?: Boolean;
}
export type Version = string;
export type VersionQualifier = string;
/**
* 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 = "2018-06-29"|"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 RoboMaker client.
*/
export import Types = RoboMaker;
}
export = RoboMaker;