lambda.d.ts
122 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
import {Readable} from 'stream';
interface Blob {}
declare class Lambda extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Lambda.Types.ClientConfiguration)
config: Config & Lambda.Types.ClientConfiguration;
/**
* Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
*/
addLayerVersionPermission(params: Lambda.Types.AddLayerVersionPermissionRequest, callback?: (err: AWSError, data: Lambda.Types.AddLayerVersionPermissionResponse) => void): Request<Lambda.Types.AddLayerVersionPermissionResponse, AWSError>;
/**
* Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
*/
addLayerVersionPermission(callback?: (err: AWSError, data: Lambda.Types.AddLayerVersionPermissionResponse) => void): Request<Lambda.Types.AddLayerVersionPermissionResponse, AWSError>;
/**
* Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
*/
addPermission(params: Lambda.Types.AddPermissionRequest, callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request<Lambda.Types.AddPermissionResponse, AWSError>;
/**
* Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
*/
addPermission(callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request<Lambda.Types.AddPermissionResponse, AWSError>;
/**
* Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
*/
createAlias(params: Lambda.Types.CreateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
*/
createAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. For details about each event source type, see the following topics. Using AWS Lambda with Amazon DynamoDB Using AWS Lambda with Amazon Kinesis Using AWS Lambda with Amazon SQS Using AWS Lambda with Amazon MSK The following error handling options are only available for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. Default -1 (infinite). Minimum 60. Maximum 604800. MaximumRetryAttempts - Discard records after the specified number of retries. Default -1 (infinite). Minimum 0. Maximum 10000. When infinite, failed records will be retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently.
*/
createEventSourceMapping(params: Lambda.Types.CreateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. For details about each event source type, see the following topics. Using AWS Lambda with Amazon DynamoDB Using AWS Lambda with Amazon Kinesis Using AWS Lambda with Amazon SQS Using AWS Lambda with Amazon MSK The following error handling options are only available for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. Default -1 (infinite). Minimum 60. Maximum 604800. MaximumRetryAttempts - Discard records after the specified number of retries. Default -1 (infinite). Minimum 0. Maximum 10000. When infinite, failed records will be retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently.
*/
createEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
*/
createFunction(params: Lambda.Types.CreateFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
*/
createFunction(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Deletes a Lambda function alias.
*/
deleteAlias(params: Lambda.Types.DeleteAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Lambda function alias.
*/
deleteAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.
*/
deleteEventSourceMapping(params: Lambda.Types.DeleteEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.
*/
deleteEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
*/
deleteFunction(params: Lambda.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
*/
deleteFunction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a concurrent execution limit from a function.
*/
deleteFunctionConcurrency(params: Lambda.Types.DeleteFunctionConcurrencyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a concurrent execution limit from a function.
*/
deleteFunctionConcurrency(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
deleteFunctionEventInvokeConfig(params: Lambda.Types.DeleteFunctionEventInvokeConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
deleteFunctionEventInvokeConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
*/
deleteLayerVersion(params: Lambda.Types.DeleteLayerVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
*/
deleteLayerVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the provisioned concurrency configuration for a function.
*/
deleteProvisionedConcurrencyConfig(params: Lambda.Types.DeleteProvisionedConcurrencyConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the provisioned concurrency configuration for a function.
*/
deleteProvisionedConcurrencyConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves details about your account's limits and usage in an AWS Region.
*/
getAccountSettings(params: Lambda.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Lambda.Types.GetAccountSettingsResponse) => void): Request<Lambda.Types.GetAccountSettingsResponse, AWSError>;
/**
* Retrieves details about your account's limits and usage in an AWS Region.
*/
getAccountSettings(callback?: (err: AWSError, data: Lambda.Types.GetAccountSettingsResponse) => void): Request<Lambda.Types.GetAccountSettingsResponse, AWSError>;
/**
* Returns details about a Lambda function alias.
*/
getAlias(params: Lambda.Types.GetAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Returns details about a Lambda function alias.
*/
getAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
*/
getEventSourceMapping(params: Lambda.Types.GetEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
*/
getEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
*/
getFunction(params: Lambda.Types.GetFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>;
/**
* Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
*/
getFunction(callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>;
/**
* Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
*/
getFunctionConcurrency(params: Lambda.Types.GetFunctionConcurrencyRequest, callback?: (err: AWSError, data: Lambda.Types.GetFunctionConcurrencyResponse) => void): Request<Lambda.Types.GetFunctionConcurrencyResponse, AWSError>;
/**
* Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
*/
getFunctionConcurrency(callback?: (err: AWSError, data: Lambda.Types.GetFunctionConcurrencyResponse) => void): Request<Lambda.Types.GetFunctionConcurrencyResponse, AWSError>;
/**
* Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function's details, including function-level settings, use GetFunction.
*/
getFunctionConfiguration(params: Lambda.Types.GetFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function's details, including function-level settings, use GetFunction.
*/
getFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
getFunctionEventInvokeConfig(params: Lambda.Types.GetFunctionEventInvokeConfigRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
getFunctionEventInvokeConfig(callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
*/
getLayerVersion(params: Lambda.Types.GetLayerVersionRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request<Lambda.Types.GetLayerVersionResponse, AWSError>;
/**
* Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
*/
getLayerVersion(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request<Lambda.Types.GetLayerVersionResponse, AWSError>;
/**
* Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
*/
getLayerVersionByArn(params: Lambda.Types.GetLayerVersionByArnRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request<Lambda.Types.GetLayerVersionResponse, AWSError>;
/**
* Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
*/
getLayerVersionByArn(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request<Lambda.Types.GetLayerVersionResponse, AWSError>;
/**
* Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
*/
getLayerVersionPolicy(params: Lambda.Types.GetLayerVersionPolicyRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionPolicyResponse) => void): Request<Lambda.Types.GetLayerVersionPolicyResponse, AWSError>;
/**
* Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
*/
getLayerVersionPolicy(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionPolicyResponse) => void): Request<Lambda.Types.GetLayerVersionPolicyResponse, AWSError>;
/**
* Returns the resource-based IAM policy for a function, version, or alias.
*/
getPolicy(params: Lambda.Types.GetPolicyRequest, callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request<Lambda.Types.GetPolicyResponse, AWSError>;
/**
* Returns the resource-based IAM policy for a function, version, or alias.
*/
getPolicy(callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request<Lambda.Types.GetPolicyResponse, AWSError>;
/**
* Retrieves the provisioned concurrency configuration for a function's alias or version.
*/
getProvisionedConcurrencyConfig(params: Lambda.Types.GetProvisionedConcurrencyConfigRequest, callback?: (err: AWSError, data: Lambda.Types.GetProvisionedConcurrencyConfigResponse) => void): Request<Lambda.Types.GetProvisionedConcurrencyConfigResponse, AWSError>;
/**
* Retrieves the provisioned concurrency configuration for a function's alias or version.
*/
getProvisionedConcurrencyConfig(callback?: (err: AWSError, data: Lambda.Types.GetProvisionedConcurrencyConfigResponse) => void): Request<Lambda.Types.GetProvisionedConcurrencyConfigResponse, AWSError>;
/**
* Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event. For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior. For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue. The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings. This operation requires permission for the lambda:InvokeFunction action.
*/
invoke(params: Lambda.Types.InvocationRequest, callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request<Lambda.Types.InvocationResponse, AWSError>;
/**
* Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event. For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior. For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue. The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings. This operation requires permission for the lambda:InvokeFunction action.
*/
invoke(callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request<Lambda.Types.InvocationResponse, AWSError>;
/**
* For asynchronous function invocation, use Invoke. Invokes a function asynchronously.
*/
invokeAsync(params: Lambda.Types.InvokeAsyncRequest, callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request<Lambda.Types.InvokeAsyncResponse, AWSError>;
/**
* For asynchronous function invocation, use Invoke. Invokes a function asynchronously.
*/
invokeAsync(callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request<Lambda.Types.InvokeAsyncResponse, AWSError>;
/**
* Returns a list of aliases for a Lambda function.
*/
listAliases(params: Lambda.Types.ListAliasesRequest, callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request<Lambda.Types.ListAliasesResponse, AWSError>;
/**
* Returns a list of aliases for a Lambda function.
*/
listAliases(callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request<Lambda.Types.ListAliasesResponse, AWSError>;
/**
* Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.
*/
listEventSourceMappings(params: Lambda.Types.ListEventSourceMappingsRequest, callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request<Lambda.Types.ListEventSourceMappingsResponse, AWSError>;
/**
* Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.
*/
listEventSourceMappings(callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request<Lambda.Types.ListEventSourceMappingsResponse, AWSError>;
/**
* Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
listFunctionEventInvokeConfigs(params: Lambda.Types.ListFunctionEventInvokeConfigsRequest, callback?: (err: AWSError, data: Lambda.Types.ListFunctionEventInvokeConfigsResponse) => void): Request<Lambda.Types.ListFunctionEventInvokeConfigsResponse, AWSError>;
/**
* Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
listFunctionEventInvokeConfigs(callback?: (err: AWSError, data: Lambda.Types.ListFunctionEventInvokeConfigsResponse) => void): Request<Lambda.Types.ListFunctionEventInvokeConfigsResponse, AWSError>;
/**
* Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call. Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
*/
listFunctions(params: Lambda.Types.ListFunctionsRequest, callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request<Lambda.Types.ListFunctionsResponse, AWSError>;
/**
* Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call. Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
*/
listFunctions(callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request<Lambda.Types.ListFunctionsResponse, AWSError>;
/**
* Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
*/
listLayerVersions(params: Lambda.Types.ListLayerVersionsRequest, callback?: (err: AWSError, data: Lambda.Types.ListLayerVersionsResponse) => void): Request<Lambda.Types.ListLayerVersionsResponse, AWSError>;
/**
* Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
*/
listLayerVersions(callback?: (err: AWSError, data: Lambda.Types.ListLayerVersionsResponse) => void): Request<Lambda.Types.ListLayerVersionsResponse, AWSError>;
/**
* Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
*/
listLayers(params: Lambda.Types.ListLayersRequest, callback?: (err: AWSError, data: Lambda.Types.ListLayersResponse) => void): Request<Lambda.Types.ListLayersResponse, AWSError>;
/**
* Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
*/
listLayers(callback?: (err: AWSError, data: Lambda.Types.ListLayersResponse) => void): Request<Lambda.Types.ListLayersResponse, AWSError>;
/**
* Retrieves a list of provisioned concurrency configurations for a function.
*/
listProvisionedConcurrencyConfigs(params: Lambda.Types.ListProvisionedConcurrencyConfigsRequest, callback?: (err: AWSError, data: Lambda.Types.ListProvisionedConcurrencyConfigsResponse) => void): Request<Lambda.Types.ListProvisionedConcurrencyConfigsResponse, AWSError>;
/**
* Retrieves a list of provisioned concurrency configurations for a function.
*/
listProvisionedConcurrencyConfigs(callback?: (err: AWSError, data: Lambda.Types.ListProvisionedConcurrencyConfigsResponse) => void): Request<Lambda.Types.ListProvisionedConcurrencyConfigsResponse, AWSError>;
/**
* Returns a function's tags. You can also view tags with GetFunction.
*/
listTags(params: Lambda.Types.ListTagsRequest, callback?: (err: AWSError, data: Lambda.Types.ListTagsResponse) => void): Request<Lambda.Types.ListTagsResponse, AWSError>;
/**
* Returns a function's tags. You can also view tags with GetFunction.
*/
listTags(callback?: (err: AWSError, data: Lambda.Types.ListTagsResponse) => void): Request<Lambda.Types.ListTagsResponse, AWSError>;
/**
* Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
*/
listVersionsByFunction(params: Lambda.Types.ListVersionsByFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request<Lambda.Types.ListVersionsByFunctionResponse, AWSError>;
/**
* Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
*/
listVersionsByFunction(callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request<Lambda.Types.ListVersionsByFunctionResponse, AWSError>;
/**
* Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created. Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
*/
publishLayerVersion(params: Lambda.Types.PublishLayerVersionRequest, callback?: (err: AWSError, data: Lambda.Types.PublishLayerVersionResponse) => void): Request<Lambda.Types.PublishLayerVersionResponse, AWSError>;
/**
* Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created. Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
*/
publishLayerVersion(callback?: (err: AWSError, data: Lambda.Types.PublishLayerVersionResponse) => void): Request<Lambda.Types.PublishLayerVersionResponse, AWSError>;
/**
* Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
*/
publishVersion(params: Lambda.Types.PublishVersionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
*/
publishVersion(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level. Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function. Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
*/
putFunctionConcurrency(params: Lambda.Types.PutFunctionConcurrencyRequest, callback?: (err: AWSError, data: Lambda.Types.Concurrency) => void): Request<Lambda.Types.Concurrency, AWSError>;
/**
* Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level. Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function. Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
*/
putFunctionConcurrency(callback?: (err: AWSError, data: Lambda.Types.Concurrency) => void): Request<Lambda.Types.Concurrency, AWSError>;
/**
* Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig. By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration. To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
*/
putFunctionEventInvokeConfig(params: Lambda.Types.PutFunctionEventInvokeConfigRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig. By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration. To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
*/
putFunctionEventInvokeConfig(callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Adds a provisioned concurrency configuration to a function's alias or version.
*/
putProvisionedConcurrencyConfig(params: Lambda.Types.PutProvisionedConcurrencyConfigRequest, callback?: (err: AWSError, data: Lambda.Types.PutProvisionedConcurrencyConfigResponse) => void): Request<Lambda.Types.PutProvisionedConcurrencyConfigResponse, AWSError>;
/**
* Adds a provisioned concurrency configuration to a function's alias or version.
*/
putProvisionedConcurrencyConfig(callback?: (err: AWSError, data: Lambda.Types.PutProvisionedConcurrencyConfigResponse) => void): Request<Lambda.Types.PutProvisionedConcurrencyConfigResponse, AWSError>;
/**
* Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
*/
removeLayerVersionPermission(params: Lambda.Types.RemoveLayerVersionPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
*/
removeLayerVersionPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
*/
removePermission(params: Lambda.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
*/
removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to a function.
*/
tagResource(params: Lambda.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to a function.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from a function.
*/
untagResource(params: Lambda.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from a function.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the configuration of a Lambda function alias.
*/
updateAlias(params: Lambda.Types.UpdateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Updates the configuration of a Lambda function alias.
*/
updateAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>;
/**
* Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location. The following error handling options are only available for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. Default -1 (infinite). Minimum 60. Maximum 604800. MaximumRetryAttempts - Discard records after the specified number of retries. Default -1 (infinite). Minimum 0. Maximum 10000. When infinite, failed records will be retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently.
*/
updateEventSourceMapping(params: Lambda.Types.UpdateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location. The following error handling options are only available for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. Default -1 (infinite). Minimum 60. Maximum 604800. MaximumRetryAttempts - Discard records after the specified number of retries. Default -1 (infinite). Minimum 0. Maximum 10000. When infinite, failed records will be retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently.
*/
updateEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>;
/**
* Updates a Lambda function's code. The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
*/
updateFunctionCode(params: Lambda.Types.UpdateFunctionCodeRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Updates a Lambda function's code. The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
*/
updateFunctionCode(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
*/
updateFunctionConfiguration(params: Lambda.Types.UpdateFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
*/
updateFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
updateFunctionEventInvokeConfig(params: Lambda.Types.UpdateFunctionEventInvokeConfigRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
*/
updateFunctionEventInvokeConfig(callback?: (err: AWSError, data: Lambda.Types.FunctionEventInvokeConfig) => void): Request<Lambda.Types.FunctionEventInvokeConfig, AWSError>;
/**
* Waits for the functionExists state by periodically calling the underlying Lambda.getFunctionoperation every 1 seconds (at most 20 times).
*/
waitFor(state: "functionExists", params: Lambda.Types.GetFunctionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>;
/**
* Waits for the functionExists state by periodically calling the underlying Lambda.getFunctionoperation every 1 seconds (at most 20 times).
*/
waitFor(state: "functionExists", callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>;
/**
* Waits for the functionActive state by periodically calling the underlying Lambda.getFunctionConfigurationoperation every 5 seconds (at most 60 times). Waits for the function's State to be Active.
*/
waitFor(state: "functionActive", params: Lambda.Types.GetFunctionConfigurationRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Waits for the functionActive state by periodically calling the underlying Lambda.getFunctionConfigurationoperation every 5 seconds (at most 60 times). Waits for the function's State to be Active.
*/
waitFor(state: "functionActive", callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Waits for the functionUpdated state by periodically calling the underlying Lambda.getFunctionConfigurationoperation every 5 seconds (at most 60 times). Waits for the function's LastUpdateStatus to be Successful.
*/
waitFor(state: "functionUpdated", params: Lambda.Types.GetFunctionConfigurationRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
/**
* Waits for the functionUpdated state by periodically calling the underlying Lambda.getFunctionConfigurationoperation every 5 seconds (at most 60 times). Waits for the function's LastUpdateStatus to be Successful.
*/
waitFor(state: "functionUpdated", callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>;
}
declare namespace Lambda {
export interface AccountLimit {
/**
* The amount of storage space that you can use for all deployment packages and layer archives.
*/
TotalCodeSize?: Long;
/**
* The maximum size of a function's deployment package and layers when they're extracted.
*/
CodeSizeUnzipped?: Long;
/**
* The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files.
*/
CodeSizeZipped?: Long;
/**
* The maximum number of simultaneous function executions.
*/
ConcurrentExecutions?: Integer;
/**
* The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.
*/
UnreservedConcurrentExecutions?: UnreservedConcurrentExecutions;
}
export interface AccountUsage {
/**
* The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
*/
TotalCodeSize?: Long;
/**
* The number of Lambda functions.
*/
FunctionCount?: Long;
}
export type Action = string;
export interface AddLayerVersionPermissionRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The version number.
*/
VersionNumber: LayerVersionNumber;
/**
* An identifier that distinguishes the policy from others on the same layer version.
*/
StatementId: StatementId;
/**
* The API action that grants access to the layer. For example, lambda:GetLayerVersion.
*/
Action: LayerPermissionAllowedAction;
/**
* An account ID, or * to grant permission to all AWS accounts.
*/
Principal: LayerPermissionAllowedPrincipal;
/**
* With the principal set to *, grant permission to all accounts in the specified organization.
*/
OrganizationId?: OrganizationId;
/**
* Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
*/
RevisionId?: String;
}
export interface AddLayerVersionPermissionResponse {
/**
* The permission statement.
*/
Statement?: String;
/**
* A unique identifier for the current revision of the policy.
*/
RevisionId?: String;
}
export interface AddPermissionRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* A statement identifier that differentiates the statement from others in the same policy.
*/
StatementId: StatementId;
/**
* The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
*/
Action: Action;
/**
* The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
*/
Principal: Principal;
/**
* For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
*/
SourceArn?: Arn;
/**
* For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
*/
SourceAccount?: SourceOwner;
/**
* For Alexa Smart Home functions, a token that must be supplied by the invoker.
*/
EventSourceToken?: EventSourceToken;
/**
* Specify a version or alias to add permissions to a published version of the function.
*/
Qualifier?: Qualifier;
/**
* Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
*/
RevisionId?: String;
}
export interface AddPermissionResponse {
/**
* The permission statement that's added to the function policy.
*/
Statement?: String;
}
export type AdditionalVersion = string;
export type AdditionalVersionWeights = {[key: string]: Weight};
export type Alias = string;
export interface AliasConfiguration {
/**
* The Amazon Resource Name (ARN) of the alias.
*/
AliasArn?: FunctionArn;
/**
* The name of the alias.
*/
Name?: Alias;
/**
* The function version that the alias invokes.
*/
FunctionVersion?: Version;
/**
* A description of the alias.
*/
Description?: Description;
/**
* The routing configuration of the alias.
*/
RoutingConfig?: AliasRoutingConfiguration;
/**
* A unique identifier that changes when you update the alias.
*/
RevisionId?: String;
}
export type AliasList = AliasConfiguration[];
export interface AliasRoutingConfiguration {
/**
* The second version, and the percentage of traffic that's routed to it.
*/
AdditionalVersionWeights?: AdditionalVersionWeights;
}
export type Arn = string;
export type BatchSize = number;
export type BisectBatchOnFunctionError = boolean;
export type _Blob = Buffer|Uint8Array|Blob|string;
export type BlobStream = Buffer|Uint8Array|Blob|string|Readable;
export type Boolean = boolean;
export type CompatibleRuntimes = Runtime[];
export interface Concurrency {
/**
* The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
*/
ReservedConcurrentExecutions?: ReservedConcurrentExecutions;
}
export interface CreateAliasRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The name of the alias.
*/
Name: Alias;
/**
* The function version that the alias invokes.
*/
FunctionVersion: Version;
/**
* A description of the alias.
*/
Description?: Description;
/**
* The routing configuration of the alias.
*/
RoutingConfig?: AliasRoutingConfiguration;
}
export interface CreateEventSourceMappingRequest {
/**
* The Amazon Resource Name (ARN) of the event source. Amazon Kinesis - The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams - The ARN of the stream. Amazon Simple Queue Service - The ARN of the queue. Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.
*/
EventSourceArn: Arn;
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* If true, the event source mapping is active. Set to false to pause polling and invocation.
*/
Enabled?: Enabled;
/**
* The maximum number of items to retrieve in a single batch. Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 1,000. Amazon Simple Queue Service - Default 10. Max 10. Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
*/
BatchSize?: BatchSize;
/**
* (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
*/
MaximumBatchingWindowInSeconds?: MaximumBatchingWindowInSeconds;
/**
* (Streams) The number of batches to process from each shard concurrently.
*/
ParallelizationFactor?: ParallelizationFactor;
/**
* The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
*/
StartingPosition?: EventSourcePosition;
/**
* With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
*/
StartingPositionTimestamp?: _Date;
/**
* (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
*/
DestinationConfig?: DestinationConfig;
/**
* (Streams) Discard records older than the specified age. The default value is infinite (-1).
*/
MaximumRecordAgeInSeconds?: MaximumRecordAgeInSeconds;
/**
* (Streams) If the function returns an error, split the batch in two and retry.
*/
BisectBatchOnFunctionError?: BisectBatchOnFunctionError;
/**
* (Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
*/
MaximumRetryAttempts?: MaximumRetryAttemptsEventSourceMapping;
/**
* (MSK) The name of the Kafka topic.
*/
Topics?: Topics;
}
export interface CreateFunctionRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The identifier of the function's runtime.
*/
Runtime: Runtime;
/**
* The Amazon Resource Name (ARN) of the function's execution role.
*/
Role: RoleArn;
/**
* The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
*/
Handler: Handler;
/**
* The code for the function.
*/
Code: FunctionCode;
/**
* A description of the function.
*/
Description?: Description;
/**
* The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
*/
Timeout?: Timeout;
/**
* The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
*/
MemorySize?: MemorySize;
/**
* Set to true to publish the first version of the function during creation.
*/
Publish?: Boolean;
/**
* For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
*/
VpcConfig?: VpcConfig;
/**
* A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
*/
DeadLetterConfig?: DeadLetterConfig;
/**
* Environment variables that are accessible from function code during execution.
*/
Environment?: Environment;
/**
* The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
*/
KMSKeyArn?: KMSKeyArn;
/**
* Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
*/
TracingConfig?: TracingConfig;
/**
* A list of tags to apply to the function.
*/
Tags?: Tags;
/**
* A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
*/
Layers?: LayerList;
/**
* Connection settings for an Amazon EFS file system.
*/
FileSystemConfigs?: FileSystemConfigList;
}
export type _Date = Date;
export interface DeadLetterConfig {
/**
* The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
*/
TargetArn?: ResourceArn;
}
export interface DeleteAliasRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The name of the alias.
*/
Name: Alias;
}
export interface DeleteEventSourceMappingRequest {
/**
* The identifier of the event source mapping.
*/
UUID: String;
}
export interface DeleteFunctionConcurrencyRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
}
export interface DeleteFunctionEventInvokeConfigRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* A version number or alias name.
*/
Qualifier?: Qualifier;
}
export interface DeleteFunctionRequest {
/**
* The name of the Lambda function or version. Name formats Function name - my-function (name-only), my-function:1 (with version). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Specify a version to delete. You can't delete a version that's referenced by an alias.
*/
Qualifier?: Qualifier;
}
export interface DeleteLayerVersionRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The version number.
*/
VersionNumber: LayerVersionNumber;
}
export interface DeleteProvisionedConcurrencyConfigRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The version number or alias name.
*/
Qualifier: Qualifier;
}
export type Description = string;
export type DestinationArn = string;
export interface DestinationConfig {
/**
* The destination configuration for successful invocations.
*/
OnSuccess?: OnSuccess;
/**
* The destination configuration for failed invocations.
*/
OnFailure?: OnFailure;
}
export type Enabled = boolean;
export interface Environment {
/**
* Environment variable key-value pairs.
*/
Variables?: EnvironmentVariables;
}
export interface EnvironmentError {
/**
* The error code.
*/
ErrorCode?: String;
/**
* The error message.
*/
Message?: SensitiveString;
}
export interface EnvironmentResponse {
/**
* Environment variable key-value pairs.
*/
Variables?: EnvironmentVariables;
/**
* Error messages for environment variables that couldn't be applied.
*/
Error?: EnvironmentError;
}
export type EnvironmentVariableName = string;
export type EnvironmentVariableValue = string;
export type EnvironmentVariables = {[key: string]: EnvironmentVariableValue};
export interface EventSourceMappingConfiguration {
/**
* The identifier of the event source mapping.
*/
UUID?: String;
/**
* The maximum number of items to retrieve in a single batch.
*/
BatchSize?: BatchSize;
/**
* (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
*/
MaximumBatchingWindowInSeconds?: MaximumBatchingWindowInSeconds;
/**
* (Streams) The number of batches to process from each shard concurrently.
*/
ParallelizationFactor?: ParallelizationFactor;
/**
* The Amazon Resource Name (ARN) of the event source.
*/
EventSourceArn?: Arn;
/**
* The ARN of the Lambda function.
*/
FunctionArn?: FunctionArn;
/**
* The date that the event source mapping was last updated, or its state changed.
*/
LastModified?: _Date;
/**
* The result of the last AWS Lambda invocation of your Lambda function.
*/
LastProcessingResult?: String;
/**
* The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
*/
State?: String;
/**
* Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
*/
StateTransitionReason?: String;
/**
* (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
*/
DestinationConfig?: DestinationConfig;
/**
* (MSK) The name of the Kafka topic.
*/
Topics?: Topics;
/**
* (Streams) The maximum age of a record that Lambda sends to a function for processing.
*/
MaximumRecordAgeInSeconds?: MaximumRecordAgeInSeconds;
/**
* (Streams) If the function returns an error, split the batch in two and retry.
*/
BisectBatchOnFunctionError?: BisectBatchOnFunctionError;
/**
* (Streams) The maximum number of times to retry when the function returns an error.
*/
MaximumRetryAttempts?: MaximumRetryAttemptsEventSourceMapping;
}
export type EventSourceMappingsList = EventSourceMappingConfiguration[];
export type EventSourcePosition = "TRIM_HORIZON"|"LATEST"|"AT_TIMESTAMP"|string;
export type EventSourceToken = string;
export type FileSystemArn = string;
export interface FileSystemConfig {
/**
* The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
*/
Arn: FileSystemArn;
/**
* The path where the function can access the file system, starting with /mnt/.
*/
LocalMountPath: LocalMountPath;
}
export type FileSystemConfigList = FileSystemConfig[];
export type FunctionArn = string;
export interface FunctionCode {
/**
* The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
*/
ZipFile?: _Blob;
/**
* An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
*/
S3Bucket?: S3Bucket;
/**
* The Amazon S3 key of the deployment package.
*/
S3Key?: S3Key;
/**
* For versioned objects, the version of the deployment package object to use.
*/
S3ObjectVersion?: S3ObjectVersion;
}
export interface FunctionCodeLocation {
/**
* The service that's hosting the file.
*/
RepositoryType?: String;
/**
* A presigned URL that you can use to download the deployment package.
*/
Location?: String;
}
export interface FunctionConfiguration {
/**
* The name of the function.
*/
FunctionName?: NamespacedFunctionName;
/**
* The function's Amazon Resource Name (ARN).
*/
FunctionArn?: NameSpacedFunctionArn;
/**
* The runtime environment for the Lambda function.
*/
Runtime?: Runtime;
/**
* The function's execution role.
*/
Role?: RoleArn;
/**
* The function that Lambda calls to begin executing your function.
*/
Handler?: Handler;
/**
* The size of the function's deployment package, in bytes.
*/
CodeSize?: Long;
/**
* The function's description.
*/
Description?: Description;
/**
* The amount of time in seconds that Lambda allows a function to run before stopping it.
*/
Timeout?: Timeout;
/**
* The memory that's allocated to the function.
*/
MemorySize?: MemorySize;
/**
* The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/
LastModified?: Timestamp;
/**
* The SHA256 hash of the function's deployment package.
*/
CodeSha256?: String;
/**
* The version of the Lambda function.
*/
Version?: Version;
/**
* The function's networking configuration.
*/
VpcConfig?: VpcConfigResponse;
/**
* The function's dead letter queue.
*/
DeadLetterConfig?: DeadLetterConfig;
/**
* The function's environment variables.
*/
Environment?: EnvironmentResponse;
/**
* The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
*/
KMSKeyArn?: KMSKeyArn;
/**
* The function's AWS X-Ray tracing configuration.
*/
TracingConfig?: TracingConfigResponse;
/**
* For Lambda@Edge functions, the ARN of the master function.
*/
MasterArn?: FunctionArn;
/**
* The latest updated revision of the function or alias.
*/
RevisionId?: String;
/**
* The function's layers.
*/
Layers?: LayersReferenceList;
/**
* The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
*/
State?: State;
/**
* The reason for the function's current state.
*/
StateReason?: StateReason;
/**
* The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
*/
StateReasonCode?: StateReasonCode;
/**
* The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
*/
LastUpdateStatus?: LastUpdateStatus;
/**
* The reason for the last update that was performed on the function.
*/
LastUpdateStatusReason?: LastUpdateStatusReason;
/**
* The reason code for the last update that was performed on the function.
*/
LastUpdateStatusReasonCode?: LastUpdateStatusReasonCode;
/**
* Connection settings for an Amazon EFS file system.
*/
FileSystemConfigs?: FileSystemConfigList;
}
export interface FunctionEventInvokeConfig {
/**
* The date and time that the configuration was last updated.
*/
LastModified?: _Date;
/**
* The Amazon Resource Name (ARN) of the function.
*/
FunctionArn?: FunctionArn;
/**
* The maximum number of times to retry when the function returns an error.
*/
MaximumRetryAttempts?: MaximumRetryAttempts;
/**
* The maximum age of a request that Lambda sends to a function for processing.
*/
MaximumEventAgeInSeconds?: MaximumEventAgeInSeconds;
/**
* A destination for events after they have been sent to a function for processing. Destinations Function - The Amazon Resource Name (ARN) of a Lambda function. Queue - The ARN of an SQS queue. Topic - The ARN of an SNS topic. Event Bus - The ARN of an Amazon EventBridge event bus.
*/
DestinationConfig?: DestinationConfig;
}
export type FunctionEventInvokeConfigList = FunctionEventInvokeConfig[];
export type FunctionList = FunctionConfiguration[];
export type FunctionName = string;
export type FunctionVersion = "ALL"|string;
export interface GetAccountSettingsRequest {
}
export interface GetAccountSettingsResponse {
/**
* Limits that are related to concurrency and code storage.
*/
AccountLimit?: AccountLimit;
/**
* The number of functions and amount of storage in use.
*/
AccountUsage?: AccountUsage;
}
export interface GetAliasRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The name of the alias.
*/
Name: Alias;
}
export interface GetEventSourceMappingRequest {
/**
* The identifier of the event source mapping.
*/
UUID: String;
}
export interface GetFunctionConcurrencyRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
}
export interface GetFunctionConcurrencyResponse {
/**
* The number of simultaneous executions that are reserved for the function.
*/
ReservedConcurrentExecutions?: ReservedConcurrentExecutions;
}
export interface GetFunctionConfigurationRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* Specify a version or alias to get details about a published version of the function.
*/
Qualifier?: Qualifier;
}
export interface GetFunctionEventInvokeConfigRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* A version number or alias name.
*/
Qualifier?: Qualifier;
}
export interface GetFunctionRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* Specify a version or alias to get details about a published version of the function.
*/
Qualifier?: Qualifier;
}
export interface GetFunctionResponse {
/**
* The configuration of the function or version.
*/
Configuration?: FunctionConfiguration;
/**
* The deployment package of the function or version.
*/
Code?: FunctionCodeLocation;
/**
* The function's tags.
*/
Tags?: Tags;
/**
* The function's reserved concurrency.
*/
Concurrency?: Concurrency;
}
export interface GetLayerVersionByArnRequest {
/**
* The ARN of the layer version.
*/
Arn: LayerVersionArn;
}
export interface GetLayerVersionPolicyRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The version number.
*/
VersionNumber: LayerVersionNumber;
}
export interface GetLayerVersionPolicyResponse {
/**
* The policy document.
*/
Policy?: String;
/**
* A unique identifier for the current revision of the policy.
*/
RevisionId?: String;
}
export interface GetLayerVersionRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The version number.
*/
VersionNumber: LayerVersionNumber;
}
export interface GetLayerVersionResponse {
/**
* Details about the layer version.
*/
Content?: LayerVersionContentOutput;
/**
* The ARN of the layer.
*/
LayerArn?: LayerArn;
/**
* The ARN of the layer version.
*/
LayerVersionArn?: LayerVersionArn;
/**
* The description of the version.
*/
Description?: Description;
/**
* The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/
CreatedDate?: Timestamp;
/**
* The version number.
*/
Version?: LayerVersionNumber;
/**
* The layer's compatible runtimes.
*/
CompatibleRuntimes?: CompatibleRuntimes;
/**
* The layer's software license.
*/
LicenseInfo?: LicenseInfo;
}
export interface GetPolicyRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* Specify a version or alias to get the policy for that resource.
*/
Qualifier?: Qualifier;
}
export interface GetPolicyResponse {
/**
* The resource-based policy.
*/
Policy?: String;
/**
* A unique identifier for the current revision of the policy.
*/
RevisionId?: String;
}
export interface GetProvisionedConcurrencyConfigRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The version number or alias name.
*/
Qualifier: Qualifier;
}
export interface GetProvisionedConcurrencyConfigResponse {
/**
* The amount of provisioned concurrency requested.
*/
RequestedProvisionedConcurrentExecutions?: PositiveInteger;
/**
* The amount of provisioned concurrency available.
*/
AvailableProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The amount of provisioned concurrency allocated.
*/
AllocatedProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The status of the allocation process.
*/
Status?: ProvisionedConcurrencyStatusEnum;
/**
* For failed allocations, the reason that provisioned concurrency could not be allocated.
*/
StatusReason?: String;
/**
* The date and time that a user last updated the configuration, in ISO 8601 format.
*/
LastModified?: Timestamp;
}
export type Handler = string;
export type HttpStatus = number;
export type Integer = number;
export interface InvocationRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* Choose from the following options. RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data. Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code. DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.
*/
InvocationType?: InvocationType;
/**
* Set to Tail to include the execution log in the response.
*/
LogType?: LogType;
/**
* Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
*/
ClientContext?: String;
/**
* The JSON that you want to provide to your Lambda function as input.
*/
Payload?: _Blob;
/**
* Specify a version or alias to invoke a published version of the function.
*/
Qualifier?: Qualifier;
}
export interface InvocationResponse {
/**
* The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.
*/
StatusCode?: Integer;
/**
* If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
*/
FunctionError?: String;
/**
* The last 4 KB of the execution log, which is base64 encoded.
*/
LogResult?: String;
/**
* The response from the function, or an error object.
*/
Payload?: _Blob;
/**
* The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
*/
ExecutedVersion?: Version;
}
export type InvocationType = "Event"|"RequestResponse"|"DryRun"|string;
export interface InvokeAsyncRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* The JSON that you want to provide to your Lambda function as input.
*/
InvokeArgs: BlobStream;
}
export interface InvokeAsyncResponse {
/**
* The status code.
*/
Status?: HttpStatus;
}
export type KMSKeyArn = string;
export type LastUpdateStatus = "Successful"|"Failed"|"InProgress"|string;
export type LastUpdateStatusReason = string;
export type LastUpdateStatusReasonCode = "EniLimitExceeded"|"InsufficientRolePermissions"|"InvalidConfiguration"|"InternalError"|"SubnetOutOfIPAddresses"|"InvalidSubnet"|"InvalidSecurityGroup"|string;
export interface Layer {
/**
* The Amazon Resource Name (ARN) of the function layer.
*/
Arn?: LayerVersionArn;
/**
* The size of the layer archive in bytes.
*/
CodeSize?: Long;
}
export type LayerArn = string;
export type LayerList = LayerVersionArn[];
export type LayerName = string;
export type LayerPermissionAllowedAction = string;
export type LayerPermissionAllowedPrincipal = string;
export type LayerVersionArn = string;
export interface LayerVersionContentInput {
/**
* The Amazon S3 bucket of the layer archive.
*/
S3Bucket?: S3Bucket;
/**
* The Amazon S3 key of the layer archive.
*/
S3Key?: S3Key;
/**
* For versioned objects, the version of the layer archive object to use.
*/
S3ObjectVersion?: S3ObjectVersion;
/**
* The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
*/
ZipFile?: _Blob;
}
export interface LayerVersionContentOutput {
/**
* A link to the layer archive in Amazon S3 that is valid for 10 minutes.
*/
Location?: String;
/**
* The SHA-256 hash of the layer archive.
*/
CodeSha256?: String;
/**
* The size of the layer archive in bytes.
*/
CodeSize?: Long;
}
export type LayerVersionNumber = number;
export type LayerVersionsList = LayerVersionsListItem[];
export interface LayerVersionsListItem {
/**
* The ARN of the layer version.
*/
LayerVersionArn?: LayerVersionArn;
/**
* The version number.
*/
Version?: LayerVersionNumber;
/**
* The description of the version.
*/
Description?: Description;
/**
* The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.
*/
CreatedDate?: Timestamp;
/**
* The layer's compatible runtimes.
*/
CompatibleRuntimes?: CompatibleRuntimes;
/**
* The layer's open-source license.
*/
LicenseInfo?: LicenseInfo;
}
export type LayersList = LayersListItem[];
export interface LayersListItem {
/**
* The name of the layer.
*/
LayerName?: LayerName;
/**
* The Amazon Resource Name (ARN) of the function layer.
*/
LayerArn?: LayerArn;
/**
* The newest version of the layer.
*/
LatestMatchingVersion?: LayerVersionsListItem;
}
export type LayersReferenceList = Layer[];
export type LicenseInfo = string;
export interface ListAliasesRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Specify a function version to only list aliases that invoke that version.
*/
FunctionVersion?: Version;
/**
* Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/
Marker?: String;
/**
* Limit the number of aliases returned.
*/
MaxItems?: MaxListItems;
}
export interface ListAliasesResponse {
/**
* The pagination token that's included if more results are available.
*/
NextMarker?: String;
/**
* A list of aliases.
*/
Aliases?: AliasList;
}
export interface ListEventSourceMappingsRequest {
/**
* The Amazon Resource Name (ARN) of the event source. Amazon Kinesis - The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams - The ARN of the stream. Amazon Simple Queue Service - The ARN of the queue. Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.
*/
EventSourceArn?: Arn;
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
*/
FunctionName?: FunctionName;
/**
* A pagination token returned by a previous call.
*/
Marker?: String;
/**
* The maximum number of event source mappings to return.
*/
MaxItems?: MaxListItems;
}
export interface ListEventSourceMappingsResponse {
/**
* A pagination token that's returned when the response doesn't contain all event source mappings.
*/
NextMarker?: String;
/**
* A list of event source mappings.
*/
EventSourceMappings?: EventSourceMappingsList;
}
export interface ListFunctionEventInvokeConfigsRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/
Marker?: String;
/**
* The maximum number of configurations to return.
*/
MaxItems?: MaxFunctionEventInvokeConfigListItems;
}
export interface ListFunctionEventInvokeConfigsResponse {
/**
* A list of configurations.
*/
FunctionEventInvokeConfigs?: FunctionEventInvokeConfigList;
/**
* The pagination token that's included if more results are available.
*/
NextMarker?: String;
}
export interface ListFunctionsRequest {
/**
* For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-1 filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.
*/
MasterRegion?: MasterRegion;
/**
* Set to ALL to include entries for all published versions of each function.
*/
FunctionVersion?: FunctionVersion;
/**
* Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/
Marker?: String;
/**
* The maximum number of functions to return.
*/
MaxItems?: MaxListItems;
}
export interface ListFunctionsResponse {
/**
* The pagination token that's included if more results are available.
*/
NextMarker?: String;
/**
* A list of Lambda functions.
*/
Functions?: FunctionList;
}
export interface ListLayerVersionsRequest {
/**
* A runtime identifier. For example, go1.x.
*/
CompatibleRuntime?: Runtime;
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* A pagination token returned by a previous call.
*/
Marker?: String;
/**
* The maximum number of versions to return.
*/
MaxItems?: MaxLayerListItems;
}
export interface ListLayerVersionsResponse {
/**
* A pagination token returned when the response doesn't contain all versions.
*/
NextMarker?: String;
/**
* A list of versions.
*/
LayerVersions?: LayerVersionsList;
}
export interface ListLayersRequest {
/**
* A runtime identifier. For example, go1.x.
*/
CompatibleRuntime?: Runtime;
/**
* A pagination token returned by a previous call.
*/
Marker?: String;
/**
* The maximum number of layers to return.
*/
MaxItems?: MaxLayerListItems;
}
export interface ListLayersResponse {
/**
* A pagination token returned when the response doesn't contain all layers.
*/
NextMarker?: String;
/**
* A list of function layers.
*/
Layers?: LayersList;
}
export interface ListProvisionedConcurrencyConfigsRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/
Marker?: String;
/**
* Specify a number to limit the number of configurations returned.
*/
MaxItems?: MaxProvisionedConcurrencyConfigListItems;
}
export interface ListProvisionedConcurrencyConfigsResponse {
/**
* A list of provisioned concurrency configurations.
*/
ProvisionedConcurrencyConfigs?: ProvisionedConcurrencyConfigList;
/**
* The pagination token that's included if more results are available.
*/
NextMarker?: String;
}
export interface ListTagsRequest {
/**
* The function's Amazon Resource Name (ARN).
*/
Resource: FunctionArn;
}
export interface ListTagsResponse {
/**
* The function's tags.
*/
Tags?: Tags;
}
export interface ListVersionsByFunctionRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: NamespacedFunctionName;
/**
* Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/
Marker?: String;
/**
* The maximum number of versions to return.
*/
MaxItems?: MaxListItems;
}
export interface ListVersionsByFunctionResponse {
/**
* The pagination token that's included if more results are available.
*/
NextMarker?: String;
/**
* A list of Lambda function versions.
*/
Versions?: FunctionList;
}
export type LocalMountPath = string;
export type LogType = "None"|"Tail"|string;
export type Long = number;
export type MasterRegion = string;
export type MaxFunctionEventInvokeConfigListItems = number;
export type MaxLayerListItems = number;
export type MaxListItems = number;
export type MaxProvisionedConcurrencyConfigListItems = number;
export type MaximumBatchingWindowInSeconds = number;
export type MaximumEventAgeInSeconds = number;
export type MaximumRecordAgeInSeconds = number;
export type MaximumRetryAttempts = number;
export type MaximumRetryAttemptsEventSourceMapping = number;
export type MemorySize = number;
export type NameSpacedFunctionArn = string;
export type NamespacedFunctionName = string;
export type NamespacedStatementId = string;
export type NonNegativeInteger = number;
export interface OnFailure {
/**
* The Amazon Resource Name (ARN) of the destination resource.
*/
Destination?: DestinationArn;
}
export interface OnSuccess {
/**
* The Amazon Resource Name (ARN) of the destination resource.
*/
Destination?: DestinationArn;
}
export type OrganizationId = string;
export type ParallelizationFactor = number;
export type PositiveInteger = number;
export type Principal = string;
export type ProvisionedConcurrencyConfigList = ProvisionedConcurrencyConfigListItem[];
export interface ProvisionedConcurrencyConfigListItem {
/**
* The Amazon Resource Name (ARN) of the alias or version.
*/
FunctionArn?: FunctionArn;
/**
* The amount of provisioned concurrency requested.
*/
RequestedProvisionedConcurrentExecutions?: PositiveInteger;
/**
* The amount of provisioned concurrency available.
*/
AvailableProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The amount of provisioned concurrency allocated.
*/
AllocatedProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The status of the allocation process.
*/
Status?: ProvisionedConcurrencyStatusEnum;
/**
* For failed allocations, the reason that provisioned concurrency could not be allocated.
*/
StatusReason?: String;
/**
* The date and time that a user last updated the configuration, in ISO 8601 format.
*/
LastModified?: Timestamp;
}
export type ProvisionedConcurrencyStatusEnum = "IN_PROGRESS"|"READY"|"FAILED"|string;
export interface PublishLayerVersionRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The description of the version.
*/
Description?: Description;
/**
* The function layer archive.
*/
Content: LayerVersionContentInput;
/**
* A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
*/
CompatibleRuntimes?: CompatibleRuntimes;
/**
* The layer's software license. It can be any of the following: An SPDX license identifier. For example, MIT. The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT. The full text of the license.
*/
LicenseInfo?: LicenseInfo;
}
export interface PublishLayerVersionResponse {
/**
* Details about the layer version.
*/
Content?: LayerVersionContentOutput;
/**
* The ARN of the layer.
*/
LayerArn?: LayerArn;
/**
* The ARN of the layer version.
*/
LayerVersionArn?: LayerVersionArn;
/**
* The description of the version.
*/
Description?: Description;
/**
* The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/
CreatedDate?: Timestamp;
/**
* The version number.
*/
Version?: LayerVersionNumber;
/**
* The layer's compatible runtimes.
*/
CompatibleRuntimes?: CompatibleRuntimes;
/**
* The layer's software license.
*/
LicenseInfo?: LicenseInfo;
}
export interface PublishVersionRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.
*/
CodeSha256?: String;
/**
* A description for the version to override the description in the function configuration.
*/
Description?: Description;
/**
* Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
*/
RevisionId?: String;
}
export interface PutFunctionConcurrencyRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The number of simultaneous executions to reserve for the function.
*/
ReservedConcurrentExecutions: ReservedConcurrentExecutions;
}
export interface PutFunctionEventInvokeConfigRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* A version number or alias name.
*/
Qualifier?: Qualifier;
/**
* The maximum number of times to retry when the function returns an error.
*/
MaximumRetryAttempts?: MaximumRetryAttempts;
/**
* The maximum age of a request that Lambda sends to a function for processing.
*/
MaximumEventAgeInSeconds?: MaximumEventAgeInSeconds;
/**
* A destination for events after they have been sent to a function for processing. Destinations Function - The Amazon Resource Name (ARN) of a Lambda function. Queue - The ARN of an SQS queue. Topic - The ARN of an SNS topic. Event Bus - The ARN of an Amazon EventBridge event bus.
*/
DestinationConfig?: DestinationConfig;
}
export interface PutProvisionedConcurrencyConfigRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The version number or alias name.
*/
Qualifier: Qualifier;
/**
* The amount of provisioned concurrency to allocate for the version or alias.
*/
ProvisionedConcurrentExecutions: PositiveInteger;
}
export interface PutProvisionedConcurrencyConfigResponse {
/**
* The amount of provisioned concurrency requested.
*/
RequestedProvisionedConcurrentExecutions?: PositiveInteger;
/**
* The amount of provisioned concurrency available.
*/
AvailableProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The amount of provisioned concurrency allocated.
*/
AllocatedProvisionedConcurrentExecutions?: NonNegativeInteger;
/**
* The status of the allocation process.
*/
Status?: ProvisionedConcurrencyStatusEnum;
/**
* For failed allocations, the reason that provisioned concurrency could not be allocated.
*/
StatusReason?: String;
/**
* The date and time that a user last updated the configuration, in ISO 8601 format.
*/
LastModified?: Timestamp;
}
export type Qualifier = string;
export interface RemoveLayerVersionPermissionRequest {
/**
* The name or Amazon Resource Name (ARN) of the layer.
*/
LayerName: LayerName;
/**
* The version number.
*/
VersionNumber: LayerVersionNumber;
/**
* The identifier that was specified when the statement was added.
*/
StatementId: StatementId;
/**
* Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
*/
RevisionId?: String;
}
export interface RemovePermissionRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* Statement ID of the permission to remove.
*/
StatementId: NamespacedStatementId;
/**
* Specify a version or alias to remove permissions from a published version of the function.
*/
Qualifier?: Qualifier;
/**
* Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
*/
RevisionId?: String;
}
export type ReservedConcurrentExecutions = number;
export type ResourceArn = string;
export type RoleArn = string;
export type Runtime = "nodejs"|"nodejs4.3"|"nodejs6.10"|"nodejs8.10"|"nodejs10.x"|"nodejs12.x"|"java8"|"java8.al2"|"java11"|"python2.7"|"python3.6"|"python3.7"|"python3.8"|"dotnetcore1.0"|"dotnetcore2.0"|"dotnetcore2.1"|"dotnetcore3.1"|"nodejs4.3-edge"|"go1.x"|"ruby2.5"|"ruby2.7"|"provided"|"provided.al2"|string;
export type S3Bucket = string;
export type S3Key = string;
export type S3ObjectVersion = string;
export type SecurityGroupId = string;
export type SecurityGroupIds = SecurityGroupId[];
export type SensitiveString = string;
export type SourceOwner = string;
export type State = "Pending"|"Active"|"Inactive"|"Failed"|string;
export type StateReason = string;
export type StateReasonCode = "Idle"|"Creating"|"Restoring"|"EniLimitExceeded"|"InsufficientRolePermissions"|"InvalidConfiguration"|"InternalError"|"SubnetOutOfIPAddresses"|"InvalidSubnet"|"InvalidSecurityGroup"|string;
export type StatementId = string;
export type String = string;
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export interface TagResourceRequest {
/**
* The function's Amazon Resource Name (ARN).
*/
Resource: FunctionArn;
/**
* A list of tags to apply to the function.
*/
Tags: Tags;
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export type Timeout = number;
export type Timestamp = string;
export type Topic = string;
export type Topics = Topic[];
export interface TracingConfig {
/**
* The tracing mode.
*/
Mode?: TracingMode;
}
export interface TracingConfigResponse {
/**
* The tracing mode.
*/
Mode?: TracingMode;
}
export type TracingMode = "Active"|"PassThrough"|string;
export type UnreservedConcurrentExecutions = number;
export interface UntagResourceRequest {
/**
* The function's Amazon Resource Name (ARN).
*/
Resource: FunctionArn;
/**
* A list of tag keys to remove from the function.
*/
TagKeys: TagKeyList;
}
export interface UpdateAliasRequest {
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The name of the alias.
*/
Name: Alias;
/**
* The function version that the alias invokes.
*/
FunctionVersion?: Version;
/**
* A description of the alias.
*/
Description?: Description;
/**
* The routing configuration of the alias.
*/
RoutingConfig?: AliasRoutingConfiguration;
/**
* Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.
*/
RevisionId?: String;
}
export interface UpdateEventSourceMappingRequest {
/**
* The identifier of the event source mapping.
*/
UUID: String;
/**
* The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
*/
FunctionName?: FunctionName;
/**
* If true, the event source mapping is active. Set to false to pause polling and invocation.
*/
Enabled?: Enabled;
/**
* The maximum number of items to retrieve in a single batch. Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 1,000. Amazon Simple Queue Service - Default 10. Max 10. Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
*/
BatchSize?: BatchSize;
/**
* (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
*/
MaximumBatchingWindowInSeconds?: MaximumBatchingWindowInSeconds;
/**
* (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
*/
DestinationConfig?: DestinationConfig;
/**
* (Streams) Discard records older than the specified age. The default value is infinite (-1).
*/
MaximumRecordAgeInSeconds?: MaximumRecordAgeInSeconds;
/**
* (Streams) If the function returns an error, split the batch in two and retry.
*/
BisectBatchOnFunctionError?: BisectBatchOnFunctionError;
/**
* (Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
*/
MaximumRetryAttempts?: MaximumRetryAttemptsEventSourceMapping;
/**
* (Streams) The number of batches to process from each shard concurrently.
*/
ParallelizationFactor?: ParallelizationFactor;
}
export interface UpdateFunctionCodeRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
*/
ZipFile?: _Blob;
/**
* An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
*/
S3Bucket?: S3Bucket;
/**
* The Amazon S3 key of the deployment package.
*/
S3Key?: S3Key;
/**
* For versioned objects, the version of the deployment package object to use.
*/
S3ObjectVersion?: S3ObjectVersion;
/**
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
*/
Publish?: Boolean;
/**
* Set to true to validate the request parameters and access permissions without modifying the function code.
*/
DryRun?: Boolean;
/**
* Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
*/
RevisionId?: String;
}
export interface UpdateFunctionConfigurationRequest {
/**
* The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* The Amazon Resource Name (ARN) of the function's execution role.
*/
Role?: RoleArn;
/**
* The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
*/
Handler?: Handler;
/**
* A description of the function.
*/
Description?: Description;
/**
* The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
*/
Timeout?: Timeout;
/**
* The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
*/
MemorySize?: MemorySize;
/**
* For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
*/
VpcConfig?: VpcConfig;
/**
* Environment variables that are accessible from function code during execution.
*/
Environment?: Environment;
/**
* The identifier of the function's runtime.
*/
Runtime?: Runtime;
/**
* A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
*/
DeadLetterConfig?: DeadLetterConfig;
/**
* The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
*/
KMSKeyArn?: KMSKeyArn;
/**
* Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
*/
TracingConfig?: TracingConfig;
/**
* Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
*/
RevisionId?: String;
/**
* A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
*/
Layers?: LayerList;
/**
* Connection settings for an Amazon EFS file system.
*/
FileSystemConfigs?: FileSystemConfigList;
}
export interface UpdateFunctionEventInvokeConfigRequest {
/**
* The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
*/
FunctionName: FunctionName;
/**
* A version number or alias name.
*/
Qualifier?: Qualifier;
/**
* The maximum number of times to retry when the function returns an error.
*/
MaximumRetryAttempts?: MaximumRetryAttempts;
/**
* The maximum age of a request that Lambda sends to a function for processing.
*/
MaximumEventAgeInSeconds?: MaximumEventAgeInSeconds;
/**
* A destination for events after they have been sent to a function for processing. Destinations Function - The Amazon Resource Name (ARN) of a Lambda function. Queue - The ARN of an SQS queue. Topic - The ARN of an SNS topic. Event Bus - The ARN of an Amazon EventBridge event bus.
*/
DestinationConfig?: DestinationConfig;
}
export type Version = string;
export interface VpcConfig {
/**
* A list of VPC subnet IDs.
*/
SubnetIds?: SubnetIds;
/**
* A list of VPC security groups IDs.
*/
SecurityGroupIds?: SecurityGroupIds;
}
export interface VpcConfigResponse {
/**
* A list of VPC subnet IDs.
*/
SubnetIds?: SubnetIds;
/**
* A list of VPC security groups IDs.
*/
SecurityGroupIds?: SecurityGroupIds;
/**
* The ID of the VPC.
*/
VpcId?: VpcId;
}
export type VpcId = string;
export type Weight = number;
/**
* 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 = "2014-11-11"|"2015-03-31"|"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 Lambda client.
*/
export import Types = Lambda;
}
export = Lambda;