devicefarm.d.ts
154 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
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
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 DeviceFarm extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DeviceFarm.Types.ClientConfiguration)
config: Config & DeviceFarm.Types.ClientConfiguration;
/**
* Creates a device pool.
*/
createDevicePool(params: DeviceFarm.Types.CreateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request<DeviceFarm.Types.CreateDevicePoolResult, AWSError>;
/**
* Creates a device pool.
*/
createDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request<DeviceFarm.Types.CreateDevicePoolResult, AWSError>;
/**
* Creates a profile that can be applied to one or more private fleet device instances.
*/
createInstanceProfile(params: DeviceFarm.Types.CreateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request<DeviceFarm.Types.CreateInstanceProfileResult, AWSError>;
/**
* Creates a profile that can be applied to one or more private fleet device instances.
*/
createInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request<DeviceFarm.Types.CreateInstanceProfileResult, AWSError>;
/**
* Creates a network profile.
*/
createNetworkProfile(params: DeviceFarm.Types.CreateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request<DeviceFarm.Types.CreateNetworkProfileResult, AWSError>;
/**
* Creates a network profile.
*/
createNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request<DeviceFarm.Types.CreateNetworkProfileResult, AWSError>;
/**
* Creates a new project.
*/
createProject(params: DeviceFarm.Types.CreateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request<DeviceFarm.Types.CreateProjectResult, AWSError>;
/**
* Creates a new project.
*/
createProject(callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request<DeviceFarm.Types.CreateProjectResult, AWSError>;
/**
* Specifies and starts a remote access session.
*/
createRemoteAccessSession(params: DeviceFarm.Types.CreateRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.CreateRemoteAccessSessionResult, AWSError>;
/**
* Specifies and starts a remote access session.
*/
createRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.CreateRemoteAccessSessionResult, AWSError>;
/**
* Uploads an app or test scripts.
*/
createUpload(params: DeviceFarm.Types.CreateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request<DeviceFarm.Types.CreateUploadResult, AWSError>;
/**
* Uploads an app or test scripts.
*/
createUpload(callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request<DeviceFarm.Types.CreateUploadResult, AWSError>;
/**
* Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
createVPCEConfiguration(params: DeviceFarm.Types.CreateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.CreateVPCEConfigurationResult, AWSError>;
/**
* Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
createVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.CreateVPCEConfigurationResult, AWSError>;
/**
* Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
*/
deleteDevicePool(params: DeviceFarm.Types.DeleteDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request<DeviceFarm.Types.DeleteDevicePoolResult, AWSError>;
/**
* Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
*/
deleteDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request<DeviceFarm.Types.DeleteDevicePoolResult, AWSError>;
/**
* Deletes a profile that can be applied to one or more private device instances.
*/
deleteInstanceProfile(params: DeviceFarm.Types.DeleteInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request<DeviceFarm.Types.DeleteInstanceProfileResult, AWSError>;
/**
* Deletes a profile that can be applied to one or more private device instances.
*/
deleteInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request<DeviceFarm.Types.DeleteInstanceProfileResult, AWSError>;
/**
* Deletes a network profile.
*/
deleteNetworkProfile(params: DeviceFarm.Types.DeleteNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request<DeviceFarm.Types.DeleteNetworkProfileResult, AWSError>;
/**
* Deletes a network profile.
*/
deleteNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request<DeviceFarm.Types.DeleteNetworkProfileResult, AWSError>;
/**
* Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run.
*/
deleteProject(params: DeviceFarm.Types.DeleteProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request<DeviceFarm.Types.DeleteProjectResult, AWSError>;
/**
* Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run.
*/
deleteProject(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request<DeviceFarm.Types.DeleteProjectResult, AWSError>;
/**
* Deletes a completed remote access session and its results.
*/
deleteRemoteAccessSession(params: DeviceFarm.Types.DeleteRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.DeleteRemoteAccessSessionResult, AWSError>;
/**
* Deletes a completed remote access session and its results.
*/
deleteRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.DeleteRemoteAccessSessionResult, AWSError>;
/**
* Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run.
*/
deleteRun(params: DeviceFarm.Types.DeleteRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request<DeviceFarm.Types.DeleteRunResult, AWSError>;
/**
* Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run.
*/
deleteRun(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request<DeviceFarm.Types.DeleteRunResult, AWSError>;
/**
* Deletes an upload given the upload ARN.
*/
deleteUpload(params: DeviceFarm.Types.DeleteUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request<DeviceFarm.Types.DeleteUploadResult, AWSError>;
/**
* Deletes an upload given the upload ARN.
*/
deleteUpload(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request<DeviceFarm.Types.DeleteUploadResult, AWSError>;
/**
* Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
deleteVPCEConfiguration(params: DeviceFarm.Types.DeleteVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request<DeviceFarm.Types.DeleteVPCEConfigurationResult, AWSError>;
/**
* Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
deleteVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request<DeviceFarm.Types.DeleteVPCEConfigurationResult, AWSError>;
/**
* Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
*/
getAccountSettings(params: DeviceFarm.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request<DeviceFarm.Types.GetAccountSettingsResult, AWSError>;
/**
* Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
*/
getAccountSettings(callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request<DeviceFarm.Types.GetAccountSettingsResult, AWSError>;
/**
* Gets information about a unique device type.
*/
getDevice(params: DeviceFarm.Types.GetDeviceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request<DeviceFarm.Types.GetDeviceResult, AWSError>;
/**
* Gets information about a unique device type.
*/
getDevice(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request<DeviceFarm.Types.GetDeviceResult, AWSError>;
/**
* Returns information about a device instance belonging to a private device fleet.
*/
getDeviceInstance(params: DeviceFarm.Types.GetDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request<DeviceFarm.Types.GetDeviceInstanceResult, AWSError>;
/**
* Returns information about a device instance belonging to a private device fleet.
*/
getDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request<DeviceFarm.Types.GetDeviceInstanceResult, AWSError>;
/**
* Gets information about a device pool.
*/
getDevicePool(params: DeviceFarm.Types.GetDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request<DeviceFarm.Types.GetDevicePoolResult, AWSError>;
/**
* Gets information about a device pool.
*/
getDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request<DeviceFarm.Types.GetDevicePoolResult, AWSError>;
/**
* Gets information about compatibility with a device pool.
*/
getDevicePoolCompatibility(params: DeviceFarm.Types.GetDevicePoolCompatibilityRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request<DeviceFarm.Types.GetDevicePoolCompatibilityResult, AWSError>;
/**
* Gets information about compatibility with a device pool.
*/
getDevicePoolCompatibility(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request<DeviceFarm.Types.GetDevicePoolCompatibilityResult, AWSError>;
/**
* Returns information about the specified instance profile.
*/
getInstanceProfile(params: DeviceFarm.Types.GetInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request<DeviceFarm.Types.GetInstanceProfileResult, AWSError>;
/**
* Returns information about the specified instance profile.
*/
getInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request<DeviceFarm.Types.GetInstanceProfileResult, AWSError>;
/**
* Gets information about a job.
*/
getJob(params: DeviceFarm.Types.GetJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request<DeviceFarm.Types.GetJobResult, AWSError>;
/**
* Gets information about a job.
*/
getJob(callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request<DeviceFarm.Types.GetJobResult, AWSError>;
/**
* Returns information about a network profile.
*/
getNetworkProfile(params: DeviceFarm.Types.GetNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request<DeviceFarm.Types.GetNetworkProfileResult, AWSError>;
/**
* Returns information about a network profile.
*/
getNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request<DeviceFarm.Types.GetNetworkProfileResult, AWSError>;
/**
* Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
getOfferingStatus(params: DeviceFarm.Types.GetOfferingStatusRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request<DeviceFarm.Types.GetOfferingStatusResult, AWSError>;
/**
* Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
getOfferingStatus(callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request<DeviceFarm.Types.GetOfferingStatusResult, AWSError>;
/**
* Gets information about a project.
*/
getProject(params: DeviceFarm.Types.GetProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request<DeviceFarm.Types.GetProjectResult, AWSError>;
/**
* Gets information about a project.
*/
getProject(callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request<DeviceFarm.Types.GetProjectResult, AWSError>;
/**
* Returns a link to a currently running remote access session.
*/
getRemoteAccessSession(params: DeviceFarm.Types.GetRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.GetRemoteAccessSessionResult, AWSError>;
/**
* Returns a link to a currently running remote access session.
*/
getRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.GetRemoteAccessSessionResult, AWSError>;
/**
* Gets information about a run.
*/
getRun(params: DeviceFarm.Types.GetRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request<DeviceFarm.Types.GetRunResult, AWSError>;
/**
* Gets information about a run.
*/
getRun(callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request<DeviceFarm.Types.GetRunResult, AWSError>;
/**
* Gets information about a suite.
*/
getSuite(params: DeviceFarm.Types.GetSuiteRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request<DeviceFarm.Types.GetSuiteResult, AWSError>;
/**
* Gets information about a suite.
*/
getSuite(callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request<DeviceFarm.Types.GetSuiteResult, AWSError>;
/**
* Gets information about a test.
*/
getTest(params: DeviceFarm.Types.GetTestRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request<DeviceFarm.Types.GetTestResult, AWSError>;
/**
* Gets information about a test.
*/
getTest(callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request<DeviceFarm.Types.GetTestResult, AWSError>;
/**
* Gets information about an upload.
*/
getUpload(params: DeviceFarm.Types.GetUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request<DeviceFarm.Types.GetUploadResult, AWSError>;
/**
* Gets information about an upload.
*/
getUpload(callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request<DeviceFarm.Types.GetUploadResult, AWSError>;
/**
* Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
getVPCEConfiguration(params: DeviceFarm.Types.GetVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request<DeviceFarm.Types.GetVPCEConfigurationResult, AWSError>;
/**
* Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
*/
getVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request<DeviceFarm.Types.GetVPCEConfigurationResult, AWSError>;
/**
* Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
*/
installToRemoteAccessSession(params: DeviceFarm.Types.InstallToRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.InstallToRemoteAccessSessionResult, AWSError>;
/**
* Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
*/
installToRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.InstallToRemoteAccessSessionResult, AWSError>;
/**
* Gets information about artifacts.
*/
listArtifacts(params: DeviceFarm.Types.ListArtifactsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request<DeviceFarm.Types.ListArtifactsResult, AWSError>;
/**
* Gets information about artifacts.
*/
listArtifacts(callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request<DeviceFarm.Types.ListArtifactsResult, AWSError>;
/**
* Returns information about the private device instances associated with one or more AWS accounts.
*/
listDeviceInstances(params: DeviceFarm.Types.ListDeviceInstancesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request<DeviceFarm.Types.ListDeviceInstancesResult, AWSError>;
/**
* Returns information about the private device instances associated with one or more AWS accounts.
*/
listDeviceInstances(callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request<DeviceFarm.Types.ListDeviceInstancesResult, AWSError>;
/**
* Gets information about device pools.
*/
listDevicePools(params: DeviceFarm.Types.ListDevicePoolsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request<DeviceFarm.Types.ListDevicePoolsResult, AWSError>;
/**
* Gets information about device pools.
*/
listDevicePools(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request<DeviceFarm.Types.ListDevicePoolsResult, AWSError>;
/**
* Gets information about unique device types.
*/
listDevices(params: DeviceFarm.Types.ListDevicesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request<DeviceFarm.Types.ListDevicesResult, AWSError>;
/**
* Gets information about unique device types.
*/
listDevices(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request<DeviceFarm.Types.ListDevicesResult, AWSError>;
/**
* Returns information about all the instance profiles in an AWS account.
*/
listInstanceProfiles(params: DeviceFarm.Types.ListInstanceProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request<DeviceFarm.Types.ListInstanceProfilesResult, AWSError>;
/**
* Returns information about all the instance profiles in an AWS account.
*/
listInstanceProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request<DeviceFarm.Types.ListInstanceProfilesResult, AWSError>;
/**
* Gets information about jobs for a given test run.
*/
listJobs(params: DeviceFarm.Types.ListJobsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request<DeviceFarm.Types.ListJobsResult, AWSError>;
/**
* Gets information about jobs for a given test run.
*/
listJobs(callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request<DeviceFarm.Types.ListJobsResult, AWSError>;
/**
* Returns the list of available network profiles.
*/
listNetworkProfiles(params: DeviceFarm.Types.ListNetworkProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request<DeviceFarm.Types.ListNetworkProfilesResult, AWSError>;
/**
* Returns the list of available network profiles.
*/
listNetworkProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request<DeviceFarm.Types.ListNetworkProfilesResult, AWSError>;
/**
* Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferingPromotions(params: DeviceFarm.Types.ListOfferingPromotionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request<DeviceFarm.Types.ListOfferingPromotionsResult, AWSError>;
/**
* Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferingPromotions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request<DeviceFarm.Types.ListOfferingPromotionsResult, AWSError>;
/**
* Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferingTransactions(params: DeviceFarm.Types.ListOfferingTransactionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request<DeviceFarm.Types.ListOfferingTransactionsResult, AWSError>;
/**
* Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferingTransactions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request<DeviceFarm.Types.ListOfferingTransactionsResult, AWSError>;
/**
* Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferings(params: DeviceFarm.Types.ListOfferingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request<DeviceFarm.Types.ListOfferingsResult, AWSError>;
/**
* Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
listOfferings(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request<DeviceFarm.Types.ListOfferingsResult, AWSError>;
/**
* Gets information about projects.
*/
listProjects(params: DeviceFarm.Types.ListProjectsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request<DeviceFarm.Types.ListProjectsResult, AWSError>;
/**
* Gets information about projects.
*/
listProjects(callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request<DeviceFarm.Types.ListProjectsResult, AWSError>;
/**
* Returns a list of all currently running remote access sessions.
*/
listRemoteAccessSessions(params: DeviceFarm.Types.ListRemoteAccessSessionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request<DeviceFarm.Types.ListRemoteAccessSessionsResult, AWSError>;
/**
* Returns a list of all currently running remote access sessions.
*/
listRemoteAccessSessions(callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request<DeviceFarm.Types.ListRemoteAccessSessionsResult, AWSError>;
/**
* Gets information about runs, given an AWS Device Farm project ARN.
*/
listRuns(params: DeviceFarm.Types.ListRunsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request<DeviceFarm.Types.ListRunsResult, AWSError>;
/**
* Gets information about runs, given an AWS Device Farm project ARN.
*/
listRuns(callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request<DeviceFarm.Types.ListRunsResult, AWSError>;
/**
* Gets information about samples, given an AWS Device Farm job ARN.
*/
listSamples(params: DeviceFarm.Types.ListSamplesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request<DeviceFarm.Types.ListSamplesResult, AWSError>;
/**
* Gets information about samples, given an AWS Device Farm job ARN.
*/
listSamples(callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request<DeviceFarm.Types.ListSamplesResult, AWSError>;
/**
* Gets information about test suites for a given job.
*/
listSuites(params: DeviceFarm.Types.ListSuitesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request<DeviceFarm.Types.ListSuitesResult, AWSError>;
/**
* Gets information about test suites for a given job.
*/
listSuites(callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request<DeviceFarm.Types.ListSuitesResult, AWSError>;
/**
* List the tags for an AWS Device Farm resource.
*/
listTagsForResource(params: DeviceFarm.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListTagsForResourceResponse) => void): Request<DeviceFarm.Types.ListTagsForResourceResponse, AWSError>;
/**
* List the tags for an AWS Device Farm resource.
*/
listTagsForResource(callback?: (err: AWSError, data: DeviceFarm.Types.ListTagsForResourceResponse) => void): Request<DeviceFarm.Types.ListTagsForResourceResponse, AWSError>;
/**
* Gets information about tests in a given test suite.
*/
listTests(params: DeviceFarm.Types.ListTestsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request<DeviceFarm.Types.ListTestsResult, AWSError>;
/**
* Gets information about tests in a given test suite.
*/
listTests(callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request<DeviceFarm.Types.ListTestsResult, AWSError>;
/**
* Gets information about unique problems.
*/
listUniqueProblems(params: DeviceFarm.Types.ListUniqueProblemsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request<DeviceFarm.Types.ListUniqueProblemsResult, AWSError>;
/**
* Gets information about unique problems.
*/
listUniqueProblems(callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request<DeviceFarm.Types.ListUniqueProblemsResult, AWSError>;
/**
* Gets information about uploads, given an AWS Device Farm project ARN.
*/
listUploads(params: DeviceFarm.Types.ListUploadsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request<DeviceFarm.Types.ListUploadsResult, AWSError>;
/**
* Gets information about uploads, given an AWS Device Farm project ARN.
*/
listUploads(callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request<DeviceFarm.Types.ListUploadsResult, AWSError>;
/**
* Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
*/
listVPCEConfigurations(params: DeviceFarm.Types.ListVPCEConfigurationsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request<DeviceFarm.Types.ListVPCEConfigurationsResult, AWSError>;
/**
* Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
*/
listVPCEConfigurations(callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request<DeviceFarm.Types.ListVPCEConfigurationsResult, AWSError>;
/**
* Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
purchaseOffering(params: DeviceFarm.Types.PurchaseOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request<DeviceFarm.Types.PurchaseOfferingResult, AWSError>;
/**
* Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
purchaseOffering(callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request<DeviceFarm.Types.PurchaseOfferingResult, AWSError>;
/**
* Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
renewOffering(params: DeviceFarm.Types.RenewOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request<DeviceFarm.Types.RenewOfferingResult, AWSError>;
/**
* Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
*/
renewOffering(callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request<DeviceFarm.Types.RenewOfferingResult, AWSError>;
/**
* Schedules a run.
*/
scheduleRun(params: DeviceFarm.Types.ScheduleRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request<DeviceFarm.Types.ScheduleRunResult, AWSError>;
/**
* Schedules a run.
*/
scheduleRun(callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request<DeviceFarm.Types.ScheduleRunResult, AWSError>;
/**
* Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
*/
stopJob(params: DeviceFarm.Types.StopJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request<DeviceFarm.Types.StopJobResult, AWSError>;
/**
* Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
*/
stopJob(callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request<DeviceFarm.Types.StopJobResult, AWSError>;
/**
* Ends a specified remote access session.
*/
stopRemoteAccessSession(params: DeviceFarm.Types.StopRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.StopRemoteAccessSessionResult, AWSError>;
/**
* Ends a specified remote access session.
*/
stopRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.StopRemoteAccessSessionResult, AWSError>;
/**
* Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
*/
stopRun(params: DeviceFarm.Types.StopRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request<DeviceFarm.Types.StopRunResult, AWSError>;
/**
* Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
*/
stopRun(callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request<DeviceFarm.Types.StopRunResult, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
*/
tagResource(params: DeviceFarm.Types.TagResourceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.TagResourceResponse) => void): Request<DeviceFarm.Types.TagResourceResponse, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
*/
tagResource(callback?: (err: AWSError, data: DeviceFarm.Types.TagResourceResponse) => void): Request<DeviceFarm.Types.TagResourceResponse, AWSError>;
/**
* Deletes the specified tags from a resource.
*/
untagResource(params: DeviceFarm.Types.UntagResourceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UntagResourceResponse) => void): Request<DeviceFarm.Types.UntagResourceResponse, AWSError>;
/**
* Deletes the specified tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: DeviceFarm.Types.UntagResourceResponse) => void): Request<DeviceFarm.Types.UntagResourceResponse, AWSError>;
/**
* Updates information about an existing private device instance.
*/
updateDeviceInstance(params: DeviceFarm.Types.UpdateDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request<DeviceFarm.Types.UpdateDeviceInstanceResult, AWSError>;
/**
* Updates information about an existing private device instance.
*/
updateDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request<DeviceFarm.Types.UpdateDeviceInstanceResult, AWSError>;
/**
* Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
*/
updateDevicePool(params: DeviceFarm.Types.UpdateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request<DeviceFarm.Types.UpdateDevicePoolResult, AWSError>;
/**
* Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
*/
updateDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request<DeviceFarm.Types.UpdateDevicePoolResult, AWSError>;
/**
* Updates information about an existing private device instance profile.
*/
updateInstanceProfile(params: DeviceFarm.Types.UpdateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request<DeviceFarm.Types.UpdateInstanceProfileResult, AWSError>;
/**
* Updates information about an existing private device instance profile.
*/
updateInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request<DeviceFarm.Types.UpdateInstanceProfileResult, AWSError>;
/**
* Updates the network profile with specific settings.
*/
updateNetworkProfile(params: DeviceFarm.Types.UpdateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request<DeviceFarm.Types.UpdateNetworkProfileResult, AWSError>;
/**
* Updates the network profile with specific settings.
*/
updateNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request<DeviceFarm.Types.UpdateNetworkProfileResult, AWSError>;
/**
* Modifies the specified project name, given the project ARN and a new name.
*/
updateProject(params: DeviceFarm.Types.UpdateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request<DeviceFarm.Types.UpdateProjectResult, AWSError>;
/**
* Modifies the specified project name, given the project ARN and a new name.
*/
updateProject(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request<DeviceFarm.Types.UpdateProjectResult, AWSError>;
/**
* Update an uploaded test specification (test spec).
*/
updateUpload(params: DeviceFarm.Types.UpdateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request<DeviceFarm.Types.UpdateUploadResult, AWSError>;
/**
* Update an uploaded test specification (test spec).
*/
updateUpload(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request<DeviceFarm.Types.UpdateUploadResult, AWSError>;
/**
* Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
*/
updateVPCEConfiguration(params: DeviceFarm.Types.UpdateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.UpdateVPCEConfigurationResult, AWSError>;
/**
* Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
*/
updateVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.UpdateVPCEConfigurationResult, AWSError>;
}
declare namespace DeviceFarm {
export type AWSAccountNumber = string;
export interface AccountSettings {
/**
* The AWS account number specified in the AccountSettings container.
*/
awsAccountNumber?: AWSAccountNumber;
/**
* Returns the unmetered devices you have purchased or want to purchase.
*/
unmeteredDevices?: PurchasedDevicesMap;
/**
* Returns the unmetered remote access devices you have purchased or want to purchase.
*/
unmeteredRemoteAccessDevices?: PurchasedDevicesMap;
/**
* The maximum number of minutes a test run will execute before it times out.
*/
maxJobTimeoutMinutes?: JobTimeoutMinutes;
/**
* Information about an AWS account's usage of free trial device minutes.
*/
trialMinutes?: TrialMinutes;
/**
* The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.
*/
maxSlots?: MaxSlotMap;
/**
* The default number of minutes (at the account level) a test run will execute before it times out. The default value is 150 minutes.
*/
defaultJobTimeoutMinutes?: JobTimeoutMinutes;
/**
* When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
*/
skipAppResign?: SkipAppResign;
}
export type AccountsCleanup = boolean;
export type AmazonResourceName = string;
export type AmazonResourceNames = AmazonResourceName[];
export type AndroidPaths = String[];
export type AppPackagesCleanup = boolean;
export interface Artifact {
/**
* The artifact's ARN.
*/
arn?: AmazonResourceName;
/**
* The artifact's name.
*/
name?: Name;
/**
* The artifact's type. Allowed values include the following: UNKNOWN: An unknown type. SCREENSHOT: The screenshot type. DEVICE_LOG: The device log type. MESSAGE_LOG: The message log type. VIDEO_LOG: The video log type. RESULT_LOG: The result log type. SERVICE_LOG: The service log type. WEBKIT_LOG: The web kit log type. INSTRUMENTATION_OUTPUT: The instrumentation type. EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test. CALABASH_JSON_OUTPUT: The Calabash JSON output type. CALABASH_PRETTY_OUTPUT: The Calabash pretty output type. CALABASH_STANDARD_OUTPUT: The Calabash standard output type. CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type. AUTOMATION_OUTPUT: The automation output type. APPIUM_SERVER_OUTPUT: The Appium server output type. APPIUM_JAVA_OUTPUT: The Appium Java output type. APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type. APPIUM_PYTHON_OUTPUT: The Appium Python output type. APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type. EXPLORER_EVENT_LOG: The Explorer event log output type. EXPLORER_SUMMARY_LOG: The Explorer summary log output type. APPLICATION_CRASH_REPORT: The application crash report output type. XCTEST_LOG: The Xcode test output type. VIDEO: The Video output type. CUSTOMER_ARTIFACT:The Customer Artifact output type. CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type. TESTSPEC_OUTPUT: The Test Spec Output type.
*/
type?: ArtifactType;
/**
* The artifact's file extension.
*/
extension?: String;
/**
* The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
*/
url?: URL;
}
export type ArtifactCategory = "SCREENSHOT"|"FILE"|"LOG"|string;
export type ArtifactType = "UNKNOWN"|"SCREENSHOT"|"DEVICE_LOG"|"MESSAGE_LOG"|"VIDEO_LOG"|"RESULT_LOG"|"SERVICE_LOG"|"WEBKIT_LOG"|"INSTRUMENTATION_OUTPUT"|"EXERCISER_MONKEY_OUTPUT"|"CALABASH_JSON_OUTPUT"|"CALABASH_PRETTY_OUTPUT"|"CALABASH_STANDARD_OUTPUT"|"CALABASH_JAVA_XML_OUTPUT"|"AUTOMATION_OUTPUT"|"APPIUM_SERVER_OUTPUT"|"APPIUM_JAVA_OUTPUT"|"APPIUM_JAVA_XML_OUTPUT"|"APPIUM_PYTHON_OUTPUT"|"APPIUM_PYTHON_XML_OUTPUT"|"EXPLORER_EVENT_LOG"|"EXPLORER_SUMMARY_LOG"|"APPLICATION_CRASH_REPORT"|"XCTEST_LOG"|"VIDEO"|"CUSTOMER_ARTIFACT"|"CUSTOMER_ARTIFACT_LOG"|"TESTSPEC_OUTPUT"|string;
export type Artifacts = Artifact[];
export type BillingMethod = "METERED"|"UNMETERED"|string;
export type Boolean = boolean;
export interface CPU {
/**
* The CPU's frequency.
*/
frequency?: String;
/**
* The CPU's architecture, for example x86 or ARM.
*/
architecture?: String;
/**
* The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
*/
clock?: Double;
}
export type ClientId = string;
export type ContentType = string;
export interface Counters {
/**
* The total number of entities.
*/
total?: Integer;
/**
* The number of passed entities.
*/
passed?: Integer;
/**
* The number of failed entities.
*/
failed?: Integer;
/**
* The number of warned entities.
*/
warned?: Integer;
/**
* The number of errored entities.
*/
errored?: Integer;
/**
* The number of stopped entities.
*/
stopped?: Integer;
/**
* The number of skipped entities.
*/
skipped?: Integer;
}
export interface CreateDevicePoolRequest {
/**
* The ARN of the project for the device pool.
*/
projectArn: AmazonResourceName;
/**
* The device pool's name.
*/
name: Name;
/**
* The device pool's description.
*/
description?: Message;
/**
* The device pool's rules.
*/
rules: Rules;
/**
* The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests.
*/
maxDevices?: Integer;
}
export interface CreateDevicePoolResult {
/**
* The newly created device pool.
*/
devicePool?: DevicePool;
}
export interface CreateInstanceProfileRequest {
/**
* The name of your instance profile.
*/
name: Name;
/**
* The description of your instance profile.
*/
description?: Message;
/**
* When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.
*/
packageCleanup?: Boolean;
/**
* An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
*/
excludeAppPackagesFromCleanup?: PackageIds;
/**
* When set to true, Device Farm will reboot the instance after a test run. The default value is true.
*/
rebootAfterUse?: Boolean;
}
export interface CreateInstanceProfileResult {
/**
* An object containing information about your instance profile.
*/
instanceProfile?: InstanceProfile;
}
export interface CreateNetworkProfileRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
*/
projectArn: AmazonResourceName;
/**
* The name you wish to specify for the new network profile.
*/
name: Name;
/**
* The description of the network profile.
*/
description?: Message;
/**
* The type of network profile you wish to create. Valid values are listed below.
*/
type?: NetworkProfileType;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
uplinkBandwidthBits?: Long;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
downlinkBandwidthBits?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
uplinkDelayMs?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
downlinkDelayMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
uplinkJitterMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
downlinkJitterMs?: Long;
/**
* Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
*/
uplinkLossPercent?: PercentInteger;
/**
* Proportion of received packets that fail to arrive from 0 to 100 percent.
*/
downlinkLossPercent?: PercentInteger;
}
export interface CreateNetworkProfileResult {
/**
* The network profile that is returned by the create network profile request.
*/
networkProfile?: NetworkProfile;
}
export interface CreateProjectRequest {
/**
* The project's name.
*/
name: Name;
/**
* Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
*/
defaultJobTimeoutMinutes?: JobTimeoutMinutes;
}
export interface CreateProjectResult {
/**
* The newly created project.
*/
project?: Project;
}
export interface CreateRemoteAccessSessionConfiguration {
/**
* The billing method for the remote access session.
*/
billingMethod?: BillingMethod;
/**
* An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.
*/
vpceConfigurationArns?: AmazonResourceNames;
}
export interface CreateRemoteAccessSessionRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
*/
projectArn: AmazonResourceName;
/**
* The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
*/
deviceArn: AmazonResourceName;
/**
* The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
*/
instanceArn?: AmazonResourceName;
/**
* Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true. Remote debugging is no longer supported.
*/
sshPublicKey?: SshPublicKey;
/**
* Set to true if you want to access devices remotely for debugging in your remote access session. Remote debugging is no longer supported.
*/
remoteDebugEnabled?: Boolean;
/**
* Set to true to enable remote recording for the remote access session.
*/
remoteRecordEnabled?: Boolean;
/**
* The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
*/
remoteRecordAppArn?: AmazonResourceName;
/**
* The name of the remote access session that you wish to create.
*/
name?: Name;
/**
* Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true. Remote debugging is no longer supported.
*/
clientId?: ClientId;
/**
* The configuration information for the remote access session request.
*/
configuration?: CreateRemoteAccessSessionConfiguration;
/**
* The interaction mode of the remote access session. Valid values are: INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode. NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode. VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
*/
interactionMode?: InteractionMode;
/**
* When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
*/
skipAppResign?: Boolean;
}
export interface CreateRemoteAccessSessionResult {
/**
* A container that describes the remote access session when the request to create a remote access session is sent.
*/
remoteAccessSession?: RemoteAccessSession;
}
export interface CreateUploadRequest {
/**
* The ARN of the project for the upload.
*/
projectArn: AmazonResourceName;
/**
* The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.
*/
name: Name;
/**
* The upload's upload type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web application upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An Xcode test package upload. XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload. Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
*/
type: UploadType;
/**
* The upload's content type (for example, "application/octet-stream").
*/
contentType?: ContentType;
}
export interface CreateUploadResult {
/**
* The newly created upload.
*/
upload?: Upload;
}
export interface CreateVPCEConfigurationRequest {
/**
* The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
*/
vpceConfigurationName: VPCEConfigurationName;
/**
* The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
*/
vpceServiceName: VPCEServiceName;
/**
* The DNS name of the service running in your VPC that you want Device Farm to test.
*/
serviceDnsName: ServiceDnsName;
/**
* An optional description, providing more details about your VPC endpoint configuration.
*/
vpceConfigurationDescription?: VPCEConfigurationDescription;
}
export interface CreateVPCEConfigurationResult {
/**
* An object containing information about your VPC endpoint configuration.
*/
vpceConfiguration?: VPCEConfiguration;
}
export type CurrencyCode = "USD"|string;
export interface CustomerArtifactPaths {
/**
* Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.
*/
iosPaths?: IosPaths;
/**
* Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.
*/
androidPaths?: AndroidPaths;
/**
* Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.
*/
deviceHostPaths?: DeviceHostPaths;
}
export type DateTime = Date;
export interface DeleteDevicePoolRequest {
/**
* Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteDevicePoolResult {
}
export interface DeleteInstanceProfileRequest {
/**
* The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteInstanceProfileResult {
}
export interface DeleteNetworkProfileRequest {
/**
* The Amazon Resource Name (ARN) of the network profile you want to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteNetworkProfileResult {
}
export interface DeleteProjectRequest {
/**
* Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteProjectResult {
}
export interface DeleteRemoteAccessSessionRequest {
/**
* The Amazon Resource Name (ARN) of the session for which you want to delete remote access.
*/
arn: AmazonResourceName;
}
export interface DeleteRemoteAccessSessionResult {
}
export interface DeleteRunRequest {
/**
* The Amazon Resource Name (ARN) for the run you wish to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteRunResult {
}
export interface DeleteUploadRequest {
/**
* Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteUploadResult {
}
export interface DeleteVPCEConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
*/
arn: AmazonResourceName;
}
export interface DeleteVPCEConfigurationResult {
}
export interface Device {
/**
* The device's ARN.
*/
arn?: AmazonResourceName;
/**
* The device's display name.
*/
name?: Name;
/**
* The device's manufacturer name.
*/
manufacturer?: String;
/**
* The device's model name.
*/
model?: String;
/**
* The device's model ID.
*/
modelId?: String;
/**
* The device's form factor. Allowed values include: PHONE: The phone form factor. TABLET: The tablet form factor.
*/
formFactor?: DeviceFormFactor;
/**
* The device's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform.
*/
platform?: DevicePlatform;
/**
* The device's operating system type.
*/
os?: String;
/**
* Information about the device's CPU.
*/
cpu?: CPU;
/**
* The resolution of the device.
*/
resolution?: Resolution;
/**
* The device's heap size, expressed in bytes.
*/
heapSize?: Long;
/**
* The device's total memory size, expressed in bytes.
*/
memory?: Long;
/**
* The device's image name.
*/
image?: String;
/**
* The device's carrier.
*/
carrier?: String;
/**
* The device's radio.
*/
radio?: String;
/**
* Specifies whether remote access has been enabled for the specified device.
*/
remoteAccessEnabled?: Boolean;
/**
* This flag is set to true if remote debugging is enabled for the device. Remote debugging is no longer supported.
*/
remoteDebugEnabled?: Boolean;
/**
* The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
*/
fleetType?: String;
/**
* The name of the fleet to which this device belongs.
*/
fleetName?: String;
/**
* The instances belonging to this device.
*/
instances?: DeviceInstances;
/**
* Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
*/
availability?: DeviceAvailability;
}
export type DeviceAttribute = "ARN"|"PLATFORM"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"APPIUM_VERSION"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|string;
export type DeviceAvailability = "TEMPORARY_NOT_AVAILABLE"|"BUSY"|"AVAILABLE"|"HIGHLY_AVAILABLE"|string;
export interface DeviceFilter {
/**
* The aspect of a device such as platform or model used as the selection criteria in a device filter. The supported operators for each attribute are provided in the following list. ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN MODEL The device model. For example, "iPad 5th Gen". Supported operators: CONTAINS, EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Ignored.Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS This filter will be ignored, as remote debugging is no longer supported. INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: EQUALS, IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS
*/
attribute?: DeviceFilterAttribute;
/**
* Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
*/
operator?: RuleOperator;
/**
* An array of one or more filter values used in a device filter. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".
*/
values?: DeviceFilterValues;
}
export type DeviceFilterAttribute = "ARN"|"PLATFORM"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|string;
export type DeviceFilterValues = String[];
export type DeviceFilters = DeviceFilter[];
export type DeviceFormFactor = "PHONE"|"TABLET"|string;
export type DeviceHostPaths = String[];
export interface DeviceInstance {
/**
* The Amazon Resource Name (ARN) of the device instance.
*/
arn?: AmazonResourceName;
/**
* The Amazon Resource Name (ARN) of the device.
*/
deviceArn?: AmazonResourceName;
/**
* An array of strings describing the device instance.
*/
labels?: InstanceLabels;
/**
* The status of the device instance. Valid values are listed below.
*/
status?: InstanceStatus;
/**
* Unique device identifier for the device instance.
*/
udid?: String;
/**
* A object containing information about the instance profile.
*/
instanceProfile?: InstanceProfile;
}
export type DeviceInstances = DeviceInstance[];
export interface DeviceMinutes {
/**
* When specified, represents the total minutes used by the resource to run tests.
*/
total?: Double;
/**
* When specified, represents only the sum of metered minutes used by the resource to run tests.
*/
metered?: Double;
/**
* When specified, represents only the sum of unmetered minutes used by the resource to run tests.
*/
unmetered?: Double;
}
export type DevicePlatform = "ANDROID"|"IOS"|string;
export interface DevicePool {
/**
* The device pool's ARN.
*/
arn?: AmazonResourceName;
/**
* The device pool's name.
*/
name?: Name;
/**
* The device pool's description.
*/
description?: Message;
/**
* The device pool's type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer.
*/
type?: DevicePoolType;
/**
* Information about the device pool's rules.
*/
rules?: Rules;
/**
* The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests.
*/
maxDevices?: Integer;
}
export interface DevicePoolCompatibilityResult {
/**
* The device (phone or tablet) that you wish to return information about.
*/
device?: Device;
/**
* Whether the result was compatible with the device pool.
*/
compatible?: Boolean;
/**
* Information about the compatibility.
*/
incompatibilityMessages?: IncompatibilityMessages;
}
export type DevicePoolCompatibilityResults = DevicePoolCompatibilityResult[];
export type DevicePoolType = "CURATED"|"PRIVATE"|string;
export type DevicePools = DevicePool[];
export interface DeviceSelectionConfiguration {
/**
* Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values. Attribute The aspect of a device such as platform or model used as the selection criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". This filter will be ignored, as remote debugging is no longer supported. INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values An array of one or more filter values. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".
*/
filters: DeviceFilters;
/**
* The maximum number of devices to be included in a test run.
*/
maxDevices: Integer;
}
export interface DeviceSelectionResult {
/**
* The filters in a device selection result.
*/
filters?: DeviceFilters;
/**
* The number of devices that matched the device filter selection criteria.
*/
matchedDevicesCount?: Integer;
/**
* The maximum number of devices to be selected by a device filter and included in a test run.
*/
maxDevices?: Integer;
}
export type Devices = Device[];
export type Double = number;
export interface ExecutionConfiguration {
/**
* The number of minutes a test run will execute before it times out.
*/
jobTimeoutMinutes?: JobTimeoutMinutes;
/**
* True if account cleanup is enabled at the beginning of the test; otherwise, false.
*/
accountsCleanup?: AccountsCleanup;
/**
* True if app package cleanup is enabled at the beginning of the test; otherwise, false.
*/
appPackagesCleanup?: AppPackagesCleanup;
/**
* Set to true to enable video capture; otherwise, set to false. The default is true.
*/
videoCapture?: VideoCapture;
/**
* When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
*/
skipAppResign?: SkipAppResign;
}
export type ExecutionResult = "PENDING"|"PASSED"|"WARNED"|"FAILED"|"SKIPPED"|"ERRORED"|"STOPPED"|string;
export type ExecutionResultCode = "PARSING_FAILED"|"VPC_ENDPOINT_SETUP_FAILED"|string;
export type ExecutionStatus = "PENDING"|"PENDING_CONCURRENCY"|"PENDING_DEVICE"|"PROCESSING"|"SCHEDULING"|"PREPARING"|"RUNNING"|"COMPLETED"|"STOPPING"|string;
export type Filter = string;
export interface GetAccountSettingsRequest {
}
export interface GetAccountSettingsResult {
/**
* The account settings.
*/
accountSettings?: AccountSettings;
}
export interface GetDeviceInstanceRequest {
/**
* The Amazon Resource Name (ARN) of the instance you're requesting information about.
*/
arn: AmazonResourceName;
}
export interface GetDeviceInstanceResult {
/**
* An object containing information about your device instance.
*/
deviceInstance?: DeviceInstance;
}
export interface GetDevicePoolCompatibilityRequest {
/**
* The device pool's ARN.
*/
devicePoolArn: AmazonResourceName;
/**
* The ARN of the app that is associated with the specified device pool.
*/
appArn?: AmazonResourceName;
/**
* The test type for the specified device pool. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
testType?: TestType;
/**
* Information about the uploaded test to be run against the device pool.
*/
test?: ScheduleRunTest;
/**
* An object containing information about the settings for a run.
*/
configuration?: ScheduleRunConfiguration;
}
export interface GetDevicePoolCompatibilityResult {
/**
* Information about compatible devices.
*/
compatibleDevices?: DevicePoolCompatibilityResults;
/**
* Information about incompatible devices.
*/
incompatibleDevices?: DevicePoolCompatibilityResults;
}
export interface GetDevicePoolRequest {
/**
* The device pool's ARN.
*/
arn: AmazonResourceName;
}
export interface GetDevicePoolResult {
/**
* An object containing information about the requested device pool.
*/
devicePool?: DevicePool;
}
export interface GetDeviceRequest {
/**
* The device type's ARN.
*/
arn: AmazonResourceName;
}
export interface GetDeviceResult {
/**
* An object containing information about the requested device.
*/
device?: Device;
}
export interface GetInstanceProfileRequest {
/**
* The Amazon Resource Name (ARN) of your instance profile.
*/
arn: AmazonResourceName;
}
export interface GetInstanceProfileResult {
/**
* An object containing information about your instance profile.
*/
instanceProfile?: InstanceProfile;
}
export interface GetJobRequest {
/**
* The job's ARN.
*/
arn: AmazonResourceName;
}
export interface GetJobResult {
/**
* An object containing information about the requested job.
*/
job?: Job;
}
export interface GetNetworkProfileRequest {
/**
* The Amazon Resource Name (ARN) of the network profile you want to return information about.
*/
arn: AmazonResourceName;
}
export interface GetNetworkProfileResult {
/**
* The network profile.
*/
networkProfile?: NetworkProfile;
}
export interface GetOfferingStatusRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface GetOfferingStatusResult {
/**
* When specified, gets the offering status for the current period.
*/
current?: OfferingStatusMap;
/**
* When specified, gets the offering status for the next period.
*/
nextPeriod?: OfferingStatusMap;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface GetProjectRequest {
/**
* The project's ARN.
*/
arn: AmazonResourceName;
}
export interface GetProjectResult {
/**
* The project you wish to get information about.
*/
project?: Project;
}
export interface GetRemoteAccessSessionRequest {
/**
* The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
*/
arn: AmazonResourceName;
}
export interface GetRemoteAccessSessionResult {
/**
* A container that lists detailed information about the remote access session.
*/
remoteAccessSession?: RemoteAccessSession;
}
export interface GetRunRequest {
/**
* The run's ARN.
*/
arn: AmazonResourceName;
}
export interface GetRunResult {
/**
* The run you wish to get results from.
*/
run?: Run;
}
export interface GetSuiteRequest {
/**
* The suite's ARN.
*/
arn: AmazonResourceName;
}
export interface GetSuiteResult {
/**
* A collection of one or more tests.
*/
suite?: Suite;
}
export interface GetTestRequest {
/**
* The test's ARN.
*/
arn: AmazonResourceName;
}
export interface GetTestResult {
/**
* A test condition that is evaluated.
*/
test?: Test;
}
export interface GetUploadRequest {
/**
* The upload's ARN.
*/
arn: AmazonResourceName;
}
export interface GetUploadResult {
/**
* An app or a set of one or more tests to upload or that have been uploaded.
*/
upload?: Upload;
}
export interface GetVPCEConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
*/
arn: AmazonResourceName;
}
export interface GetVPCEConfigurationResult {
/**
* An object containing information about your VPC endpoint configuration.
*/
vpceConfiguration?: VPCEConfiguration;
}
export type HostAddress = string;
export interface IncompatibilityMessage {
/**
* A message about the incompatibility.
*/
message?: Message;
/**
* The type of incompatibility. Allowed values include: ARN: The ARN. FORM_FACTOR: The form factor (for example, phone or tablet). MANUFACTURER: The manufacturer. PLATFORM: The platform (for example, Android or iOS). REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. APPIUM_VERSION: The Appium version for the test.
*/
type?: DeviceAttribute;
}
export type IncompatibilityMessages = IncompatibilityMessage[];
export interface InstallToRemoteAccessSessionRequest {
/**
* The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
*/
remoteAccessSessionArn: AmazonResourceName;
/**
* The Amazon Resource Name (ARN) of the app about which you are requesting information.
*/
appArn: AmazonResourceName;
}
export interface InstallToRemoteAccessSessionResult {
/**
* An app to upload or that has been uploaded.
*/
appUpload?: Upload;
}
export type InstanceLabels = String[];
export interface InstanceProfile {
/**
* The Amazon Resource Name (ARN) of the instance profile.
*/
arn?: AmazonResourceName;
/**
* When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.
*/
packageCleanup?: Boolean;
/**
* An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
*/
excludeAppPackagesFromCleanup?: PackageIds;
/**
* When set to true, Device Farm will reboot the instance after a test run. The default value is true.
*/
rebootAfterUse?: Boolean;
/**
* The name of the instance profile.
*/
name?: Name;
/**
* The description of the instance profile.
*/
description?: Message;
}
export type InstanceProfiles = InstanceProfile[];
export type InstanceStatus = "IN_USE"|"PREPARING"|"AVAILABLE"|"NOT_AVAILABLE"|string;
export type Integer = number;
export type InteractionMode = "INTERACTIVE"|"NO_VIDEO"|"VIDEO_ONLY"|string;
export type IosPaths = String[];
export interface Job {
/**
* The job's ARN.
*/
arn?: AmazonResourceName;
/**
* The job's name.
*/
name?: Name;
/**
* The job's type. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby test type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
type?: TestType;
/**
* When the job was created.
*/
created?: DateTime;
/**
* The job's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
*/
status?: ExecutionStatus;
/**
* The job's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* The job's start time.
*/
started?: DateTime;
/**
* The job's stop time.
*/
stopped?: DateTime;
/**
* The job's result counters.
*/
counters?: Counters;
/**
* A message about the job's result.
*/
message?: Message;
/**
* The device (phone or tablet).
*/
device?: Device;
/**
* The Amazon Resource Name (ARN) of the instance.
*/
instanceArn?: AmazonResourceName;
/**
* Represents the total (metered or unmetered) minutes used by the job.
*/
deviceMinutes?: DeviceMinutes;
/**
* The endpoint for streaming device video.
*/
videoEndpoint?: String;
/**
* This value is set to true if video capture is enabled; otherwise, it is set to false.
*/
videoCapture?: VideoCapture;
}
export type JobTimeoutMinutes = number;
export type Jobs = Job[];
export interface ListArtifactsRequest {
/**
* The Run, Job, Suite, or Test ARN.
*/
arn: AmazonResourceName;
/**
* The artifacts' type. Allowed values include: FILE: The artifacts are files. LOG: The artifacts are logs. SCREENSHOT: The artifacts are screenshots.
*/
type: ArtifactCategory;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListArtifactsResult {
/**
* Information about the artifacts.
*/
artifacts?: Artifacts;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDeviceInstancesRequest {
/**
* An integer specifying the maximum number of items you want to return in the API response.
*/
maxResults?: Integer;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDeviceInstancesResult {
/**
* An object containing information about your device instances.
*/
deviceInstances?: DeviceInstances;
/**
* An identifier that can be used in the next call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDevicePoolsRequest {
/**
* The project ARN.
*/
arn: AmazonResourceName;
/**
* The device pools' type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer.
*/
type?: DevicePoolType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDevicePoolsResult {
/**
* Information about the device pools.
*/
devicePools?: DevicePools;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDevicesRequest {
/**
* The Amazon Resource Name (ARN) of the project.
*/
arn?: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values. Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". This attribute will be ignored, as remote debugging is no longer supported. INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator: The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values: An array of one or more filter values. The IN and NOT_IN operators take a values array that has one or more elements. The other operators require an array with a single element. In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.
*/
filters?: DeviceFilters;
}
export interface ListDevicesResult {
/**
* Information about the devices.
*/
devices?: Devices;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListInstanceProfilesRequest {
/**
* An integer specifying the maximum number of items you want to return in the API response.
*/
maxResults?: Integer;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListInstanceProfilesResult {
/**
* An object containing information about your instance profiles.
*/
instanceProfiles?: InstanceProfiles;
/**
* An identifier that can be used in the next call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListJobsRequest {
/**
* The run's Amazon Resource Name (ARN).
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListJobsResult {
/**
* Information about the jobs.
*/
jobs?: Jobs;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListNetworkProfilesRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
*/
arn: AmazonResourceName;
/**
* The type of network profile you wish to return information about. Valid values are listed below.
*/
type?: NetworkProfileType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListNetworkProfilesResult {
/**
* A list of the available network profiles.
*/
networkProfiles?: NetworkProfiles;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingPromotionsRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingPromotionsResult {
/**
* Information about the offering promotions.
*/
offeringPromotions?: OfferingPromotions;
/**
* An identifier to be used in the next call to this operation, to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingTransactionsRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingTransactionsResult {
/**
* The audit log of subscriptions you have purchased and modified through AWS Device Farm.
*/
offeringTransactions?: OfferingTransactions;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingsRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListOfferingsResult {
/**
* A value representing the list offering results.
*/
offerings?: Offerings;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListProjectsRequest {
/**
* Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.
*/
arn?: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListProjectsResult {
/**
* Information about the projects.
*/
projects?: Projects;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListRemoteAccessSessionsRequest {
/**
* The Amazon Resource Name (ARN) of the project about which you are requesting information.
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListRemoteAccessSessionsResult {
/**
* A container representing the metadata from the service about each remote access session you are requesting.
*/
remoteAccessSessions?: RemoteAccessSessions;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListRunsRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to list runs.
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListRunsResult {
/**
* Information about the runs.
*/
runs?: Runs;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListSamplesRequest {
/**
* The Amazon Resource Name (ARN) of the job used to list samples.
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListSamplesResult {
/**
* Information about the samples.
*/
samples?: Samples;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListSuitesRequest {
/**
* The job's Amazon Resource Name (ARN).
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListSuitesResult {
/**
* Information about the suites.
*/
suites?: Suites;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource(s) for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.
*/
ResourceARN: AmazonResourceName;
}
export interface ListTagsForResourceResponse {
/**
* The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
*/
Tags?: TagList;
}
export interface ListTestsRequest {
/**
* The test suite's Amazon Resource Name (ARN).
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListTestsResult {
/**
* Information about the tests.
*/
tests?: Tests;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListUniqueProblemsRequest {
/**
* The unique problems' ARNs.
*/
arn: AmazonResourceName;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListUniqueProblemsResult {
/**
* Information about the unique problems. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
uniqueProblems?: UniqueProblemsByExecutionResultMap;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListUploadsRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to list uploads.
*/
arn: AmazonResourceName;
/**
* The type of upload. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web application upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An Xcode test package upload. XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.
*/
type?: UploadType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListUploadsResult {
/**
* Information about the uploads.
*/
uploads?: Uploads;
/**
* If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListVPCEConfigurationsRequest {
/**
* An integer specifying the maximum number of items you want to return in the API response.
*/
maxResults?: Integer;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListVPCEConfigurationsResult {
/**
* An array of VPCEConfiguration objects containing information about your VPC endpoint configuration.
*/
vpceConfigurations?: VPCEConfigurations;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface Location {
/**
* The latitude.
*/
latitude: Double;
/**
* The longitude.
*/
longitude: Double;
}
export type Long = number;
export type MaxSlotMap = {[key: string]: Integer};
export type Message = string;
export type Metadata = string;
export interface MonetaryAmount {
/**
* The numerical amount of an offering or transaction.
*/
amount?: Double;
/**
* The currency code of a monetary amount. For example, USD means "U.S. dollars."
*/
currencyCode?: CurrencyCode;
}
export type Name = string;
export interface NetworkProfile {
/**
* The Amazon Resource Name (ARN) of the network profile.
*/
arn?: AmazonResourceName;
/**
* The name of the network profile.
*/
name?: Name;
/**
* The description of the network profile.
*/
description?: Message;
/**
* The type of network profile. Valid values are listed below.
*/
type?: NetworkProfileType;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
uplinkBandwidthBits?: Long;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
downlinkBandwidthBits?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
uplinkDelayMs?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
downlinkDelayMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
uplinkJitterMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
downlinkJitterMs?: Long;
/**
* Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
*/
uplinkLossPercent?: PercentInteger;
/**
* Proportion of received packets that fail to arrive from 0 to 100 percent.
*/
downlinkLossPercent?: PercentInteger;
}
export type NetworkProfileType = "CURATED"|"PRIVATE"|string;
export type NetworkProfiles = NetworkProfile[];
export interface Offering {
/**
* The ID that corresponds to a device offering.
*/
id?: OfferingIdentifier;
/**
* A string describing the offering.
*/
description?: Message;
/**
* The type of offering (e.g., "RECURRING") for a device.
*/
type?: OfferingType;
/**
* The platform of the device (e.g., ANDROID or IOS).
*/
platform?: DevicePlatform;
/**
* Specifies whether there are recurring charges for the offering.
*/
recurringCharges?: RecurringCharges;
}
export type OfferingIdentifier = string;
export interface OfferingPromotion {
/**
* The ID of the offering promotion.
*/
id?: OfferingPromotionIdentifier;
/**
* A string describing the offering promotion.
*/
description?: Message;
}
export type OfferingPromotionIdentifier = string;
export type OfferingPromotions = OfferingPromotion[];
export interface OfferingStatus {
/**
* The type specified for the offering status.
*/
type?: OfferingTransactionType;
/**
* Represents the metadata of an offering status.
*/
offering?: Offering;
/**
* The number of available devices in the offering.
*/
quantity?: Integer;
/**
* The date on which the offering is effective.
*/
effectiveOn?: DateTime;
}
export type OfferingStatusMap = {[key: string]: OfferingStatus};
export interface OfferingTransaction {
/**
* The status of an offering transaction.
*/
offeringStatus?: OfferingStatus;
/**
* The transaction ID of the offering transaction.
*/
transactionId?: TransactionIdentifier;
/**
* The ID that corresponds to a device offering promotion.
*/
offeringPromotionId?: OfferingPromotionIdentifier;
/**
* The date on which an offering transaction was created.
*/
createdOn?: DateTime;
/**
* The cost of an offering transaction.
*/
cost?: MonetaryAmount;
}
export type OfferingTransactionType = "PURCHASE"|"RENEW"|"SYSTEM"|string;
export type OfferingTransactions = OfferingTransaction[];
export type OfferingType = "RECURRING"|string;
export type Offerings = Offering[];
export type PackageIds = String[];
export type PaginationToken = string;
export type PercentInteger = number;
export interface Problem {
/**
* Information about the associated run.
*/
run?: ProblemDetail;
/**
* Information about the associated job.
*/
job?: ProblemDetail;
/**
* Information about the associated suite.
*/
suite?: ProblemDetail;
/**
* Information about the associated test.
*/
test?: ProblemDetail;
/**
* Information about the associated device.
*/
device?: Device;
/**
* The problem's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* A message about the problem's result.
*/
message?: Message;
}
export interface ProblemDetail {
/**
* The problem detail's ARN.
*/
arn?: AmazonResourceName;
/**
* The problem detail's name.
*/
name?: Name;
}
export type Problems = Problem[];
export interface Project {
/**
* The project's ARN.
*/
arn?: AmazonResourceName;
/**
* The project's name.
*/
name?: Name;
/**
* The default number of minutes (at the project level) a test run will execute before it times out. The default value is 150 minutes.
*/
defaultJobTimeoutMinutes?: JobTimeoutMinutes;
/**
* When the project was created.
*/
created?: DateTime;
}
export type Projects = Project[];
export interface PurchaseOfferingRequest {
/**
* The ID of the offering.
*/
offeringId?: OfferingIdentifier;
/**
* The number of device slots you wish to purchase in an offering request.
*/
quantity?: Integer;
/**
* The ID of the offering promotion to be applied to the purchase.
*/
offeringPromotionId?: OfferingPromotionIdentifier;
}
export interface PurchaseOfferingResult {
/**
* Represents the offering transaction for the purchase result.
*/
offeringTransaction?: OfferingTransaction;
}
export type PurchasedDevicesMap = {[key: string]: Integer};
export interface Radios {
/**
* True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
*/
wifi?: Boolean;
/**
* True if Bluetooth is enabled at the beginning of the test; otherwise, false.
*/
bluetooth?: Boolean;
/**
* True if NFC is enabled at the beginning of the test; otherwise, false.
*/
nfc?: Boolean;
/**
* True if GPS is enabled at the beginning of the test; otherwise, false.
*/
gps?: Boolean;
}
export interface RecurringCharge {
/**
* The cost of the recurring charge.
*/
cost?: MonetaryAmount;
/**
* The frequency in which charges will recur.
*/
frequency?: RecurringChargeFrequency;
}
export type RecurringChargeFrequency = "MONTHLY"|string;
export type RecurringCharges = RecurringCharge[];
export interface RemoteAccessSession {
/**
* The Amazon Resource Name (ARN) of the remote access session.
*/
arn?: AmazonResourceName;
/**
* The name of the remote access session.
*/
name?: Name;
/**
* The date and time the remote access session was created.
*/
created?: DateTime;
/**
* The status of the remote access session. Can be any of the following: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
*/
status?: ExecutionStatus;
/**
* The result of the remote access session. Can be any of the following: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* A message about the remote access session.
*/
message?: Message;
/**
* The date and time the remote access session was started.
*/
started?: DateTime;
/**
* The date and time the remote access session was stopped.
*/
stopped?: DateTime;
/**
* The device (phone or tablet) used in the remote access session.
*/
device?: Device;
/**
* The Amazon Resource Name (ARN) of the instance.
*/
instanceArn?: AmazonResourceName;
/**
* This flag is set to true if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.
*/
remoteDebugEnabled?: Boolean;
/**
* This flag is set to true if remote recording is enabled for the remote access session.
*/
remoteRecordEnabled?: Boolean;
/**
* The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
*/
remoteRecordAppArn?: AmazonResourceName;
/**
* IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.
*/
hostAddress?: HostAddress;
/**
* Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.
*/
clientId?: ClientId;
/**
* The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
*/
billingMethod?: BillingMethod;
/**
* The number of minutes a device is used in a remote access session (including setup and teardown minutes).
*/
deviceMinutes?: DeviceMinutes;
/**
* The endpoint for the remote access sesssion.
*/
endpoint?: String;
/**
* Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.
*/
deviceUdid?: String;
/**
* The interaction mode of the remote access session. Valid values are: INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode. NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode. VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
*/
interactionMode?: InteractionMode;
/**
* When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
*/
skipAppResign?: SkipAppResign;
}
export type RemoteAccessSessions = RemoteAccessSession[];
export interface RenewOfferingRequest {
/**
* The ID of a request to renew an offering.
*/
offeringId?: OfferingIdentifier;
/**
* The quantity requested in an offering renewal.
*/
quantity?: Integer;
}
export interface RenewOfferingResult {
/**
* Represents the status of the offering transaction for the renewal.
*/
offeringTransaction?: OfferingTransaction;
}
export interface Resolution {
/**
* The screen resolution's width, expressed in pixels.
*/
width?: Integer;
/**
* The screen resolution's height, expressed in pixels.
*/
height?: Integer;
}
export interface Rule {
/**
* The rule's stringified attribute. For example, specify the value as "\"abc\"". The supported operators for each attribute are provided in the following list. APPIUM_VERSION The Appium version for the test. Supported operators: CONTAINS ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS, IN, NOT_IN INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN MODEL The device model, such as "Apple iPad Air 2" or "Google Pixel". Supported operators: CONTAINS, EQUALS, IN, NOT_IN OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS This filter will be ignored, as remote debugging is no longer supported.
*/
attribute?: DeviceAttribute;
/**
* Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
*/
operator?: RuleOperator;
/**
* The rule's value.
*/
value?: String;
}
export type RuleOperator = "EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"IN"|"NOT_IN"|"CONTAINS"|string;
export type Rules = Rule[];
export interface Run {
/**
* The run's ARN.
*/
arn?: AmazonResourceName;
/**
* The run's name.
*/
name?: Name;
/**
* The run's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
type?: TestType;
/**
* The run's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform.
*/
platform?: DevicePlatform;
/**
* When the run was created.
*/
created?: DateTime;
/**
* The run's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
*/
status?: ExecutionStatus;
/**
* The run's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* The run's start time.
*/
started?: DateTime;
/**
* The run's stop time.
*/
stopped?: DateTime;
/**
* The run's result counters.
*/
counters?: Counters;
/**
* A message about the run's result.
*/
message?: Message;
/**
* The total number of jobs for the run.
*/
totalJobs?: Integer;
/**
* The total number of completed jobs.
*/
completedJobs?: Integer;
/**
* Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
*/
billingMethod?: BillingMethod;
/**
* Represents the total (metered or unmetered) minutes used by the test run.
*/
deviceMinutes?: DeviceMinutes;
/**
* The network profile being used for a test run.
*/
networkProfile?: NetworkProfile;
/**
* Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
*/
parsingResultUrl?: String;
/**
* Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.
*/
resultCode?: ExecutionResultCode;
/**
* For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
*/
seed?: Integer;
/**
* An app to upload or that has been uploaded.
*/
appUpload?: AmazonResourceName;
/**
* For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
*/
eventCount?: Integer;
/**
* The number of minutes the job will execute before it times out.
*/
jobTimeoutMinutes?: JobTimeoutMinutes;
/**
* The ARN of the device pool for the run.
*/
devicePoolArn?: AmazonResourceName;
/**
* Information about the locale that is used for the run.
*/
locale?: String;
/**
* Information about the radio states for the run.
*/
radios?: Radios;
/**
* Information about the location that is used for the run.
*/
location?: Location;
/**
* Output CustomerArtifactPaths object for the test run.
*/
customerArtifactPaths?: CustomerArtifactPaths;
/**
* The Device Farm console URL for the recording of the run.
*/
webUrl?: String;
/**
* When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
*/
skipAppResign?: SkipAppResign;
/**
* The ARN of the YAML-formatted test specification for the run.
*/
testSpecArn?: AmazonResourceName;
/**
* The results of a device filter used to select the devices for a test run.
*/
deviceSelectionResult?: DeviceSelectionResult;
}
export type Runs = Run[];
export interface Sample {
/**
* The sample's ARN.
*/
arn?: AmazonResourceName;
/**
* The sample's type. Must be one of the following values: CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage. MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes. NATIVE_AVG_DRAWTIME NATIVE_FPS NATIVE_FRAMES NATIVE_MAX_DRAWTIME NATIVE_MIN_DRAWTIME OPENGL_AVG_DRAWTIME OPENGL_FPS OPENGL_FRAMES OPENGL_MAX_DRAWTIME OPENGL_MIN_DRAWTIME RX RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process. THREADS: A threads sample type. This is expressed as the total number of threads per app process. TX TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
*/
type?: SampleType;
/**
* The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
*/
url?: URL;
}
export type SampleType = "CPU"|"MEMORY"|"THREADS"|"RX_RATE"|"TX_RATE"|"RX"|"TX"|"NATIVE_FRAMES"|"NATIVE_FPS"|"NATIVE_MIN_DRAWTIME"|"NATIVE_AVG_DRAWTIME"|"NATIVE_MAX_DRAWTIME"|"OPENGL_FRAMES"|"OPENGL_FPS"|"OPENGL_MIN_DRAWTIME"|"OPENGL_AVG_DRAWTIME"|"OPENGL_MAX_DRAWTIME"|string;
export type Samples = Sample[];
export interface ScheduleRunConfiguration {
/**
* The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
*/
extraDataPackageArn?: AmazonResourceName;
/**
* Reserved for internal use.
*/
networkProfileArn?: AmazonResourceName;
/**
* Information about the locale that is used for the run.
*/
locale?: String;
/**
* Information about the location that is used for the run.
*/
location?: Location;
/**
* An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.
*/
vpceConfigurationArns?: AmazonResourceNames;
/**
* Input CustomerArtifactPaths object for the scheduled run configuration.
*/
customerArtifactPaths?: CustomerArtifactPaths;
/**
* Information about the radio states for the run.
*/
radios?: Radios;
/**
* A list of Upload ARNs for app packages that will be installed alongside your app.
*/
auxiliaryApps?: AmazonResourceNames;
/**
* Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
*/
billingMethod?: BillingMethod;
}
export interface ScheduleRunRequest {
/**
* The ARN of the project for the run to be scheduled.
*/
projectArn: AmazonResourceName;
/**
* The ARN of the app to schedule a run.
*/
appArn?: AmazonResourceName;
/**
* The ARN of the device pool for the run to be scheduled.
*/
devicePoolArn?: AmazonResourceName;
/**
* The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run. Either devicePoolArn or deviceSelectionConfiguration is required in a request.
*/
deviceSelectionConfiguration?: DeviceSelectionConfiguration;
/**
* The name for the run to be scheduled.
*/
name?: Name;
/**
* Information about the test for the run to be scheduled.
*/
test: ScheduleRunTest;
/**
* Information about the settings for the run to be scheduled.
*/
configuration?: ScheduleRunConfiguration;
/**
* Specifies configuration information about a test run, such as the execution timeout (in minutes).
*/
executionConfiguration?: ExecutionConfiguration;
}
export interface ScheduleRunResult {
/**
* Information about the scheduled run.
*/
run?: Run;
}
export interface ScheduleRunTest {
/**
* The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
type: TestType;
/**
* The ARN of the uploaded test that will be run.
*/
testPackageArn?: AmazonResourceName;
/**
* The ARN of the YAML-formatted test specification.
*/
testSpecArn?: AmazonResourceName;
/**
* The test's filter.
*/
filter?: Filter;
/**
* The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings. For all tests: app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to "false" to disable it. For Calabash tests: profile: A cucumber profile, for example, "my_profile_name". tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, "@smoke" or "@smoke,~@wip". For Appium tests (all types): appium_version: The Appium version. Currently supported values are "1.6.5" (and higher), "latest", and "default". “latest” will run the latest Appium version supported by Device Farm (1.9.1). For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later. This behavior is subject to change. For Fuzz tests (Android only): event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform. throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events. seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences. For Explorer tests: username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted. password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted. For Instrumentation: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2" For XCTest and XCTestUI: filter: A test filter string. Examples: Running a single test class: "LoginTests" Running a multiple test classes: "LoginTests,SmokeTests" Running a single test: "LoginTests/testValid" Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid" For UIAutomator: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
*/
parameters?: TestParameters;
}
export type ServiceDnsName = string;
export type SkipAppResign = boolean;
export type SshPublicKey = string;
export interface StopJobRequest {
/**
* Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
*/
arn: AmazonResourceName;
}
export interface StopJobResult {
/**
* The job that was stopped.
*/
job?: Job;
}
export interface StopRemoteAccessSessionRequest {
/**
* The Amazon Resource Name (ARN) of the remote access session you wish to stop.
*/
arn: AmazonResourceName;
}
export interface StopRemoteAccessSessionResult {
/**
* A container representing the metadata from the service about the remote access session you are stopping.
*/
remoteAccessSession?: RemoteAccessSession;
}
export interface StopRunRequest {
/**
* Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
*/
arn: AmazonResourceName;
}
export interface StopRunResult {
/**
* The run that was stopped.
*/
run?: Run;
}
export type String = string;
export interface Suite {
/**
* The suite's ARN.
*/
arn?: AmazonResourceName;
/**
* The suite's name.
*/
name?: Name;
/**
* The suite's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
type?: TestType;
/**
* When the suite was created.
*/
created?: DateTime;
/**
* The suite's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
*/
status?: ExecutionStatus;
/**
* The suite's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* The suite's start time.
*/
started?: DateTime;
/**
* The suite's stop time.
*/
stopped?: DateTime;
/**
* The suite's result counters.
*/
counters?: Counters;
/**
* A message about the suite's result.
*/
message?: Message;
/**
* Represents the total (metered or unmetered) minutes used by the test suite.
*/
deviceMinutes?: DeviceMinutes;
}
export type Suites = Suite[];
export interface Tag {
/**
* One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
*/
Key: TagKey;
/**
* The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource(s) to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.
*/
ResourceARN: AmazonResourceName;
/**
* The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface Test {
/**
* The test's ARN.
*/
arn?: AmazonResourceName;
/**
* The test's name.
*/
name?: Name;
/**
* The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The Xcode test type. XCTEST_UI: The Xcode UI test type.
*/
type?: TestType;
/**
* When the test was created.
*/
created?: DateTime;
/**
* The test's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
*/
status?: ExecutionStatus;
/**
* The test's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
*/
result?: ExecutionResult;
/**
* The test's start time.
*/
started?: DateTime;
/**
* The test's stop time.
*/
stopped?: DateTime;
/**
* The test's result counters.
*/
counters?: Counters;
/**
* A message about the test's result.
*/
message?: Message;
/**
* Represents the total (metered or unmetered) minutes used by the test.
*/
deviceMinutes?: DeviceMinutes;
}
export type TestParameters = {[key: string]: String};
export type TestType = "BUILTIN_FUZZ"|"BUILTIN_EXPLORER"|"WEB_PERFORMANCE_PROFILE"|"APPIUM_JAVA_JUNIT"|"APPIUM_JAVA_TESTNG"|"APPIUM_PYTHON"|"APPIUM_NODE"|"APPIUM_RUBY"|"APPIUM_WEB_JAVA_JUNIT"|"APPIUM_WEB_JAVA_TESTNG"|"APPIUM_WEB_PYTHON"|"APPIUM_WEB_NODE"|"APPIUM_WEB_RUBY"|"CALABASH"|"INSTRUMENTATION"|"UIAUTOMATION"|"UIAUTOMATOR"|"XCTEST"|"XCTEST_UI"|"REMOTE_ACCESS_RECORD"|"REMOTE_ACCESS_REPLAY"|string;
export type Tests = Test[];
export type TransactionIdentifier = string;
export interface TrialMinutes {
/**
* The total number of free trial minutes that the account started with.
*/
total?: Double;
/**
* The number of free trial minutes remaining in the account.
*/
remaining?: Double;
}
export type URL = string;
export interface UniqueProblem {
/**
* A message about the unique problems' result.
*/
message?: Message;
/**
* Information about the problems.
*/
problems?: Problems;
}
export type UniqueProblems = UniqueProblem[];
export type UniqueProblemsByExecutionResultMap = {[key: string]: UniqueProblems};
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource(s) from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.
*/
ResourceARN: AmazonResourceName;
/**
* The keys of the tags to be removed.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateDeviceInstanceRequest {
/**
* The Amazon Resource Name (ARN) of the device instance.
*/
arn: AmazonResourceName;
/**
* The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.
*/
profileArn?: AmazonResourceName;
/**
* An array of strings that you want to associate with the device instance.
*/
labels?: InstanceLabels;
}
export interface UpdateDeviceInstanceResult {
/**
* An object containing information about your device instance.
*/
deviceInstance?: DeviceInstance;
}
export interface UpdateDevicePoolRequest {
/**
* The Amazon Resource Name (ARN) of the Device Farm device pool you wish to update.
*/
arn: AmazonResourceName;
/**
* A string representing the name of the device pool you wish to update.
*/
name?: Name;
/**
* A description of the device pool you wish to update.
*/
description?: Message;
/**
* Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
*/
rules?: Rules;
/**
* The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests. If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.
*/
maxDevices?: Integer;
/**
* Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter. If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.
*/
clearMaxDevices?: Boolean;
}
export interface UpdateDevicePoolResult {
/**
* The device pool you just updated.
*/
devicePool?: DevicePool;
}
export interface UpdateInstanceProfileRequest {
/**
* The Amazon Resource Name (ARN) of the instance profile.
*/
arn: AmazonResourceName;
/**
* The updated name for your instance profile.
*/
name?: Name;
/**
* The updated description for your instance profile.
*/
description?: Message;
/**
* The updated choice for whether you want to specify package cleanup. The default value is false for private devices.
*/
packageCleanup?: Boolean;
/**
* An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
*/
excludeAppPackagesFromCleanup?: PackageIds;
/**
* The updated choice for whether you want to reboot the device after use. The default value is true.
*/
rebootAfterUse?: Boolean;
}
export interface UpdateInstanceProfileResult {
/**
* An object containing information about your instance profile.
*/
instanceProfile?: InstanceProfile;
}
export interface UpdateNetworkProfileRequest {
/**
* The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
*/
arn: AmazonResourceName;
/**
* The name of the network profile about which you are returning information.
*/
name?: Name;
/**
* The description of the network profile about which you are returning information.
*/
description?: Message;
/**
* The type of network profile you wish to return information about. Valid values are listed below.
*/
type?: NetworkProfileType;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
uplinkBandwidthBits?: Long;
/**
* The data throughput rate in bits per second, as an integer from 0 to 104857600.
*/
downlinkBandwidthBits?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
uplinkDelayMs?: Long;
/**
* Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
*/
downlinkDelayMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
uplinkJitterMs?: Long;
/**
* Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
*/
downlinkJitterMs?: Long;
/**
* Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
*/
uplinkLossPercent?: PercentInteger;
/**
* Proportion of received packets that fail to arrive from 0 to 100 percent.
*/
downlinkLossPercent?: PercentInteger;
}
export interface UpdateNetworkProfileResult {
/**
* A list of the available network profiles.
*/
networkProfile?: NetworkProfile;
}
export interface UpdateProjectRequest {
/**
* The Amazon Resource Name (ARN) of the project whose name you wish to update.
*/
arn: AmazonResourceName;
/**
* A string representing the new name of the project that you are updating.
*/
name?: Name;
/**
* The number of minutes a test run in the project will execute before it times out.
*/
defaultJobTimeoutMinutes?: JobTimeoutMinutes;
}
export interface UpdateProjectResult {
/**
* The project you wish to update.
*/
project?: Project;
}
export interface UpdateUploadRequest {
/**
* The Amazon Resource Name (ARN) of the uploaded test spec.
*/
arn: AmazonResourceName;
/**
* The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the .yaml or .yml file extension.
*/
name?: Name;
/**
* The upload's content type (for example, "application/x-yaml").
*/
contentType?: ContentType;
/**
* Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.
*/
editContent?: Boolean;
}
export interface UpdateUploadResult {
/**
* A test spec uploaded to Device Farm.
*/
upload?: Upload;
}
export interface UpdateVPCEConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
*/
arn: AmazonResourceName;
/**
* The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
*/
vpceConfigurationName?: VPCEConfigurationName;
/**
* The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
*/
vpceServiceName?: VPCEServiceName;
/**
* The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.
*/
serviceDnsName?: ServiceDnsName;
/**
* An optional description, providing more details about your VPC endpoint configuration.
*/
vpceConfigurationDescription?: VPCEConfigurationDescription;
}
export interface UpdateVPCEConfigurationResult {
/**
* An object containing information about your VPC endpoint configuration.
*/
vpceConfiguration?: VPCEConfiguration;
}
export interface Upload {
/**
* The upload's ARN.
*/
arn?: AmazonResourceName;
/**
* The upload's file name.
*/
name?: Name;
/**
* When the upload was created.
*/
created?: DateTime;
/**
* The upload's type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web application upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An Xcode test package upload. XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.
*/
type?: UploadType;
/**
* The upload's status. Must be one of the following values: FAILED: A failed status. INITIALIZED: An initialized status. PROCESSING: A processing status. SUCCEEDED: A succeeded status.
*/
status?: UploadStatus;
/**
* The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
*/
url?: URL;
/**
* The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
*/
metadata?: Metadata;
/**
* The upload's content type (for example, "application/octet-stream").
*/
contentType?: ContentType;
/**
* A message about the upload's result.
*/
message?: Message;
/**
* The upload's category. Allowed values include: CURATED: An upload managed by AWS Device Farm. PRIVATE: An upload managed by the AWS Device Farm customer.
*/
category?: UploadCategory;
}
export type UploadCategory = "CURATED"|"PRIVATE"|string;
export type UploadStatus = "INITIALIZED"|"PROCESSING"|"SUCCEEDED"|"FAILED"|string;
export type UploadType = "ANDROID_APP"|"IOS_APP"|"WEB_APP"|"EXTERNAL_DATA"|"APPIUM_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_PYTHON_TEST_PACKAGE"|"APPIUM_NODE_TEST_PACKAGE"|"APPIUM_RUBY_TEST_PACKAGE"|"APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_WEB_PYTHON_TEST_PACKAGE"|"APPIUM_WEB_NODE_TEST_PACKAGE"|"APPIUM_WEB_RUBY_TEST_PACKAGE"|"CALABASH_TEST_PACKAGE"|"INSTRUMENTATION_TEST_PACKAGE"|"UIAUTOMATION_TEST_PACKAGE"|"UIAUTOMATOR_TEST_PACKAGE"|"XCTEST_TEST_PACKAGE"|"XCTEST_UI_TEST_PACKAGE"|"APPIUM_JAVA_JUNIT_TEST_SPEC"|"APPIUM_JAVA_TESTNG_TEST_SPEC"|"APPIUM_PYTHON_TEST_SPEC"|"APPIUM_NODE_TEST_SPEC"|"APPIUM_RUBY_TEST_SPEC"|"APPIUM_WEB_JAVA_JUNIT_TEST_SPEC"|"APPIUM_WEB_JAVA_TESTNG_TEST_SPEC"|"APPIUM_WEB_PYTHON_TEST_SPEC"|"APPIUM_WEB_NODE_TEST_SPEC"|"APPIUM_WEB_RUBY_TEST_SPEC"|"INSTRUMENTATION_TEST_SPEC"|"XCTEST_UI_TEST_SPEC"|string;
export type Uploads = Upload[];
export interface VPCEConfiguration {
/**
* The Amazon Resource Name (ARN) of the VPC endpoint configuration.
*/
arn?: AmazonResourceName;
/**
* The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
*/
vpceConfigurationName?: VPCEConfigurationName;
/**
* The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
*/
vpceServiceName?: VPCEServiceName;
/**
* The DNS name that maps to the private IP address of the service you want to access.
*/
serviceDnsName?: ServiceDnsName;
/**
* An optional description, providing more details about your VPC endpoint configuration.
*/
vpceConfigurationDescription?: VPCEConfigurationDescription;
}
export type VPCEConfigurationDescription = string;
export type VPCEConfigurationName = string;
export type VPCEConfigurations = VPCEConfiguration[];
export type VPCEServiceName = string;
export type VideoCapture = boolean;
/**
* 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-06-23"|"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 DeviceFarm client.
*/
export import Types = DeviceFarm;
}
export = DeviceFarm;