kinesisanalyticsv2.d.ts
106 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class KinesisAnalyticsV2 extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: KinesisAnalyticsV2.Types.ClientConfiguration)
config: Config & KinesisAnalyticsV2.Types.ClientConfiguration;
/**
* Adds an Amazon CloudWatch log stream to monitor application configuration errors.
*/
addApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Adds an Amazon CloudWatch log stream to monitor application configuration errors.
*/
addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationInput(params: KinesisAnalyticsV2.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
/**
* Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationInput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
/**
* Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
*/
addApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
*/
addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationOutput(params: KinesisAnalyticsV2.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
/**
* Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
/**
* Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
*/
addApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
/**
* Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
*/
addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
/**
* Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
*/
addApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
/**
* Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
*/
addApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
/**
* Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
*/
createApplication(params: KinesisAnalyticsV2.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
/**
* Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
*/
createApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
/**
* Creates a snapshot of the application's state data.
*/
createApplicationSnapshot(params: KinesisAnalyticsV2.Types.CreateApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
/**
* Creates a snapshot of the application's state data.
*/
createApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
/**
* Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
*/
deleteApplication(params: KinesisAnalyticsV2.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
/**
* Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
*/
deleteApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
/**
* Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
*/
deleteApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
*/
deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Deletes an InputProcessingConfiguration from an input.
*/
deleteApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Deletes an InputProcessingConfiguration from an input.
*/
deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
*/
deleteApplicationOutput(params: KinesisAnalyticsV2.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
/**
* Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
*/
deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
/**
* Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
*/
deleteApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
/**
* Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
*/
deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
/**
* Deletes a snapshot of application state.
*/
deleteApplicationSnapshot(params: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
/**
* Deletes a snapshot of application state.
*/
deleteApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
/**
* Removes a VPC configuration from a Kinesis Data Analytics application.
*/
deleteApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
/**
* Removes a VPC configuration from a Kinesis Data Analytics application.
*/
deleteApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
/**
* Returns information about a specific Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
*/
describeApplication(params: KinesisAnalyticsV2.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
/**
* Returns information about a specific Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
*/
describeApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
/**
* Returns information about a snapshot of application state data.
*/
describeApplicationSnapshot(params: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
/**
* Returns information about a snapshot of application state data.
*/
describeApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
/**
* Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
*/
discoverInputSchema(params: KinesisAnalyticsV2.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
/**
* Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
*/
discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
/**
* Lists information about the current application snapshots.
*/
listApplicationSnapshots(params: KinesisAnalyticsV2.Types.ListApplicationSnapshotsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
/**
* Lists information about the current application snapshots.
*/
listApplicationSnapshots(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
/**
* Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
*/
listApplications(params: KinesisAnalyticsV2.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
/**
* Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
*/
listApplications(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
/**
* Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
*/
listTagsForResource(params: KinesisAnalyticsV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
*/
listTagsForResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
*/
startApplication(params: KinesisAnalyticsV2.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
/**
* Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
*/
startApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
/**
* Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.
*/
stopApplication(params: KinesisAnalyticsV2.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
/**
* Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.
*/
stopApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
/**
* Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
*/
tagResource(params: KinesisAnalyticsV2.Types.TagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
*/
tagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging.
*/
untagResource(params: KinesisAnalyticsV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging.
*/
untagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.
*/
updateApplication(params: KinesisAnalyticsV2.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
/**
* Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.
*/
updateApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
}
declare namespace KinesisAnalyticsV2 {
export interface AddApplicationCloudWatchLoggingOptionRequest {
/**
* The Kinesis Data Analytics application name.
*/
ApplicationName: ApplicationName;
/**
* The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
*/
CloudWatchLoggingOption: CloudWatchLoggingOption;
}
export interface AddApplicationCloudWatchLoggingOptionResponse {
/**
* The application's ARN.
*/
ApplicationARN?: ResourceARN;
/**
* The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.
*/
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
}
export interface AddApplicationInputProcessingConfigurationRequest {
/**
* The name of the application to which you want to add the input processing configuration.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
*/
InputId: Id;
/**
* The InputProcessingConfiguration to add to the application.
*/
InputProcessingConfiguration: InputProcessingConfiguration;
}
export interface AddApplicationInputProcessingConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
*/
InputId?: Id;
/**
* The description of the preprocessor that executes on records in this input before the application's code is run.
*/
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
}
export interface AddApplicationInputRequest {
/**
* The name of your existing application to which you want to add the streaming source.
*/
ApplicationName: ApplicationName;
/**
* The current version of your application. You can use the DescribeApplication operation to find the current application version.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The Input to add.
*/
Input: Input;
}
export interface AddApplicationInputResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes the application input configuration.
*/
InputDescriptions?: InputDescriptions;
}
export interface AddApplicationOutputRequest {
/**
* The name of the application to which you want to add the output configuration.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
*/
Output: Output;
}
export interface AddApplicationOutputResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes the application output configuration. For more information, see Configuring Application Output.
*/
OutputDescriptions?: OutputDescriptions;
}
export interface AddApplicationReferenceDataSourceRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
*/
ReferenceDataSource: ReferenceDataSource;
}
export interface AddApplicationReferenceDataSourceResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes reference data sources configured for the application.
*/
ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
}
export interface AddApplicationVpcConfigurationRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the VPC configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* Description of the VPC to add to the application.
*/
VpcConfiguration: VpcConfiguration;
}
export interface AddApplicationVpcConfigurationResponse {
/**
* The ARN of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The parameters of the new VPC configuration.
*/
VpcConfigurationDescription?: VpcConfigurationDescription;
}
export interface ApplicationCodeConfiguration {
/**
* The location and type of the application code.
*/
CodeContent?: CodeContent;
/**
* Specifies whether the code content is in text or zip format.
*/
CodeContentType: CodeContentType;
}
export interface ApplicationCodeConfigurationDescription {
/**
* Specifies whether the code content is in text or zip format.
*/
CodeContentType: CodeContentType;
/**
* Describes details about the location and format of the application code.
*/
CodeContentDescription?: CodeContentDescription;
}
export interface ApplicationCodeConfigurationUpdate {
/**
* Describes updates to the code content type.
*/
CodeContentTypeUpdate?: CodeContentType;
/**
* Describes updates to the code content of an application.
*/
CodeContentUpdate?: CodeContentUpdate;
}
export interface ApplicationConfiguration {
/**
* The creation and update parameters for a SQL-based Kinesis Data Analytics application.
*/
SqlApplicationConfiguration?: SqlApplicationConfiguration;
/**
* The creation and update parameters for a Flink-based Kinesis Data Analytics application.
*/
FlinkApplicationConfiguration?: FlinkApplicationConfiguration;
/**
* Describes execution properties for a Flink-based Kinesis Data Analytics application.
*/
EnvironmentProperties?: EnvironmentProperties;
/**
* The code location and type parameters for a Flink-based Kinesis Data Analytics application.
*/
ApplicationCodeConfiguration: ApplicationCodeConfiguration;
/**
* Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfiguration?: ApplicationSnapshotConfiguration;
/**
* The array of descriptions of VPC configurations available to the application.
*/
VpcConfigurations?: VpcConfigurations;
}
export interface ApplicationConfigurationDescription {
/**
* The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
*/
SqlApplicationConfigurationDescription?: SqlApplicationConfigurationDescription;
/**
* The details about the application code for a Flink-based Kinesis Data Analytics application.
*/
ApplicationCodeConfigurationDescription?: ApplicationCodeConfigurationDescription;
/**
* The details about the starting properties for a Kinesis Data Analytics application.
*/
RunConfigurationDescription?: RunConfigurationDescription;
/**
* The details about a Flink-based Kinesis Data Analytics application.
*/
FlinkApplicationConfigurationDescription?: FlinkApplicationConfigurationDescription;
/**
* Describes execution properties for a Flink-based Kinesis Data Analytics application.
*/
EnvironmentPropertyDescriptions?: EnvironmentPropertyDescriptions;
/**
* Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfigurationDescription?: ApplicationSnapshotConfigurationDescription;
/**
* The array of descriptions of VPC configurations available to the application.
*/
VpcConfigurationDescriptions?: VpcConfigurationDescriptions;
}
export interface ApplicationConfigurationUpdate {
/**
* Describes updates to a SQL-based Kinesis Data Analytics application's configuration.
*/
SqlApplicationConfigurationUpdate?: SqlApplicationConfigurationUpdate;
/**
* Describes updates to a Flink-based Kinesis Data Analytics application's code configuration.
*/
ApplicationCodeConfigurationUpdate?: ApplicationCodeConfigurationUpdate;
/**
* Describes updates to a Flink-based Kinesis Data Analytics application's configuration.
*/
FlinkApplicationConfigurationUpdate?: FlinkApplicationConfigurationUpdate;
/**
* Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.
*/
EnvironmentPropertyUpdates?: EnvironmentPropertyUpdates;
/**
* Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfigurationUpdate?: ApplicationSnapshotConfigurationUpdate;
/**
* Updates to the array of descriptions of VPC configurations available to the application.
*/
VpcConfigurationUpdates?: VpcConfigurationUpdates;
}
export type ApplicationDescription = string;
export interface ApplicationDetail {
/**
* The ARN of the application.
*/
ApplicationARN: ResourceARN;
/**
* The description of the application.
*/
ApplicationDescription?: ApplicationDescription;
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).
*/
RuntimeEnvironment: RuntimeEnvironment;
/**
* Specifies the IAM role that the application uses to access external resources.
*/
ServiceExecutionRole?: RoleARN;
/**
* The status of the application.
*/
ApplicationStatus: ApplicationStatus;
/**
* Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
*/
ApplicationVersionId: ApplicationVersionId;
/**
* The current timestamp when the application was created.
*/
CreateTimestamp?: Timestamp;
/**
* The current timestamp when the application was last updated.
*/
LastUpdateTimestamp?: Timestamp;
/**
* Provides details about the application's Java, SQL, or Scala code and starting parameters.
*/
ApplicationConfigurationDescription?: ApplicationConfigurationDescription;
/**
* Describes the application Amazon CloudWatch logging options.
*/
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
}
export type ApplicationName = string;
export interface ApplicationRestoreConfiguration {
/**
* Specifies how the application should be restored.
*/
ApplicationRestoreType: ApplicationRestoreType;
/**
* The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
*/
SnapshotName?: SnapshotName;
}
export type ApplicationRestoreType = "SKIP_RESTORE_FROM_SNAPSHOT"|"RESTORE_FROM_LATEST_SNAPSHOT"|"RESTORE_FROM_CUSTOM_SNAPSHOT"|string;
export interface ApplicationSnapshotConfiguration {
/**
* Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
SnapshotsEnabled: BooleanObject;
}
export interface ApplicationSnapshotConfigurationDescription {
/**
* Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
SnapshotsEnabled: BooleanObject;
}
export interface ApplicationSnapshotConfigurationUpdate {
/**
* Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
*/
SnapshotsEnabledUpdate: BooleanObject;
}
export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|"AUTOSCALING"|"FORCE_STOPPING"|string;
export type ApplicationSummaries = ApplicationSummary[];
export interface ApplicationSummary {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The ARN of the application.
*/
ApplicationARN: ResourceARN;
/**
* The status of the application.
*/
ApplicationStatus: ApplicationStatus;
/**
* Provides the current application version.
*/
ApplicationVersionId: ApplicationVersionId;
/**
* The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).
*/
RuntimeEnvironment: RuntimeEnvironment;
}
export type ApplicationVersionId = number;
export type BooleanObject = boolean;
export type BucketARN = string;
export interface CSVMappingParameters {
/**
* The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
*/
RecordRowDelimiter: RecordRowDelimiter;
/**
* The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
*/
RecordColumnDelimiter: RecordColumnDelimiter;
}
export interface CheckpointConfiguration {
/**
* Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationType: ConfigurationType;
/**
* Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabled?: BooleanObject;
/**
* Describes the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointInterval?: CheckpointInterval;
/**
* Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
}
export interface CheckpointConfigurationDescription {
/**
* Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationType?: ConfigurationType;
/**
* Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabled?: BooleanObject;
/**
* Describes the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointInterval?: CheckpointInterval;
/**
* Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
}
export interface CheckpointConfigurationUpdate {
/**
* Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationTypeUpdate?: ConfigurationType;
/**
* Describes updates to whether checkpointing is enabled for an application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabledUpdate?: BooleanObject;
/**
* Describes updates to the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointIntervalUpdate?: CheckpointInterval;
/**
* Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpointsUpdate?: MinPauseBetweenCheckpoints;
}
export type CheckpointInterval = number;
export interface CloudWatchLoggingOption {
/**
* The ARN of the CloudWatch log to receive application messages.
*/
LogStreamARN: LogStreamARN;
}
export interface CloudWatchLoggingOptionDescription {
/**
* The ID of the CloudWatch logging option description.
*/
CloudWatchLoggingOptionId?: Id;
/**
* The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*/
LogStreamARN: LogStreamARN;
/**
* The IAM ARN of the role to use to send application messages. Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[];
export interface CloudWatchLoggingOptionUpdate {
/**
* The ID of the CloudWatch logging option to update
*/
CloudWatchLoggingOptionId: Id;
/**
* The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*/
LogStreamARNUpdate?: LogStreamARN;
}
export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[];
export type CloudWatchLoggingOptions = CloudWatchLoggingOption[];
export interface CodeContent {
/**
* The text-format code for a Flink-based Kinesis Data Analytics application.
*/
TextContent?: TextContent;
/**
* The zip-format code for a Flink-based Kinesis Data Analytics application.
*/
ZipFileContent?: ZipFileContent;
/**
* Information about the Amazon S3 bucket containing the application code.
*/
S3ContentLocation?: S3ContentLocation;
}
export interface CodeContentDescription {
/**
* The text-format code
*/
TextContent?: TextContent;
/**
* The checksum that can be used to validate zip-format code.
*/
CodeMD5?: CodeMD5;
/**
* The size in bytes of the application code. Can be used to validate zip-format code.
*/
CodeSize?: CodeSize;
/**
* The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
*/
S3ApplicationCodeLocationDescription?: S3ApplicationCodeLocationDescription;
}
export type CodeContentType = "PLAINTEXT"|"ZIPFILE"|string;
export interface CodeContentUpdate {
/**
* Describes an update to the text code for an application.
*/
TextContentUpdate?: TextContent;
/**
* Describes an update to the zipped code for an application.
*/
ZipFileContentUpdate?: ZipFileContent;
/**
* Describes an update to the location of code for an application.
*/
S3ContentLocationUpdate?: S3ContentLocationUpdate;
}
export type CodeMD5 = string;
export type CodeSize = number;
export type ConfigurationType = "DEFAULT"|"CUSTOM"|string;
export interface CreateApplicationRequest {
/**
* The name of your application (for example, sample-app).
*/
ApplicationName: ApplicationName;
/**
* A summary description of the application.
*/
ApplicationDescription?: ApplicationDescription;
/**
* The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).
*/
RuntimeEnvironment: RuntimeEnvironment;
/**
* The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
*/
ServiceExecutionRole: RoleARN;
/**
* Use this parameter to configure the application.
*/
ApplicationConfiguration?: ApplicationConfiguration;
/**
* Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
*/
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
/**
* A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
*/
Tags?: Tags;
}
export interface CreateApplicationResponse {
/**
* In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.
*/
ApplicationDetail: ApplicationDetail;
}
export interface CreateApplicationSnapshotRequest {
/**
* The name of an existing application
*/
ApplicationName: ApplicationName;
/**
* An identifier for the application snapshot.
*/
SnapshotName: SnapshotName;
}
export interface CreateApplicationSnapshotResponse {
}
export interface DeleteApplicationCloudWatchLoggingOptionRequest {
/**
* The application name.
*/
ApplicationName: ApplicationName;
/**
* The version ID of the application. You can retrieve the application version ID using DescribeApplication.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.
*/
CloudWatchLoggingOptionId: Id;
}
export interface DeleteApplicationCloudWatchLoggingOptionResponse {
/**
* The application's Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The descriptions of the remaining CloudWatch logging options for the application.
*/
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
}
export interface DeleteApplicationInputProcessingConfigurationRequest {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
*/
InputId: Id;
}
export interface DeleteApplicationInputProcessingConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationARN?: ResourceARN;
/**
* The current application version ID.
*/
ApplicationVersionId?: ApplicationVersionId;
}
export interface DeleteApplicationOutputRequest {
/**
* The application name.
*/
ApplicationName: ApplicationName;
/**
* The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.
*/
OutputId: Id;
}
export interface DeleteApplicationOutputResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The current application version ID.
*/
ApplicationVersionId?: ApplicationVersionId;
}
export interface DeleteApplicationReferenceDataSourceRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
*/
ReferenceId: Id;
}
export interface DeleteApplicationReferenceDataSourceResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The updated version ID of the application.
*/
ApplicationVersionId?: ApplicationVersionId;
}
export interface DeleteApplicationRequest {
/**
* The name of the application to delete.
*/
ApplicationName: ApplicationName;
/**
* Use the DescribeApplication operation to get this value.
*/
CreateTimestamp: Timestamp;
}
export interface DeleteApplicationResponse {
}
export interface DeleteApplicationSnapshotRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The identifier for the snapshot delete.
*/
SnapshotName: SnapshotName;
/**
* The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
*/
SnapshotCreationTimestamp: Timestamp;
}
export interface DeleteApplicationSnapshotResponse {
}
export interface DeleteApplicationVpcConfigurationRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The current application version ID. You can retrieve the application version ID using DescribeApplication.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the VPC configuration to delete.
*/
VpcConfigurationId: Id;
}
export interface DeleteApplicationVpcConfigurationResponse {
/**
* The ARN of the Kinesis Data Analytics application.
*/
ApplicationARN?: ResourceARN;
/**
* The updated version ID of the application.
*/
ApplicationVersionId?: ApplicationVersionId;
}
export interface DescribeApplicationRequest {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.
*/
IncludeAdditionalDetails?: BooleanObject;
}
export interface DescribeApplicationResponse {
/**
* Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.
*/
ApplicationDetail: ApplicationDetail;
}
export interface DescribeApplicationSnapshotRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The identifier of an application snapshot. You can retrieve this value using .
*/
SnapshotName: SnapshotName;
}
export interface DescribeApplicationSnapshotResponse {
/**
* An object containing information about the application snapshot.
*/
SnapshotDetails: SnapshotDetails;
}
export interface DestinationSchema {
/**
* Specifies the format of the records on the output stream.
*/
RecordFormatType: RecordFormatType;
}
export interface DiscoverInputSchemaRequest {
/**
* The Amazon Resource Name (ARN) of the streaming source.
*/
ResourceARN?: ResourceARN;
/**
* The ARN of the role that is used to access the streaming source.
*/
ServiceExecutionRole: RoleARN;
/**
* The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.
*/
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
/**
* Specify this parameter to discover a schema from data in an Amazon S3 object.
*/
S3Configuration?: S3Configuration;
/**
* The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
*/
InputProcessingConfiguration?: InputProcessingConfiguration;
}
export interface DiscoverInputSchemaResponse {
/**
* The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
*/
InputSchema?: SourceSchema;
/**
* An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
*/
ParsedInputRecords?: ParsedInputRecords;
/**
* The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.
*/
ProcessedInputRecords?: ProcessedInputRecords;
/**
* The raw stream data that was sampled to infer the schema.
*/
RawInputRecords?: RawInputRecords;
}
export interface EnvironmentProperties {
/**
* Describes the execution property groups.
*/
PropertyGroups: PropertyGroups;
}
export interface EnvironmentPropertyDescriptions {
/**
* Describes the execution property groups.
*/
PropertyGroupDescriptions?: PropertyGroups;
}
export interface EnvironmentPropertyUpdates {
/**
* Describes updates to the execution property groups.
*/
PropertyGroups: PropertyGroups;
}
export type FileKey = string;
export interface FlinkApplicationConfiguration {
/**
* Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
*/
CheckpointConfiguration?: CheckpointConfiguration;
/**
* Describes configuration parameters for Amazon CloudWatch logging for an application.
*/
MonitoringConfiguration?: MonitoringConfiguration;
/**
* Describes parameters for how an application executes multiple tasks simultaneously.
*/
ParallelismConfiguration?: ParallelismConfiguration;
}
export interface FlinkApplicationConfigurationDescription {
/**
* Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
*/
CheckpointConfigurationDescription?: CheckpointConfigurationDescription;
/**
* Describes configuration parameters for Amazon CloudWatch logging for an application.
*/
MonitoringConfigurationDescription?: MonitoringConfigurationDescription;
/**
* Describes parameters for how an application executes multiple tasks simultaneously.
*/
ParallelismConfigurationDescription?: ParallelismConfigurationDescription;
/**
* The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
*/
JobPlanDescription?: JobPlanDescription;
}
export interface FlinkApplicationConfigurationUpdate {
/**
* Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
*/
CheckpointConfigurationUpdate?: CheckpointConfigurationUpdate;
/**
* Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
*/
MonitoringConfigurationUpdate?: MonitoringConfigurationUpdate;
/**
* Describes updates to the parameters for how an application executes multiple tasks simultaneously.
*/
ParallelismConfigurationUpdate?: ParallelismConfigurationUpdate;
}
export interface FlinkRunConfiguration {
/**
* When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation. This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
*/
AllowNonRestoredState?: BooleanObject;
}
export type Id = string;
export type InAppStreamName = string;
export type InAppStreamNames = InAppStreamName[];
export type InAppTableName = string;
export interface Input {
/**
* The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
*/
NamePrefix: InAppStreamName;
/**
* The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
*/
InputProcessingConfiguration?: InputProcessingConfiguration;
/**
* If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
*/
KinesisStreamsInput?: KinesisStreamsInput;
/**
* If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
*/
KinesisFirehoseInput?: KinesisFirehoseInput;
/**
* Describes the number of in-application streams to create.
*/
InputParallelism?: InputParallelism;
/**
* Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source.
*/
InputSchema: SourceSchema;
}
export interface InputDescription {
/**
* The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
*/
InputId?: Id;
/**
* The in-application name prefix.
*/
NamePrefix?: InAppStreamName;
/**
* Returns the in-application stream names that are mapped to the stream source.
*/
InAppStreamNames?: InAppStreamNames;
/**
* The description of the preprocessor that executes on records in this input before the application's code is run.
*/
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
/**
* If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
*/
KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
/**
* If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
*/
KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
/**
* Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
*/
InputSchema?: SourceSchema;
/**
* Describes the configured parallelism (number of in-application streams mapped to the streaming source).
*/
InputParallelism?: InputParallelism;
/**
* The point at which the application is configured to read from the input stream.
*/
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
}
export type InputDescriptions = InputDescription[];
export interface InputLambdaProcessor {
/**
* The ARN of the AWS Lambda function that operates on records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*/
ResourceARN: ResourceARN;
}
export interface InputLambdaProcessorDescription {
/**
* The ARN of the AWS Lambda function that is used to preprocess the records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that is used to access the AWS Lambda function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface InputLambdaProcessorUpdate {
/**
* The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*/
ResourceARNUpdate: ResourceARN;
}
export interface InputParallelism {
/**
* The number of in-application streams to create.
*/
Count?: InputParallelismCount;
}
export type InputParallelismCount = number;
export interface InputParallelismUpdate {
/**
* The number of in-application streams to create for the specified streaming source.
*/
CountUpdate: InputParallelismCount;
}
export interface InputProcessingConfiguration {
/**
* The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
*/
InputLambdaProcessor: InputLambdaProcessor;
}
export interface InputProcessingConfigurationDescription {
/**
* Provides configuration information about the associated InputLambdaProcessorDescription
*/
InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
}
export interface InputProcessingConfigurationUpdate {
/**
* Provides update information for an InputLambdaProcessor.
*/
InputLambdaProcessorUpdate: InputLambdaProcessorUpdate;
}
export interface InputSchemaUpdate {
/**
* Specifies the format of the records on the streaming source.
*/
RecordFormatUpdate?: RecordFormat;
/**
* Specifies the encoding of the records in the streaming source; for example, UTF-8.
*/
RecordEncodingUpdate?: RecordEncoding;
/**
* A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
*/
RecordColumnUpdates?: RecordColumns;
}
export type InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"|string;
export interface InputStartingPositionConfiguration {
/**
* The starting position on the stream. NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued. TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream. LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
*/
InputStartingPosition?: InputStartingPosition;
}
export interface InputUpdate {
/**
* The input ID of the application input to be updated.
*/
InputId: Id;
/**
* The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
*/
NamePrefixUpdate?: InAppStreamName;
/**
* Describes updates to an InputProcessingConfiguration.
*/
InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
/**
* If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
*/
KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
/**
* If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
*/
KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
/**
* Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
*/
InputSchemaUpdate?: InputSchemaUpdate;
/**
* Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
*/
InputParallelismUpdate?: InputParallelismUpdate;
}
export type InputUpdates = InputUpdate[];
export type Inputs = Input[];
export interface JSONMappingParameters {
/**
* The path to the top-level parent that contains the records.
*/
RecordRowPath: RecordRowPath;
}
export type JobPlanDescription = string;
export type KinesisAnalyticsARN = string;
export interface KinesisFirehoseInput {
/**
* The Amazon Resource Name (ARN) of the delivery stream.
*/
ResourceARN: ResourceARN;
}
export interface KinesisFirehoseInputDescription {
/**
* The Amazon Resource Name (ARN) of the delivery stream.
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface KinesisFirehoseInputUpdate {
/**
* The Amazon Resource Name (ARN) of the input delivery stream to read.
*/
ResourceARNUpdate: ResourceARN;
}
export interface KinesisFirehoseOutput {
/**
* The ARN of the destination delivery stream to write to.
*/
ResourceARN: ResourceARN;
}
export interface KinesisFirehoseOutputDescription {
/**
* The Amazon Resource Name (ARN) of the delivery stream.
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface KinesisFirehoseOutputUpdate {
/**
* The Amazon Resource Name (ARN) of the delivery stream to write to.
*/
ResourceARNUpdate: ResourceARN;
}
export interface KinesisStreamsInput {
/**
* The ARN of the input Kinesis data stream to read.
*/
ResourceARN: ResourceARN;
}
export interface KinesisStreamsInputDescription {
/**
* The Amazon Resource Name (ARN) of the Kinesis data stream.
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface KinesisStreamsInputUpdate {
/**
* The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
*/
ResourceARNUpdate: ResourceARN;
}
export interface KinesisStreamsOutput {
/**
* The ARN of the destination Kinesis data stream to write to.
*/
ResourceARN: ResourceARN;
}
export interface KinesisStreamsOutputDescription {
/**
* The Amazon Resource Name (ARN) of the Kinesis data stream.
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface KinesisStreamsOutputUpdate {
/**
* The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
*/
ResourceARNUpdate: ResourceARN;
}
export interface LambdaOutput {
/**
* The Amazon Resource Name (ARN) of the destination Lambda function to write to. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*/
ResourceARN: ResourceARN;
}
export interface LambdaOutputDescription {
/**
* The Amazon Resource Name (ARN) of the destination Lambda function.
*/
ResourceARN: ResourceARN;
/**
* The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export interface LambdaOutputUpdate {
/**
* The Amazon Resource Name (ARN) of the destination AWS Lambda function. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*/
ResourceARNUpdate: ResourceARN;
}
export interface ListApplicationSnapshotsRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The maximum number of application snapshots to list.
*/
Limit?: ListSnapshotsInputLimit;
/**
* Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
}
export interface ListApplicationSnapshotsResponse {
/**
* A collection of objects containing information about the application snapshots.
*/
SnapshotSummaries?: SnapshotSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
NextToken?: NextToken;
}
export type ListApplicationsInputLimit = number;
export interface ListApplicationsRequest {
/**
* The maximum number of applications to list.
*/
Limit?: ListApplicationsInputLimit;
/**
* If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.
*/
NextToken?: ApplicationName;
}
export interface ListApplicationsResponse {
/**
* A list of ApplicationSummary objects.
*/
ApplicationSummaries: ApplicationSummaries;
/**
* The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.
*/
NextToken?: ApplicationName;
}
export type ListSnapshotsInputLimit = number;
export interface ListTagsForResourceRequest {
/**
* The ARN of the application for which to retrieve tags.
*/
ResourceARN: KinesisAnalyticsARN;
}
export interface ListTagsForResourceResponse {
/**
* The key-value tags assigned to the application.
*/
Tags?: Tags;
}
export type LogLevel = "INFO"|"WARN"|"ERROR"|"DEBUG"|string;
export type LogStreamARN = string;
export interface MappingParameters {
/**
* Provides additional mapping information when JSON is the record format on the streaming source.
*/
JSONMappingParameters?: JSONMappingParameters;
/**
* Provides additional mapping information when the record format uses delimiters (for example, CSV).
*/
CSVMappingParameters?: CSVMappingParameters;
}
export type MetricsLevel = "APPLICATION"|"TASK"|"OPERATOR"|"PARALLELISM"|string;
export type MinPauseBetweenCheckpoints = number;
export interface MonitoringConfiguration {
/**
* Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
*/
ConfigurationType: ConfigurationType;
/**
* Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
*/
MetricsLevel?: MetricsLevel;
/**
* Describes the verbosity of the CloudWatch Logs for an application.
*/
LogLevel?: LogLevel;
}
export interface MonitoringConfigurationDescription {
/**
* Describes whether to use the default CloudWatch logging configuration for an application.
*/
ConfigurationType?: ConfigurationType;
/**
* Describes the granularity of the CloudWatch Logs for an application.
*/
MetricsLevel?: MetricsLevel;
/**
* Describes the verbosity of the CloudWatch Logs for an application.
*/
LogLevel?: LogLevel;
}
export interface MonitoringConfigurationUpdate {
/**
* Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
*/
ConfigurationTypeUpdate?: ConfigurationType;
/**
* Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
*/
MetricsLevelUpdate?: MetricsLevel;
/**
* Describes updates to the verbosity of the CloudWatch Logs for an application.
*/
LogLevelUpdate?: LogLevel;
}
export type NextToken = string;
export type ObjectVersion = string;
export interface Output {
/**
* The name of the in-application stream.
*/
Name: InAppStreamName;
/**
* Identifies a Kinesis data stream as the destination.
*/
KinesisStreamsOutput?: KinesisStreamsOutput;
/**
* Identifies a Kinesis Data Firehose delivery stream as the destination.
*/
KinesisFirehoseOutput?: KinesisFirehoseOutput;
/**
* Identifies an AWS Lambda function as the destination.
*/
LambdaOutput?: LambdaOutput;
/**
* Describes the data format when records are written to the destination.
*/
DestinationSchema: DestinationSchema;
}
export interface OutputDescription {
/**
* A unique identifier for the output configuration.
*/
OutputId?: Id;
/**
* The name of the in-application stream that is configured as output.
*/
Name?: InAppStreamName;
/**
* Describes the Kinesis data stream that is configured as the destination where output is written.
*/
KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
/**
* Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
*/
KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
/**
* Describes the Lambda function that is configured as the destination where output is written.
*/
LambdaOutputDescription?: LambdaOutputDescription;
/**
* The data format used for writing data to the destination.
*/
DestinationSchema?: DestinationSchema;
}
export type OutputDescriptions = OutputDescription[];
export interface OutputUpdate {
/**
* Identifies the specific output configuration that you want to update.
*/
OutputId: Id;
/**
* If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
*/
NameUpdate?: InAppStreamName;
/**
* Describes a Kinesis data stream as the destination for the output.
*/
KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
/**
* Describes a Kinesis Data Firehose delivery stream as the destination for the output.
*/
KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
/**
* Describes an AWS Lambda function as the destination for the output.
*/
LambdaOutputUpdate?: LambdaOutputUpdate;
/**
* Describes the data format when records are written to the destination.
*/
DestinationSchemaUpdate?: DestinationSchema;
}
export type OutputUpdates = OutputUpdate[];
export type Outputs = Output[];
export type Parallelism = number;
export interface ParallelismConfiguration {
/**
* Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
*/
ConfigurationType: ConfigurationType;
/**
* Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
*/
Parallelism?: Parallelism;
/**
* Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.
*/
ParallelismPerKPU?: ParallelismPerKPU;
/**
* Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
*/
AutoScalingEnabled?: BooleanObject;
}
export interface ParallelismConfigurationDescription {
/**
* Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
*/
ConfigurationType?: ConfigurationType;
/**
* Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
*/
Parallelism?: Parallelism;
/**
* Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
*/
ParallelismPerKPU?: ParallelismPerKPU;
/**
* Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
*/
CurrentParallelism?: Parallelism;
/**
* Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
*/
AutoScalingEnabled?: BooleanObject;
}
export interface ParallelismConfigurationUpdate {
/**
* Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
*/
ConfigurationTypeUpdate?: ConfigurationType;
/**
* Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.
*/
ParallelismUpdate?: Parallelism;
/**
* Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
*/
ParallelismPerKPUUpdate?: ParallelismPerKPU;
/**
* Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
*/
AutoScalingEnabledUpdate?: BooleanObject;
}
export type ParallelismPerKPU = number;
export type ParsedInputRecord = ParsedInputRecordField[];
export type ParsedInputRecordField = string;
export type ParsedInputRecords = ParsedInputRecord[];
export type ProcessedInputRecord = string;
export type ProcessedInputRecords = ProcessedInputRecord[];
export interface PropertyGroup {
/**
* Describes the key of an application execution property key-value pair.
*/
PropertyGroupId: Id;
/**
* Describes the value of an application execution property key-value pair.
*/
PropertyMap: PropertyMap;
}
export type PropertyGroups = PropertyGroup[];
export type PropertyKey = string;
export type PropertyMap = {[key: string]: PropertyValue};
export type PropertyValue = string;
export type RawInputRecord = string;
export type RawInputRecords = RawInputRecord[];
export interface RecordColumn {
/**
* The name of the column that is created in the in-application input stream or reference table.
*/
Name: RecordColumnName;
/**
* A reference to the data element in the streaming input or the reference data source.
*/
Mapping?: RecordColumnMapping;
/**
* The type of column created in the in-application input stream or reference table.
*/
SqlType: RecordColumnSqlType;
}
export type RecordColumnDelimiter = string;
export type RecordColumnMapping = string;
export type RecordColumnName = string;
export type RecordColumnSqlType = string;
export type RecordColumns = RecordColumn[];
export type RecordEncoding = string;
export interface RecordFormat {
/**
* The type of record format.
*/
RecordFormatType: RecordFormatType;
/**
* When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
*/
MappingParameters?: MappingParameters;
}
export type RecordFormatType = "JSON"|"CSV"|string;
export type RecordRowDelimiter = string;
export type RecordRowPath = string;
export interface ReferenceDataSource {
/**
* The name of the in-application table to create.
*/
TableName: InAppTableName;
/**
* Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
*/
S3ReferenceDataSource?: S3ReferenceDataSource;
/**
* Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
*/
ReferenceSchema: SourceSchema;
}
export interface ReferenceDataSourceDescription {
/**
* The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
*/
ReferenceId: Id;
/**
* The in-application table name created by the specific reference data source configuration.
*/
TableName: InAppTableName;
/**
* Provides the Amazon S3 bucket name, the object key name that contains the reference data.
*/
S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription;
/**
* Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
*/
ReferenceSchema?: SourceSchema;
}
export type ReferenceDataSourceDescriptions = ReferenceDataSourceDescription[];
export interface ReferenceDataSourceUpdate {
/**
* The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
*/
ReferenceId: Id;
/**
* The in-application table name that is created by this update.
*/
TableNameUpdate?: InAppTableName;
/**
* Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
*/
S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
/**
* Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
*/
ReferenceSchemaUpdate?: SourceSchema;
}
export type ReferenceDataSourceUpdates = ReferenceDataSourceUpdate[];
export type ReferenceDataSources = ReferenceDataSource[];
export type ResourceARN = string;
export type RoleARN = string;
export interface RunConfiguration {
/**
* Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
*/
FlinkRunConfiguration?: FlinkRunConfiguration;
/**
* Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.
*/
SqlRunConfigurations?: SqlRunConfigurations;
/**
* Describes the restore behavior of a restarting application.
*/
ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
}
export interface RunConfigurationDescription {
/**
* Describes the restore behavior of a restarting application.
*/
ApplicationRestoreConfigurationDescription?: ApplicationRestoreConfiguration;
FlinkRunConfigurationDescription?: FlinkRunConfiguration;
}
export interface RunConfigurationUpdate {
/**
* Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
*/
FlinkRunConfiguration?: FlinkRunConfiguration;
/**
* Describes updates to the restore behavior of a restarting application.
*/
ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
}
export type RuntimeEnvironment = "SQL-1_0"|"FLINK-1_6"|"FLINK-1_8"|string;
export interface S3ApplicationCodeLocationDescription {
/**
* The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*/
BucketARN: BucketARN;
/**
* The file key for the object containing the application code.
*/
FileKey: FileKey;
/**
* The version of the object containing the application code.
*/
ObjectVersion?: ObjectVersion;
}
export interface S3Configuration {
/**
* The ARN of the S3 bucket that contains the data.
*/
BucketARN: BucketARN;
/**
* The name of the object that contains the data.
*/
FileKey: FileKey;
}
export interface S3ContentLocation {
/**
* The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*/
BucketARN: BucketARN;
/**
* The file key for the object containing the application code.
*/
FileKey: FileKey;
/**
* The version of the object containing the application code.
*/
ObjectVersion?: ObjectVersion;
}
export interface S3ContentLocationUpdate {
/**
* The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*/
BucketARNUpdate?: BucketARN;
/**
* The new file key for the object containing the application code.
*/
FileKeyUpdate?: FileKey;
/**
* The new version of the object containing the application code.
*/
ObjectVersionUpdate?: ObjectVersion;
}
export interface S3ReferenceDataSource {
/**
* The Amazon Resource Name (ARN) of the S3 bucket.
*/
BucketARN?: BucketARN;
/**
* The object key name containing the reference data.
*/
FileKey?: FileKey;
}
export interface S3ReferenceDataSourceDescription {
/**
* The Amazon Resource Name (ARN) of the S3 bucket.
*/
BucketARN: BucketARN;
/**
* Amazon S3 object key name.
*/
FileKey: FileKey;
/**
* The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
*/
ReferenceRoleARN?: RoleARN;
}
export interface S3ReferenceDataSourceUpdate {
/**
* The Amazon Resource Name (ARN) of the S3 bucket.
*/
BucketARNUpdate?: BucketARN;
/**
* The object key name.
*/
FileKeyUpdate?: FileKey;
}
export type SecurityGroupId = string;
export type SecurityGroupIds = SecurityGroupId[];
export interface SnapshotDetails {
/**
* The identifier for the application snapshot.
*/
SnapshotName: SnapshotName;
/**
* The status of the application snapshot.
*/
SnapshotStatus: SnapshotStatus;
/**
* The current application version ID when the snapshot was created.
*/
ApplicationVersionId: ApplicationVersionId;
/**
* The timestamp of the application snapshot.
*/
SnapshotCreationTimestamp?: Timestamp;
}
export type SnapshotName = string;
export type SnapshotStatus = "CREATING"|"READY"|"DELETING"|"FAILED"|string;
export type SnapshotSummaries = SnapshotDetails[];
export interface SourceSchema {
/**
* Specifies the format of the records on the streaming source.
*/
RecordFormat: RecordFormat;
/**
* Specifies the encoding of the records in the streaming source. For example, UTF-8.
*/
RecordEncoding?: RecordEncoding;
/**
* A list of RecordColumn objects.
*/
RecordColumns: RecordColumns;
}
export interface SqlApplicationConfiguration {
/**
* The array of Input objects describing the input streams used by the application.
*/
Inputs?: Inputs;
/**
* The array of Output objects describing the destination streams used by the application.
*/
Outputs?: Outputs;
/**
* The array of ReferenceDataSource objects describing the reference data sources used by the application.
*/
ReferenceDataSources?: ReferenceDataSources;
}
export interface SqlApplicationConfigurationDescription {
/**
* The array of InputDescription objects describing the input streams used by the application.
*/
InputDescriptions?: InputDescriptions;
/**
* The array of OutputDescription objects describing the destination streams used by the application.
*/
OutputDescriptions?: OutputDescriptions;
/**
* The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
*/
ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
}
export interface SqlApplicationConfigurationUpdate {
/**
* The array of InputUpdate objects describing the new input streams used by the application.
*/
InputUpdates?: InputUpdates;
/**
* The array of OutputUpdate objects describing the new destination streams used by the application.
*/
OutputUpdates?: OutputUpdates;
/**
* The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
*/
ReferenceDataSourceUpdates?: ReferenceDataSourceUpdates;
}
export interface SqlRunConfiguration {
/**
* The input source ID. You can get this ID by calling the DescribeApplication operation.
*/
InputId: Id;
/**
* The point at which you want the application to start processing records from the streaming source.
*/
InputStartingPositionConfiguration: InputStartingPositionConfiguration;
}
export type SqlRunConfigurations = SqlRunConfiguration[];
export interface StartApplicationRequest {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.
*/
RunConfiguration: RunConfiguration;
}
export interface StartApplicationResponse {
}
export interface StopApplicationRequest {
/**
* The name of the running application to stop.
*/
ApplicationName: ApplicationName;
/**
* Set to true to force the application to stop. If you set Force to true, Kinesis Data Analytics stops the application without taking a snapshot. You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application. The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING state.
*/
Force?: BooleanObject;
}
export interface StopApplicationResponse {
}
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export interface Tag {
/**
* The key of the key-value tag.
*/
Key: TagKey;
/**
* The value of the key-value tag. The value is optional.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeys = TagKey[];
export interface TagResourceRequest {
/**
* The ARN of the application to assign the tags.
*/
ResourceARN: KinesisAnalyticsARN;
/**
* The key-value tags to assign to the application.
*/
Tags: Tags;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Tags = Tag[];
export type TextContent = string;
export type Timestamp = Date;
export interface UntagResourceRequest {
/**
* The ARN of the Kinesis Data Analytics application from which to remove the tags.
*/
ResourceARN: KinesisAnalyticsARN;
/**
* A list of keys of tags to remove from the specified application.
*/
TagKeys: TagKeys;
}
export interface UntagResourceResponse {
}
export interface UpdateApplicationRequest {
/**
* The name of the application to update.
*/
ApplicationName: ApplicationName;
/**
* The current application version ID. You can retrieve the application version ID using DescribeApplication.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* Describes application configuration updates.
*/
ApplicationConfigurationUpdate?: ApplicationConfigurationUpdate;
/**
* Describes updates to the service execution role.
*/
ServiceExecutionRoleUpdate?: RoleARN;
/**
* Describes updates to the application's starting parameters.
*/
RunConfigurationUpdate?: RunConfigurationUpdate;
/**
* Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
*/
CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdates;
}
export interface UpdateApplicationResponse {
/**
* Describes application updates.
*/
ApplicationDetail: ApplicationDetail;
}
export interface VpcConfiguration {
/**
* The array of Subnet IDs used by the VPC configuration.
*/
SubnetIds: SubnetIds;
/**
* The array of SecurityGroup IDs used by the VPC configuration.
*/
SecurityGroupIds: SecurityGroupIds;
}
export interface VpcConfigurationDescription {
/**
* The ID of the VPC configuration.
*/
VpcConfigurationId: Id;
/**
* The ID of the associated VPC.
*/
VpcId: VpcId;
/**
* The array of Subnet IDs used by the VPC configuration.
*/
SubnetIds: SubnetIds;
/**
* The array of SecurityGroup IDs used by the VPC configuration.
*/
SecurityGroupIds: SecurityGroupIds;
}
export type VpcConfigurationDescriptions = VpcConfigurationDescription[];
export interface VpcConfigurationUpdate {
/**
* Describes an update to the ID of the VPC configuration.
*/
VpcConfigurationId: Id;
/**
* Describes updates to the array of Subnet IDs used by the VPC configuration.
*/
SubnetIdUpdates?: SubnetIds;
/**
* Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
*/
SecurityGroupIdUpdates?: SecurityGroupIds;
}
export type VpcConfigurationUpdates = VpcConfigurationUpdate[];
export type VpcConfigurations = VpcConfiguration[];
export type VpcId = string;
export type ZipFileContent = Buffer|Uint8Array|Blob|string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-05-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 KinesisAnalyticsV2 client.
*/
export import Types = KinesisAnalyticsV2;
}
export = KinesisAnalyticsV2;