lexmodelbuildingservice.d.ts
124 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class LexModelBuildingService extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: LexModelBuildingService.Types.ClientConfiguration)
config: Config & LexModelBuildingService.Types.ClientConfiguration;
/**
* Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the lex:CreateBotVersion action.
*/
createBotVersion(params: LexModelBuildingService.Types.CreateBotVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request<LexModelBuildingService.Types.CreateBotVersionResponse, AWSError>;
/**
* Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the lex:CreateBotVersion action.
*/
createBotVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request<LexModelBuildingService.Types.CreateBotVersionResponse, AWSError>;
/**
* Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action.
*/
createIntentVersion(params: LexModelBuildingService.Types.CreateIntentVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request<LexModelBuildingService.Types.CreateIntentVersionResponse, AWSError>;
/**
* Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action.
*/
createIntentVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request<LexModelBuildingService.Types.CreateIntentVersionResponse, AWSError>;
/**
* Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action.
*/
createSlotTypeVersion(params: LexModelBuildingService.Types.CreateSlotTypeVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request<LexModelBuildingService.Types.CreateSlotTypeVersionResponse, AWSError>;
/**
* Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action.
*/
createSlotTypeVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request<LexModelBuildingService.Types.CreateSlotTypeVersionResponse, AWSError>;
/**
* Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action.
*/
deleteBot(params: LexModelBuildingService.Types.DeleteBotRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action.
*/
deleteBot(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.
*/
deleteBotAlias(params: LexModelBuildingService.Types.DeleteBotAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.
*/
deleteBotAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.
*/
deleteBotChannelAssociation(params: LexModelBuildingService.Types.DeleteBotChannelAssociationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.
*/
deleteBotChannelAssociation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action.
*/
deleteBotVersion(params: LexModelBuildingService.Types.DeleteBotVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action.
*/
deleteBotVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action.
*/
deleteIntent(params: LexModelBuildingService.Types.DeleteIntentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action.
*/
deleteIntent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action.
*/
deleteIntentVersion(params: LexModelBuildingService.Types.DeleteIntentVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action.
*/
deleteIntentVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action.
*/
deleteSlotType(params: LexModelBuildingService.Types.DeleteSlotTypeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action.
*/
deleteSlotType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action.
*/
deleteSlotTypeVersion(params: LexModelBuildingService.Types.DeleteSlotTypeVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action.
*/
deleteSlotTypeVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action.
*/
deleteUtterances(params: LexModelBuildingService.Types.DeleteUtterancesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action.
*/
deleteUtterances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action.
*/
getBot(params: LexModelBuildingService.Types.GetBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request<LexModelBuildingService.Types.GetBotResponse, AWSError>;
/**
* Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action.
*/
getBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request<LexModelBuildingService.Types.GetBotResponse, AWSError>;
/**
* Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.
*/
getBotAlias(params: LexModelBuildingService.Types.GetBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasResponse, AWSError>;
/**
* Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.
*/
getBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasResponse, AWSError>;
/**
* Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
*/
getBotAliases(params: LexModelBuildingService.Types.GetBotAliasesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasesResponse, AWSError>;
/**
* Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
*/
getBotAliases(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasesResponse, AWSError>;
/**
* Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
*/
getBotChannelAssociation(params: LexModelBuildingService.Types.GetBotChannelAssociationRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationResponse, AWSError>;
/**
* Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
*/
getBotChannelAssociation(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationResponse, AWSError>;
/**
* Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
*/
getBotChannelAssociations(params: LexModelBuildingService.Types.GetBotChannelAssociationsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationsResponse, AWSError>;
/**
* Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
*/
getBotChannelAssociations(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationsResponse, AWSError>;
/**
* Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action.
*/
getBotVersions(params: LexModelBuildingService.Types.GetBotVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request<LexModelBuildingService.Types.GetBotVersionsResponse, AWSError>;
/**
* Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action.
*/
getBotVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request<LexModelBuildingService.Types.GetBotVersionsResponse, AWSError>;
/**
* Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action.
*/
getBots(params: LexModelBuildingService.Types.GetBotsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request<LexModelBuildingService.Types.GetBotsResponse, AWSError>;
/**
* Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action.
*/
getBots(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request<LexModelBuildingService.Types.GetBotsResponse, AWSError>;
/**
* Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
*/
getBuiltinIntent(params: LexModelBuildingService.Types.GetBuiltinIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentResponse, AWSError>;
/**
* Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
*/
getBuiltinIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentResponse, AWSError>;
/**
* Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
*/
getBuiltinIntents(params: LexModelBuildingService.Types.GetBuiltinIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentsResponse, AWSError>;
/**
* Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
*/
getBuiltinIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentsResponse, AWSError>;
/**
* Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action.
*/
getBuiltinSlotTypes(params: LexModelBuildingService.Types.GetBuiltinSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinSlotTypesResponse, AWSError>;
/**
* Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action.
*/
getBuiltinSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinSlotTypesResponse, AWSError>;
/**
* Exports the contents of a Amazon Lex resource in a specified format.
*/
getExport(params: LexModelBuildingService.Types.GetExportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request<LexModelBuildingService.Types.GetExportResponse, AWSError>;
/**
* Exports the contents of a Amazon Lex resource in a specified format.
*/
getExport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request<LexModelBuildingService.Types.GetExportResponse, AWSError>;
/**
* Gets information about an import job started with the StartImport operation.
*/
getImport(params: LexModelBuildingService.Types.GetImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request<LexModelBuildingService.Types.GetImportResponse, AWSError>;
/**
* Gets information about an import job started with the StartImport operation.
*/
getImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request<LexModelBuildingService.Types.GetImportResponse, AWSError>;
/**
* Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action.
*/
getIntent(params: LexModelBuildingService.Types.GetIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request<LexModelBuildingService.Types.GetIntentResponse, AWSError>;
/**
* Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action.
*/
getIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request<LexModelBuildingService.Types.GetIntentResponse, AWSError>;
/**
* Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action.
*/
getIntentVersions(params: LexModelBuildingService.Types.GetIntentVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request<LexModelBuildingService.Types.GetIntentVersionsResponse, AWSError>;
/**
* Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action.
*/
getIntentVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request<LexModelBuildingService.Types.GetIntentVersionsResponse, AWSError>;
/**
* Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action.
*/
getIntents(params: LexModelBuildingService.Types.GetIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request<LexModelBuildingService.Types.GetIntentsResponse, AWSError>;
/**
* Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action.
*/
getIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request<LexModelBuildingService.Types.GetIntentsResponse, AWSError>;
/**
* Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the lex:GetSlotType action.
*/
getSlotType(params: LexModelBuildingService.Types.GetSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeResponse, AWSError>;
/**
* Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the lex:GetSlotType action.
*/
getSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeResponse, AWSError>;
/**
* Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action.
*/
getSlotTypeVersions(params: LexModelBuildingService.Types.GetSlotTypeVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeVersionsResponse, AWSError>;
/**
* Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action.
*/
getSlotTypeVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeVersionsResponse, AWSError>;
/**
* Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action.
*/
getSlotTypes(params: LexModelBuildingService.Types.GetSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypesResponse, AWSError>;
/**
* Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action.
*/
getSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypesResponse, AWSError>;
/**
* Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
*/
getUtterancesView(params: LexModelBuildingService.Types.GetUtterancesViewRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request<LexModelBuildingService.Types.GetUtterancesViewResponse, AWSError>;
/**
* Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
*/
getUtterancesView(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request<LexModelBuildingService.Types.GetUtterancesViewResponse, AWSError>;
/**
* Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
*/
putBot(params: LexModelBuildingService.Types.PutBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
/**
* Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
*/
putBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
/**
* Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:PutBotAlias action.
*/
putBotAlias(params: LexModelBuildingService.Types.PutBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
/**
* Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:PutBotAlias action.
*/
putBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
/**
* Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza. How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action.
*/
putIntent(params: LexModelBuildingService.Types.PutIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
/**
* Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza. How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action.
*/
putIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
/**
* Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action.
*/
putSlotType(params: LexModelBuildingService.Types.PutSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
/**
* Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action.
*/
putSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
/**
* Starts a job to import a resource to Amazon Lex.
*/
startImport(params: LexModelBuildingService.Types.StartImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
/**
* Starts a job to import a resource to Amazon Lex.
*/
startImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
}
declare namespace LexModelBuildingService {
export type AliasName = string;
export type AliasNameOrListAll = string;
export type _Blob = Buffer|Uint8Array|Blob|string;
export type Boolean = boolean;
export interface BotAliasMetadata {
/**
* The name of the bot alias.
*/
name?: AliasName;
/**
* A description of the bot alias.
*/
description?: Description;
/**
* The version of the Amazon Lex bot to which the alias points.
*/
botVersion?: Version;
/**
* The name of the bot to which the alias points.
*/
botName?: BotName;
/**
* The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot alias was created.
*/
createdDate?: Timestamp;
/**
* Checksum of the bot alias.
*/
checksum?: String;
}
export type BotAliasMetadataList = BotAliasMetadata[];
export interface BotChannelAssociation {
/**
* The name of the association between the bot and the channel.
*/
name?: BotChannelName;
/**
* A text description of the association you are creating.
*/
description?: Description;
/**
* An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
*/
botAlias?: AliasName;
/**
* The name of the Amazon Lex bot to which this association is being made. Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
*/
botName?: BotName;
/**
* The date that the association between the Amazon Lex bot and the channel was created.
*/
createdDate?: Timestamp;
/**
* Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
*/
type?: ChannelType;
/**
* Provides information necessary to communicate with the messaging platform.
*/
botConfiguration?: ChannelConfigurationMap;
/**
* The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
*/
status?: ChannelStatus;
/**
* If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
*/
failureReason?: String;
}
export type BotChannelAssociationList = BotChannelAssociation[];
export type BotChannelName = string;
export interface BotMetadata {
/**
* The name of the bot.
*/
name?: BotName;
/**
* A description of the bot.
*/
description?: Description;
/**
* The status of the bot.
*/
status?: Status;
/**
* The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot was created.
*/
createdDate?: Timestamp;
/**
* The version of the bot. For a new bot, the version is always $LATEST.
*/
version?: Version;
}
export type BotMetadataList = BotMetadata[];
export type BotName = string;
export type BotVersions = Version[];
export interface BuiltinIntentMetadata {
/**
* A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
*/
signature?: BuiltinIntentSignature;
/**
* A list of identifiers for the locales that the intent supports.
*/
supportedLocales?: LocaleList;
}
export type BuiltinIntentMetadataList = BuiltinIntentMetadata[];
export type BuiltinIntentSignature = string;
export interface BuiltinIntentSlot {
/**
* A list of the slots defined for the intent.
*/
name?: String;
}
export type BuiltinIntentSlotList = BuiltinIntentSlot[];
export interface BuiltinSlotTypeMetadata {
/**
* A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.
*/
signature?: BuiltinSlotTypeSignature;
/**
* A list of target locales for the slot.
*/
supportedLocales?: LocaleList;
}
export type BuiltinSlotTypeMetadataList = BuiltinSlotTypeMetadata[];
export type BuiltinSlotTypeSignature = string;
export type ChannelConfigurationMap = {[key: string]: String};
export type ChannelStatus = "IN_PROGRESS"|"CREATED"|"FAILED"|string;
export type ChannelType = "Facebook"|"Slack"|"Twilio-Sms"|"Kik"|string;
export interface CodeHook {
/**
* The Amazon Resource Name (ARN) of the Lambda function.
*/
uri: LambdaARN;
/**
* The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.
*/
messageVersion: MessageVersion;
}
export type ContentString = string;
export type ContentType = "PlainText"|"SSML"|"CustomPayload"|string;
export type Count = number;
export interface CreateBotVersionRequest {
/**
* The name of the bot that you want to create a new version of. The name is case sensitive.
*/
name: BotName;
/**
* Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
*/
checksum?: String;
}
export interface CreateBotVersionResponse {
/**
* The name of the bot.
*/
name?: BotName;
/**
* A description of the bot.
*/
description?: Description;
/**
* An array of Intent objects. For more information, see PutBot.
*/
intents?: IntentList;
/**
* The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
*/
clarificationPrompt?: Prompt;
/**
* The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
*/
abortStatement?: Statement;
/**
* When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.
*/
status?: Status;
/**
* If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
*/
failureReason?: String;
/**
* The date when the $LATEST version of this bot was updated.
*/
lastUpdatedDate?: Timestamp;
/**
* The date when the bot version was created.
*/
createdDate?: Timestamp;
/**
* The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
*/
idleSessionTTLInSeconds?: SessionTTL;
/**
* The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
*/
voiceId?: String;
/**
* Checksum identifying the version of the bot that was created.
*/
checksum?: String;
/**
* The version of the bot.
*/
version?: Version;
/**
* Specifies the target locale for the bot.
*/
locale?: Locale;
/**
* For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
*/
childDirected?: Boolean;
/**
* Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
*/
detectSentiment?: Boolean;
}
export interface CreateIntentVersionRequest {
/**
* The name of the intent that you want to create a new version of. The name is case sensitive.
*/
name: IntentName;
/**
* Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
*/
checksum?: String;
}
export interface CreateIntentVersionResponse {
/**
* The name of the intent.
*/
name?: IntentName;
/**
* A description of the intent.
*/
description?: Description;
/**
* An array of slot types that defines the information required to fulfill the intent.
*/
slots?: SlotList;
/**
* An array of sample utterances configured for the intent.
*/
sampleUtterances?: IntentUtteranceList;
/**
* If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
*/
confirmationPrompt?: Prompt;
/**
* If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
*/
rejectionStatement?: Statement;
/**
* If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
*/
followUpPrompt?: FollowUpPrompt;
/**
* After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.
*/
conclusionStatement?: Statement;
/**
* If defined, Amazon Lex invokes this Lambda function for each user input.
*/
dialogCodeHook?: CodeHook;
/**
* Describes how the intent is fulfilled.
*/
fulfillmentActivity?: FulfillmentActivity;
/**
* A unique identifier for a built-in intent.
*/
parentIntentSignature?: BuiltinIntentSignature;
/**
* The date that the intent was updated.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the intent was created.
*/
createdDate?: Timestamp;
/**
* The version number assigned to the new version of the intent.
*/
version?: Version;
/**
* Checksum of the intent version created.
*/
checksum?: String;
}
export interface CreateSlotTypeVersionRequest {
/**
* The name of the slot type that you want to create a new version for. The name is case sensitive.
*/
name: SlotTypeName;
/**
* Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
*/
checksum?: String;
}
export interface CreateSlotTypeVersionResponse {
/**
* The name of the slot type.
*/
name?: SlotTypeName;
/**
* A description of the slot type.
*/
description?: Description;
/**
* A list of EnumerationValue objects that defines the values that the slot type can take.
*/
enumerationValues?: EnumerationValues;
/**
* The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the slot type was created.
*/
createdDate?: Timestamp;
/**
* The version assigned to the new slot type version.
*/
version?: Version;
/**
* Checksum of the $LATEST version of the slot type.
*/
checksum?: String;
/**
* The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
*/
valueSelectionStrategy?: SlotValueSelectionStrategy;
}
export type CustomOrBuiltinSlotTypeName = string;
export interface DeleteBotAliasRequest {
/**
* The name of the alias to delete. The name is case sensitive.
*/
name: AliasName;
/**
* The name of the bot that the alias points to.
*/
botName: BotName;
}
export interface DeleteBotChannelAssociationRequest {
/**
* The name of the association. The name is case sensitive.
*/
name: BotChannelName;
/**
* The name of the Amazon Lex bot.
*/
botName: BotName;
/**
* An alias that points to the specific version of the Amazon Lex bot to which this association is being made.
*/
botAlias: AliasName;
}
export interface DeleteBotRequest {
/**
* The name of the bot. The name is case sensitive.
*/
name: BotName;
}
export interface DeleteBotVersionRequest {
/**
* The name of the bot.
*/
name: BotName;
/**
* The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation.
*/
version: NumericalVersion;
}
export interface DeleteIntentRequest {
/**
* The name of the intent. The name is case sensitive.
*/
name: IntentName;
}
export interface DeleteIntentVersionRequest {
/**
* The name of the intent.
*/
name: IntentName;
/**
* The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation.
*/
version: NumericalVersion;
}
export interface DeleteSlotTypeRequest {
/**
* The name of the slot type. The name is case sensitive.
*/
name: SlotTypeName;
}
export interface DeleteSlotTypeVersionRequest {
/**
* The name of the slot type.
*/
name: SlotTypeName;
/**
* The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation.
*/
version: NumericalVersion;
}
export interface DeleteUtterancesRequest {
/**
* The name of the bot that stored the utterances.
*/
botName: BotName;
/**
* The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.
*/
userId: UserId;
}
export type Description = string;
export interface EnumerationValue {
/**
* The value of the slot type.
*/
value: Value;
/**
* Additional values related to the slot type value.
*/
synonyms?: SynonymList;
}
export type EnumerationValues = EnumerationValue[];
export type ExportStatus = "IN_PROGRESS"|"READY"|"FAILED"|string;
export type ExportType = "ALEXA_SKILLS_KIT"|"LEX"|string;
export interface FollowUpPrompt {
/**
* Prompts for information from the user.
*/
prompt: Prompt;
/**
* If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
*/
rejectionStatement: Statement;
}
export interface FulfillmentActivity {
/**
* How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
*/
type: FulfillmentActivityType;
/**
* A description of the Lambda function that is run to fulfill the intent.
*/
codeHook?: CodeHook;
}
export type FulfillmentActivityType = "ReturnIntent"|"CodeHook"|string;
export interface GetBotAliasRequest {
/**
* The name of the bot alias. The name is case sensitive.
*/
name: AliasName;
/**
* The name of the bot.
*/
botName: BotName;
}
export interface GetBotAliasResponse {
/**
* The name of the bot alias.
*/
name?: AliasName;
/**
* A description of the bot alias.
*/
description?: Description;
/**
* The version of the bot that the alias points to.
*/
botVersion?: Version;
/**
* The name of the bot that the alias points to.
*/
botName?: BotName;
/**
* The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot alias was created.
*/
createdDate?: Timestamp;
/**
* Checksum of the bot alias.
*/
checksum?: String;
}
export interface GetBotAliasesRequest {
/**
* The name of the bot.
*/
botName: BotName;
/**
* A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of aliases to return in the response. The default is 50. .
*/
maxResults?: MaxResults;
/**
* Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
*/
nameContains?: AliasName;
}
export interface GetBotAliasesResponse {
/**
* An array of BotAliasMetadata objects, each describing a bot alias.
*/
BotAliases?: BotAliasMetadataList;
/**
* A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetBotChannelAssociationRequest {
/**
* The name of the association between the bot and the channel. The name is case sensitive.
*/
name: BotChannelName;
/**
* The name of the Amazon Lex bot.
*/
botName: BotName;
/**
* An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
*/
botAlias: AliasName;
}
export interface GetBotChannelAssociationResponse {
/**
* The name of the association between the bot and the channel.
*/
name?: BotChannelName;
/**
* A description of the association between the bot and the channel.
*/
description?: Description;
/**
* An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
*/
botAlias?: AliasName;
/**
* The name of the Amazon Lex bot.
*/
botName?: BotName;
/**
* The date that the association between the bot and the channel was created.
*/
createdDate?: Timestamp;
/**
* The type of the messaging platform.
*/
type?: ChannelType;
/**
* Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
*/
botConfiguration?: ChannelConfigurationMap;
/**
* The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
*/
status?: ChannelStatus;
/**
* If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
*/
failureReason?: String;
}
export interface GetBotChannelAssociationsRequest {
/**
* The name of the Amazon Lex bot in the association.
*/
botName: BotName;
/**
* An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
*/
botAlias: AliasNameOrListAll;
/**
* A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of associations to return in the response. The default is 50.
*/
maxResults?: MaxResults;
/**
* Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.
*/
nameContains?: BotChannelName;
}
export interface GetBotChannelAssociationsResponse {
/**
* An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
*/
botChannelAssociations?: BotChannelAssociationList;
/**
* A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetBotRequest {
/**
* The name of the bot. The name is case sensitive.
*/
name: BotName;
/**
* The version or alias of the bot.
*/
versionOrAlias: String;
}
export interface GetBotResponse {
/**
* The name of the bot.
*/
name?: BotName;
/**
* A description of the bot.
*/
description?: Description;
/**
* An array of intent objects. For more information, see PutBot.
*/
intents?: IntentList;
/**
* The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
*/
clarificationPrompt?: Prompt;
/**
* The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
*/
abortStatement?: Statement;
/**
* The status of the bot. When the status is BUILDING Amazon Lex is building the bot for testing and use. If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build. If the bot was saved but not built, the status is NOT_BUILT.
*/
status?: Status;
/**
* If status is FAILED, Amazon Lex explains why it failed to build the bot.
*/
failureReason?: String;
/**
* The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot was created.
*/
createdDate?: Timestamp;
/**
* The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
*/
idleSessionTTLInSeconds?: SessionTTL;
/**
* The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
*/
voiceId?: String;
/**
* Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
*/
checksum?: String;
/**
* The version of the bot. For a new bot, the version is always $LATEST.
*/
version?: Version;
/**
* The target locale for the bot.
*/
locale?: Locale;
/**
* For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
*/
childDirected?: Boolean;
/**
* Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
*/
detectSentiment?: Boolean;
}
export interface GetBotVersionsRequest {
/**
* The name of the bot for which versions should be returned.
*/
name: BotName;
/**
* A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of bot versions to return in the response. The default is 10.
*/
maxResults?: MaxResults;
}
export interface GetBotVersionsResponse {
/**
* An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.
*/
bots?: BotMetadataList;
/**
* A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetBotsRequest {
/**
* A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of bots to return in the response that the request will return. The default is 10.
*/
maxResults?: MaxResults;
/**
* Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
*/
nameContains?: BotName;
}
export interface GetBotsResponse {
/**
* An array of botMetadata objects, with one entry for each bot.
*/
bots?: BotMetadataList;
/**
* If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.
*/
nextToken?: NextToken;
}
export interface GetBuiltinIntentRequest {
/**
* The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
*/
signature: BuiltinIntentSignature;
}
export interface GetBuiltinIntentResponse {
/**
* The unique identifier for a built-in intent.
*/
signature?: BuiltinIntentSignature;
/**
* A list of locales that the intent supports.
*/
supportedLocales?: LocaleList;
/**
* An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
*/
slots?: BuiltinIntentSlotList;
}
export interface GetBuiltinIntentsRequest {
/**
* A list of locales that the intent supports.
*/
locale?: Locale;
/**
* Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
*/
signatureContains?: String;
/**
* A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of intents to return in the response. The default is 10.
*/
maxResults?: MaxResults;
}
export interface GetBuiltinIntentsResponse {
/**
* An array of builtinIntentMetadata objects, one for each intent in the response.
*/
intents?: BuiltinIntentMetadataList;
/**
* A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetBuiltinSlotTypesRequest {
/**
* A list of locales that the slot type supports.
*/
locale?: Locale;
/**
* Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
*/
signatureContains?: String;
/**
* A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of slot types to return in the response. The default is 10.
*/
maxResults?: MaxResults;
}
export interface GetBuiltinSlotTypesResponse {
/**
* An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
*/
slotTypes?: BuiltinSlotTypeMetadataList;
/**
* If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.
*/
nextToken?: NextToken;
}
export interface GetExportRequest {
/**
* The name of the bot to export.
*/
name: Name;
/**
* The version of the bot to export.
*/
version: NumericalVersion;
/**
* The type of resource to export.
*/
resourceType: ResourceType;
/**
* The format of the exported data.
*/
exportType: ExportType;
}
export interface GetExportResponse {
/**
* The name of the bot being exported.
*/
name?: Name;
/**
* The version of the bot being exported.
*/
version?: NumericalVersion;
/**
* The type of the exported resource.
*/
resourceType?: ResourceType;
/**
* The format of the exported data.
*/
exportType?: ExportType;
/**
* The status of the export. IN_PROGRESS - The export is in progress. READY - The export is complete. FAILED - The export could not be completed.
*/
exportStatus?: ExportStatus;
/**
* If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.
*/
failureReason?: String;
/**
* An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.
*/
url?: String;
}
export interface GetImportRequest {
/**
* The identifier of the import job information to return.
*/
importId: String;
}
export interface GetImportResponse {
/**
* The name given to the import job.
*/
name?: Name;
/**
* The type of resource imported.
*/
resourceType?: ResourceType;
/**
* The action taken when there was a conflict between an existing resource and a resource in the import file.
*/
mergeStrategy?: MergeStrategy;
/**
* The identifier for the specific import job.
*/
importId?: String;
/**
* The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field.
*/
importStatus?: ImportStatus;
/**
* A string that describes why an import job failed to complete.
*/
failureReason?: StringList;
/**
* A timestamp for the date and time that the import job was created.
*/
createdDate?: Timestamp;
}
export interface GetIntentRequest {
/**
* The name of the intent. The name is case sensitive.
*/
name: IntentName;
/**
* The version of the intent.
*/
version: Version;
}
export interface GetIntentResponse {
/**
* The name of the intent.
*/
name?: IntentName;
/**
* A description of the intent.
*/
description?: Description;
/**
* An array of intent slots configured for the intent.
*/
slots?: SlotList;
/**
* An array of sample utterances configured for the intent.
*/
sampleUtterances?: IntentUtteranceList;
/**
* If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
*/
confirmationPrompt?: Prompt;
/**
* If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
*/
rejectionStatement?: Statement;
/**
* If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
*/
followUpPrompt?: FollowUpPrompt;
/**
* After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.
*/
conclusionStatement?: Statement;
/**
* If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
*/
dialogCodeHook?: CodeHook;
/**
* Describes how the intent is fulfilled. For more information, see PutIntent.
*/
fulfillmentActivity?: FulfillmentActivity;
/**
* A unique identifier for a built-in intent.
*/
parentIntentSignature?: BuiltinIntentSignature;
/**
* The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the intent was created.
*/
createdDate?: Timestamp;
/**
* The version of the intent.
*/
version?: Version;
/**
* Checksum of the intent.
*/
checksum?: String;
}
export interface GetIntentVersionsRequest {
/**
* The name of the intent for which versions should be returned.
*/
name: IntentName;
/**
* A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of intent versions to return in the response. The default is 10.
*/
maxResults?: MaxResults;
}
export interface GetIntentVersionsResponse {
/**
* An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.
*/
intents?: IntentMetadataList;
/**
* A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetIntentsRequest {
/**
* A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of intents to return in the response. The default is 10.
*/
maxResults?: MaxResults;
/**
* Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
*/
nameContains?: IntentName;
}
export interface GetIntentsResponse {
/**
* An array of Intent objects. For more information, see PutBot.
*/
intents?: IntentMetadataList;
/**
* If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.
*/
nextToken?: NextToken;
}
export interface GetSlotTypeRequest {
/**
* The name of the slot type. The name is case sensitive.
*/
name: SlotTypeName;
/**
* The version of the slot type.
*/
version: Version;
}
export interface GetSlotTypeResponse {
/**
* The name of the slot type.
*/
name?: SlotTypeName;
/**
* A description of the slot type.
*/
description?: Description;
/**
* A list of EnumerationValue objects that defines the values that the slot type can take.
*/
enumerationValues?: EnumerationValues;
/**
* The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the slot type was created.
*/
createdDate?: Timestamp;
/**
* The version of the slot type.
*/
version?: Version;
/**
* Checksum of the $LATEST version of the slot type.
*/
checksum?: String;
/**
* The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
*/
valueSelectionStrategy?: SlotValueSelectionStrategy;
}
export interface GetSlotTypeVersionsRequest {
/**
* The name of the slot type for which versions should be returned.
*/
name: SlotTypeName;
/**
* A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of slot type versions to return in the response. The default is 10.
*/
maxResults?: MaxResults;
}
export interface GetSlotTypeVersionsResponse {
/**
* An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.
*/
slotTypes?: SlotTypeMetadataList;
/**
* A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
*/
nextToken?: NextToken;
}
export interface GetSlotTypesRequest {
/**
* A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.
*/
nextToken?: NextToken;
/**
* The maximum number of slot types to return in the response. The default is 10.
*/
maxResults?: MaxResults;
/**
* Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
*/
nameContains?: SlotTypeName;
}
export interface GetSlotTypesResponse {
/**
* An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.
*/
slotTypes?: SlotTypeMetadataList;
/**
* If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.
*/
nextToken?: NextToken;
}
export interface GetUtterancesViewRequest {
/**
* The name of the bot for which utterance information should be returned.
*/
botName: BotName;
/**
* An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
*/
botVersions: BotVersions;
/**
* To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.
*/
statusType: StatusType;
}
export interface GetUtterancesViewResponse {
/**
* The name of the bot for which utterance information was returned.
*/
botName?: BotName;
/**
* An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days.
*/
utterances?: ListsOfUtterances;
}
export type GroupNumber = number;
export type ImportStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
export interface Intent {
/**
* The name of the intent.
*/
intentName: IntentName;
/**
* The version of the intent.
*/
intentVersion: Version;
}
export type IntentList = Intent[];
export interface IntentMetadata {
/**
* The name of the intent.
*/
name?: IntentName;
/**
* A description of the intent.
*/
description?: Description;
/**
* The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the intent was created.
*/
createdDate?: Timestamp;
/**
* The version of the intent.
*/
version?: Version;
}
export type IntentMetadataList = IntentMetadata[];
export type IntentName = string;
export type IntentUtteranceList = Utterance[];
export type LambdaARN = string;
export type ListOfUtterance = UtteranceData[];
export type ListsOfUtterances = UtteranceList[];
export type Locale = "en-US"|"en-GB"|"de-DE"|string;
export type LocaleList = Locale[];
export type MaxResults = number;
export type MergeStrategy = "OVERWRITE_LATEST"|"FAIL_ON_CONFLICT"|string;
export interface Message {
/**
* The content type of the message string.
*/
contentType: ContentType;
/**
* The text of the message.
*/
content: ContentString;
/**
* Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
*/
groupNumber?: GroupNumber;
}
export type MessageList = Message[];
export type MessageVersion = string;
export type Name = string;
export type NextToken = string;
export type NumericalVersion = string;
export type Priority = number;
export type ProcessBehavior = "SAVE"|"BUILD"|string;
export interface Prompt {
/**
* An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
*/
messages: MessageList;
/**
* The number of times to prompt the user for information.
*/
maxAttempts: PromptMaxAttempts;
/**
* A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.
*/
responseCard?: ResponseCard;
}
export type PromptMaxAttempts = number;
export interface PutBotAliasRequest {
/**
* The name of the alias. The name is not case sensitive.
*/
name: AliasName;
/**
* A description of the alias.
*/
description?: Description;
/**
* The version of the bot.
*/
botVersion: Version;
/**
* The name of the bot.
*/
botName: BotName;
/**
* Identifies a specific revision of the $LATEST version. When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
*/
checksum?: String;
}
export interface PutBotAliasResponse {
/**
* The name of the alias.
*/
name?: AliasName;
/**
* A description of the alias.
*/
description?: Description;
/**
* The version of the bot that the alias points to.
*/
botVersion?: Version;
/**
* The name of the bot that the alias points to.
*/
botName?: BotName;
/**
* The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot alias was created.
*/
createdDate?: Timestamp;
/**
* The checksum for the current version of the alias.
*/
checksum?: String;
}
export interface PutBotRequest {
/**
* The name of the bot. The name is not case sensitive.
*/
name: BotName;
/**
* A description of the bot.
*/
description?: Description;
/**
* An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.
*/
intents?: IntentList;
/**
* When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field. When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'" If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the maxAttempts field. For more information, see AMAZON.FallbackIntent. If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases: Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent. Lambda function - When using a Lambda function, you return an ElicitIntent dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception. PutSession operation - When using the PutSession operation, you send an ElicitIntent dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
*/
clarificationPrompt?: Prompt;
/**
* When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type. For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times. For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot. If you have defined a fallback intent the abort statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
*/
abortStatement?: Statement;
/**
* The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over. If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes).
*/
idleSessionTTLInSeconds?: SessionTTL;
/**
* The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Voices in Amazon Polly in the Amazon Polly Developer Guide.
*/
voiceId?: String;
/**
* Identifies a specific revision of the $LATEST version. When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
*/
checksum?: String;
/**
* If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value is BUILD.
*/
processBehavior?: ProcessBehavior;
/**
* Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default is en-US.
*/
locale: Locale;
/**
* For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
*/
childDirected: Boolean;
/**
* When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
*/
detectSentiment?: Boolean;
/**
* When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.
*/
createVersion?: Boolean;
}
export interface PutBotResponse {
/**
* The name of the bot.
*/
name?: BotName;
/**
* A description of the bot.
*/
description?: Description;
/**
* An array of Intent objects. For more information, see PutBot.
*/
intents?: IntentList;
/**
* The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
*/
clarificationPrompt?: Prompt;
/**
* The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
*/
abortStatement?: Statement;
/**
* When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING. In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element. When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT. When the bot is in the READY state you can test and publish the bot.
*/
status?: Status;
/**
* If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
*/
failureReason?: String;
/**
* The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the bot was created.
*/
createdDate?: Timestamp;
/**
* The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
*/
idleSessionTTLInSeconds?: SessionTTL;
/**
* The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
*/
voiceId?: String;
/**
* Checksum of the bot that you created.
*/
checksum?: String;
/**
* The version of the bot. For a new bot, the version is always $LATEST.
*/
version?: Version;
/**
* The target locale for the bot.
*/
locale?: Locale;
/**
* For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
*/
childDirected?: Boolean;
/**
* True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
*/
createVersion?: Boolean;
/**
* true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.
*/
detectSentiment?: Boolean;
}
export interface PutIntentRequest {
/**
* The name of the intent. The name is not case sensitive. The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent. For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.
*/
name: IntentName;
/**
* A description of the intent.
*/
description?: Description;
/**
* An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.
*/
slots?: SlotList;
/**
* An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". In each utterance, a slot name is enclosed in curly braces.
*/
sampleUtterances?: IntentUtteranceList;
/**
* Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. You you must provide both the rejectionStatement and the confirmationPrompt, or neither.
*/
confirmationPrompt?: Prompt;
/**
* When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. You must provide both the rejectionStatement and the confirmationPrompt, or neither.
*/
rejectionStatement?: Statement;
/**
* Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink. The action that Amazon Lex takes depends on the user's response, as follows: If the user says "Yes" it responds with the clarification prompt that is configured for the bot. if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent. If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. If it doesn't recognize the utterance it repeats the follow-up prompt again. The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.
*/
followUpPrompt?: FollowUpPrompt;
/**
* The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element. The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.
*/
conclusionStatement?: Statement;
/**
* Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction. For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.
*/
dialogCodeHook?: CodeHook;
/**
* Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store. You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).
*/
fulfillmentActivity?: FulfillmentActivity;
/**
* A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
*/
parentIntentSignature?: BuiltinIntentSignature;
/**
* Identifies a specific revision of the $LATEST version. When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
*/
checksum?: String;
/**
* When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.
*/
createVersion?: Boolean;
}
export interface PutIntentResponse {
/**
* The name of the intent.
*/
name?: IntentName;
/**
* A description of the intent.
*/
description?: Description;
/**
* An array of intent slots that are configured for the intent.
*/
slots?: SlotList;
/**
* An array of sample utterances that are configured for the intent.
*/
sampleUtterances?: IntentUtteranceList;
/**
* If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
*/
confirmationPrompt?: Prompt;
/**
* If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.
*/
rejectionStatement?: Statement;
/**
* If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
*/
followUpPrompt?: FollowUpPrompt;
/**
* After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.
*/
conclusionStatement?: Statement;
/**
* If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
*/
dialogCodeHook?: CodeHook;
/**
* If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.
*/
fulfillmentActivity?: FulfillmentActivity;
/**
* A unique identifier for the built-in intent that this intent is based on.
*/
parentIntentSignature?: BuiltinIntentSignature;
/**
* The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the intent was created.
*/
createdDate?: Timestamp;
/**
* The version of the intent. For a new intent, the version is always $LATEST.
*/
version?: Version;
/**
* Checksum of the $LATESTversion of the intent created or updated.
*/
checksum?: String;
/**
* True if a new version of the intent was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
*/
createVersion?: Boolean;
}
export interface PutSlotTypeRequest {
/**
* The name of the slot type. The name is not case sensitive. The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
*/
name: SlotTypeName;
/**
* A description of the slot type.
*/
description?: Description;
/**
* A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot. When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.
*/
enumerationValues?: EnumerationValues;
/**
* Identifies a specific revision of the $LATEST version. When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
*/
checksum?: String;
/**
* Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.
*/
valueSelectionStrategy?: SlotValueSelectionStrategy;
/**
* When set to true a new numbered version of the slot type is created. This is the same as calling the CreateSlotTypeVersion operation. If you do not specify createVersion, the default is false.
*/
createVersion?: Boolean;
}
export interface PutSlotTypeResponse {
/**
* The name of the slot type.
*/
name?: SlotTypeName;
/**
* A description of the slot type.
*/
description?: Description;
/**
* A list of EnumerationValue objects that defines the values that the slot type can take.
*/
enumerationValues?: EnumerationValues;
/**
* The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the slot type was created.
*/
createdDate?: Timestamp;
/**
* The version of the slot type. For a new slot type, the version is always $LATEST.
*/
version?: Version;
/**
* Checksum of the $LATEST version of the slot type.
*/
checksum?: String;
/**
* The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
*/
valueSelectionStrategy?: SlotValueSelectionStrategy;
/**
* True if a new version of the slot type was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
*/
createVersion?: Boolean;
}
export type ResourceType = "BOT"|"INTENT"|"SLOT_TYPE"|string;
export type ResponseCard = string;
export type SessionTTL = number;
export interface Slot {
/**
* The name of the slot.
*/
name: SlotName;
/**
* A description of the slot.
*/
description?: Description;
/**
* Specifies whether the slot is required or optional.
*/
slotConstraint: SlotConstraint;
/**
* The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
*/
slotType?: CustomOrBuiltinSlotTypeName;
/**
* The version of the slot type.
*/
slotTypeVersion?: Version;
/**
* The prompt that Amazon Lex uses to elicit the slot value from the user.
*/
valueElicitationPrompt?: Prompt;
/**
* Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.
*/
priority?: Priority;
/**
* If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
*/
sampleUtterances?: SlotUtteranceList;
/**
* A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
*/
responseCard?: ResponseCard;
}
export type SlotConstraint = "Required"|"Optional"|string;
export type SlotList = Slot[];
export type SlotName = string;
export interface SlotTypeMetadata {
/**
* The name of the slot type.
*/
name?: SlotTypeName;
/**
* A description of the slot type.
*/
description?: Description;
/**
* The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
*/
lastUpdatedDate?: Timestamp;
/**
* The date that the slot type was created.
*/
createdDate?: Timestamp;
/**
* The version of the slot type.
*/
version?: Version;
}
export type SlotTypeMetadataList = SlotTypeMetadata[];
export type SlotTypeName = string;
export type SlotUtteranceList = Utterance[];
export type SlotValueSelectionStrategy = "ORIGINAL_VALUE"|"TOP_RESOLUTION"|string;
export interface StartImportRequest {
/**
* A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.
*/
payload: _Blob;
/**
* Specifies the type of resource to export. Each resource also exports any resources that it depends on. A bot exports dependent intents. An intent exports dependent slot types.
*/
resourceType: ResourceType;
/**
* Specifies the action that the StartImport operation should take when there is an existing resource with the same name. FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.
*/
mergeStrategy: MergeStrategy;
}
export interface StartImportResponse {
/**
* The name given to the import job.
*/
name?: Name;
/**
* The type of resource to import.
*/
resourceType?: ResourceType;
/**
* The action to take when there is a merge conflict.
*/
mergeStrategy?: MergeStrategy;
/**
* The identifier for the specific import job.
*/
importId?: String;
/**
* The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.
*/
importStatus?: ImportStatus;
/**
* A timestamp for the date and time that the import job was requested.
*/
createdDate?: Timestamp;
}
export interface Statement {
/**
* A collection of message objects.
*/
messages: MessageList;
/**
* At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
*/
responseCard?: ResponseCard;
}
export type Status = "BUILDING"|"READY"|"READY_BASIC_TESTING"|"FAILED"|"NOT_BUILT"|string;
export type StatusType = "Detected"|"Missed"|string;
export type String = string;
export type StringList = String[];
export type SynonymList = Value[];
export type Timestamp = Date;
export type UserId = string;
export type Utterance = string;
export interface UtteranceData {
/**
* The text that was entered by the user or the text representation of an audio clip.
*/
utteranceString?: UtteranceString;
/**
* The number of times that the utterance was processed.
*/
count?: Count;
/**
* The total number of individuals that used the utterance.
*/
distinctUsers?: Count;
/**
* The date that the utterance was first recorded.
*/
firstUtteredDate?: Timestamp;
/**
* The date that the utterance was last recorded.
*/
lastUtteredDate?: Timestamp;
}
export interface UtteranceList {
/**
* The version of the bot that processed the list.
*/
botVersion?: Version;
/**
* One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
*/
utterances?: ListOfUtterance;
}
export type UtteranceString = string;
export type Value = string;
export type Version = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-04-19"|"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 LexModelBuildingService client.
*/
export import Types = LexModelBuildingService;
}
export = LexModelBuildingService;