personalize.d.ts
104 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Personalize extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Personalize.Types.ClientConfiguration)
config: Config & Personalize.Types.ClientConfiguration;
/**
* Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
*/
createBatchInferenceJob(params: Personalize.Types.CreateBatchInferenceJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
/**
* Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
*/
createBatchInferenceJob(callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
/**
* Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
*/
createCampaign(params: Personalize.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
/**
* Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
*/
createCampaign(callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
/**
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
*/
createDataset(params: Personalize.Types.CreateDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
/**
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
*/
createDataset(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
/**
* Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
*/
createDatasetGroup(params: Personalize.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
/**
* Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
*/
createDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
/**
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system. The dataset import job replaces any previous data in the dataset. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
*/
createDatasetImportJob(params: Personalize.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
/**
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system. The dataset import job replaces any previous data in the dataset. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
*/
createDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
/**
* Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API. When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
*/
createEventTracker(params: Personalize.Types.CreateEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
/**
* Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API. When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
*/
createEventTracker(callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
/**
* Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.
*/
createFilter(params: Personalize.Types.CreateFilterRequest, callback?: (err: AWSError, data: Personalize.Types.CreateFilterResponse) => void): Request<Personalize.Types.CreateFilterResponse, AWSError>;
/**
* Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.
*/
createFilter(callback?: (err: AWSError, data: Personalize.Types.CreateFilterResponse) => void): Request<Personalize.Types.CreateFilterResponse, AWSError>;
/**
* Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
*/
createSchema(params: Personalize.Types.CreateSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
/**
* Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
*/
createSchema(callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
/**
* Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you. Status A solution can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
*/
createSolution(params: Personalize.Types.CreateSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
/**
* Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you. Status A solution can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
*/
createSolution(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
/**
* Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
*/
createSolutionVersion(params: Personalize.Types.CreateSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
/**
* Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
*/
createSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
/**
* Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.
*/
deleteCampaign(params: Personalize.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.
*/
deleteCampaign(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
*/
deleteDataset(params: Personalize.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
*/
deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
*/
deleteDatasetGroup(params: Personalize.Types.DeleteDatasetGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
*/
deleteDatasetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
*/
deleteEventTracker(params: Personalize.Types.DeleteEventTrackerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
*/
deleteEventTracker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a filter.
*/
deleteFilter(params: Personalize.Types.DeleteFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a filter.
*/
deleteFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
*/
deleteSchema(params: Personalize.Types.DeleteSchemaRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
*/
deleteSchema(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
*/
deleteSolution(params: Personalize.Types.DeleteSolutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
*/
deleteSolution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes the given algorithm.
*/
describeAlgorithm(params: Personalize.Types.DescribeAlgorithmRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
/**
* Describes the given algorithm.
*/
describeAlgorithm(callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
/**
* Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
*/
describeBatchInferenceJob(params: Personalize.Types.DescribeBatchInferenceJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeBatchInferenceJobResponse) => void): Request<Personalize.Types.DescribeBatchInferenceJobResponse, AWSError>;
/**
* Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
*/
describeBatchInferenceJob(callback?: (err: AWSError, data: Personalize.Types.DescribeBatchInferenceJobResponse) => void): Request<Personalize.Types.DescribeBatchInferenceJobResponse, AWSError>;
/**
* Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
*/
describeCampaign(params: Personalize.Types.DescribeCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
/**
* Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
*/
describeCampaign(callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
/**
* Describes the given dataset. For more information on datasets, see CreateDataset.
*/
describeDataset(params: Personalize.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
/**
* Describes the given dataset. For more information on datasets, see CreateDataset.
*/
describeDataset(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
/**
* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
*/
describeDatasetGroup(params: Personalize.Types.DescribeDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
/**
* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
*/
describeDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
/**
* Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
*/
describeDatasetImportJob(params: Personalize.Types.DescribeDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
/**
* Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
*/
describeDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
/**
* Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
*/
describeEventTracker(params: Personalize.Types.DescribeEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
/**
* Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
*/
describeEventTracker(callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
/**
* Describes the given feature transformation.
*/
describeFeatureTransformation(params: Personalize.Types.DescribeFeatureTransformationRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
/**
* Describes the given feature transformation.
*/
describeFeatureTransformation(callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
/**
* Describes a filter's properties.
*/
describeFilter(params: Personalize.Types.DescribeFilterRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeFilterResponse) => void): Request<Personalize.Types.DescribeFilterResponse, AWSError>;
/**
* Describes a filter's properties.
*/
describeFilter(callback?: (err: AWSError, data: Personalize.Types.DescribeFilterResponse) => void): Request<Personalize.Types.DescribeFilterResponse, AWSError>;
/**
* Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
*/
describeRecipe(params: Personalize.Types.DescribeRecipeRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
/**
* Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
*/
describeRecipe(callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
/**
* Describes a schema. For more information on schemas, see CreateSchema.
*/
describeSchema(params: Personalize.Types.DescribeSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
/**
* Describes a schema. For more information on schemas, see CreateSchema.
*/
describeSchema(callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
/**
* Describes a solution. For more information on solutions, see CreateSolution.
*/
describeSolution(params: Personalize.Types.DescribeSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
/**
* Describes a solution. For more information on solutions, see CreateSolution.
*/
describeSolution(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
/**
* Describes a specific version of a solution. For more information on solutions, see CreateSolution.
*/
describeSolutionVersion(params: Personalize.Types.DescribeSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
/**
* Describes a specific version of a solution. For more information on solutions, see CreateSolution.
*/
describeSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
/**
* Gets the metrics for the specified solution version.
*/
getSolutionMetrics(params: Personalize.Types.GetSolutionMetricsRequest, callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
/**
* Gets the metrics for the specified solution version.
*/
getSolutionMetrics(callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
/**
* Gets a list of the batch inference jobs that have been performed off of a solution version.
*/
listBatchInferenceJobs(params: Personalize.Types.ListBatchInferenceJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListBatchInferenceJobsResponse) => void): Request<Personalize.Types.ListBatchInferenceJobsResponse, AWSError>;
/**
* Gets a list of the batch inference jobs that have been performed off of a solution version.
*/
listBatchInferenceJobs(callback?: (err: AWSError, data: Personalize.Types.ListBatchInferenceJobsResponse) => void): Request<Personalize.Types.ListBatchInferenceJobsResponse, AWSError>;
/**
* Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
*/
listCampaigns(params: Personalize.Types.ListCampaignsRequest, callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
/**
* Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
*/
listCampaigns(callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
/**
* Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
*/
listDatasetGroups(params: Personalize.Types.ListDatasetGroupsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
/**
* Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
*/
listDatasetGroups(callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
/**
* Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
*/
listDatasetImportJobs(params: Personalize.Types.ListDatasetImportJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
/**
* Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
*/
listDatasetImportJobs(callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
/**
* Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
*/
listDatasets(params: Personalize.Types.ListDatasetsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
/**
* Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
*/
listDatasets(callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
/**
* Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
*/
listEventTrackers(params: Personalize.Types.ListEventTrackersRequest, callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
/**
* Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
*/
listEventTrackers(callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
/**
* Lists all filters that belong to a given dataset group.
*/
listFilters(params: Personalize.Types.ListFiltersRequest, callback?: (err: AWSError, data: Personalize.Types.ListFiltersResponse) => void): Request<Personalize.Types.ListFiltersResponse, AWSError>;
/**
* Lists all filters that belong to a given dataset group.
*/
listFilters(callback?: (err: AWSError, data: Personalize.Types.ListFiltersResponse) => void): Request<Personalize.Types.ListFiltersResponse, AWSError>;
/**
* Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
*/
listRecipes(params: Personalize.Types.ListRecipesRequest, callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
/**
* Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
*/
listRecipes(callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
/**
* Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
*/
listSchemas(params: Personalize.Types.ListSchemasRequest, callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
/**
* Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
*/
listSchemas(callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
/**
* Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
*/
listSolutionVersions(params: Personalize.Types.ListSolutionVersionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
/**
* Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
*/
listSolutionVersions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
/**
* Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
*/
listSolutions(params: Personalize.Types.ListSolutionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
/**
* Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
*/
listSolutions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
/**
* Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API. You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations. For more information on campaigns, see CreateCampaign.
*/
updateCampaign(params: Personalize.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
/**
* Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API. You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations. For more information on campaigns, see CreateCampaign.
*/
updateCampaign(callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
}
declare namespace Personalize {
export type AccountId = string;
export interface Algorithm {
/**
* The name of the algorithm.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the algorithm.
*/
algorithmArn?: Arn;
/**
* The URI of the Docker container for the algorithm image.
*/
algorithmImage?: AlgorithmImage;
/**
* Specifies the default hyperparameters.
*/
defaultHyperParameters?: HyperParameters;
/**
* Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
*/
defaultHyperParameterRanges?: DefaultHyperParameterRanges;
/**
* Specifies the default maximum number of training jobs and parallel training jobs.
*/
defaultResourceConfig?: ResourceConfig;
/**
* The training input mode.
*/
trainingInputMode?: TrainingInputMode;
/**
* The Amazon Resource Name (ARN) of the role.
*/
roleArn?: Arn;
/**
* The date and time (in Unix time) that the algorithm was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the algorithm was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface AlgorithmImage {
/**
* The name of the algorithm image.
*/
name?: Name;
/**
* The URI of the Docker container for the algorithm image.
*/
dockerURI: DockerURI;
}
export type Arn = string;
export type ArnList = Arn[];
export interface AutoMLConfig {
/**
* The metric to optimize.
*/
metricName?: MetricName;
/**
* The list of candidate recipes.
*/
recipeList?: ArnList;
}
export interface AutoMLResult {
/**
* The Amazon Resource Name (ARN) of the best recipe.
*/
bestRecipeArn?: Arn;
}
export type AvroSchema = string;
export interface BatchInferenceJob {
/**
* The name of the batch inference job.
*/
jobName?: Name;
/**
* The Amazon Resource Name (ARN) of the batch inference job.
*/
batchInferenceJobArn?: Arn;
/**
* The ARN of the filter used on the batch inference job.
*/
filterArn?: Arn;
/**
* If the batch inference job failed, the reason for the failure.
*/
failureReason?: FailureReason;
/**
* The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
*/
solutionVersionArn?: Arn;
/**
* The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
*/
numResults?: NumBatchResults;
/**
* The Amazon S3 path that leads to the input data used to generate the batch inference job.
*/
jobInput?: BatchInferenceJobInput;
/**
* The Amazon S3 bucket that contains the output data generated by the batch inference job.
*/
jobOutput?: BatchInferenceJobOutput;
/**
* A string to string map of the configuration details of a batch inference job.
*/
batchInferenceJobConfig?: BatchInferenceJobConfig;
/**
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
*/
roleArn?: RoleArn;
/**
* The status of the batch inference job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
*/
status?: Status;
/**
* The time at which the batch inference job was created.
*/
creationDateTime?: _Date;
/**
* The time at which the batch inference job was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface BatchInferenceJobConfig {
/**
* A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See customizing-solution-config-hpo.
*/
itemExplorationConfig?: HyperParameters;
}
export interface BatchInferenceJobInput {
/**
* The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
*/
s3DataSource: S3DataConfig;
}
export interface BatchInferenceJobOutput {
/**
* Information on the Amazon S3 bucket in which the batch inference job's output is stored.
*/
s3DataDestination: S3DataConfig;
}
export interface BatchInferenceJobSummary {
/**
* The Amazon Resource Name (ARN) of the batch inference job.
*/
batchInferenceJobArn?: Arn;
/**
* The name of the batch inference job.
*/
jobName?: Name;
/**
* The status of the batch inference job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
*/
status?: Status;
/**
* The time at which the batch inference job was created.
*/
creationDateTime?: _Date;
/**
* The time at which the batch inference job was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If the batch inference job failed, the reason for the failure.
*/
failureReason?: FailureReason;
/**
* The ARN of the solution version used by the batch inference job.
*/
solutionVersionArn?: Arn;
}
export type BatchInferenceJobs = BatchInferenceJobSummary[];
export type Boolean = boolean;
export interface Campaign {
/**
* The name of the campaign.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
campaignArn?: Arn;
/**
* The Amazon Resource Name (ARN) of a specific version of the solution.
*/
solutionVersionArn?: Arn;
/**
* Specifies the requested minimum provisioned transactions (recommendations) per second.
*/
minProvisionedTPS?: TransactionsPerSecond;
/**
* The configuration details of a campaign.
*/
campaignConfig?: CampaignConfig;
/**
* The status of the campaign. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* If a campaign fails, the reason behind the failure.
*/
failureReason?: FailureReason;
/**
* The date and time (in Unix format) that the campaign was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix format) that the campaign was last updated.
*/
lastUpdatedDateTime?: _Date;
latestCampaignUpdate?: CampaignUpdateSummary;
}
export interface CampaignConfig {
/**
* A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See customizing-solution-config-hpo.
*/
itemExplorationConfig?: HyperParameters;
}
export interface CampaignSummary {
/**
* The name of the campaign.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
campaignArn?: Arn;
/**
* The status of the campaign. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The date and time (in Unix time) that the campaign was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the campaign was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If a campaign fails, the reason behind the failure.
*/
failureReason?: FailureReason;
}
export interface CampaignUpdateSummary {
/**
* The Amazon Resource Name (ARN) of the deployed solution version.
*/
solutionVersionArn?: Arn;
/**
* Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
*/
minProvisionedTPS?: TransactionsPerSecond;
campaignConfig?: CampaignConfig;
/**
* The status of the campaign update. A campaign update can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* If a campaign update fails, the reason behind the failure.
*/
failureReason?: FailureReason;
/**
* The date and time (in Unix time) that the campaign update was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the campaign update was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export type Campaigns = CampaignSummary[];
export interface CategoricalHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* A list of the categories for the hyperparameter.
*/
values?: CategoricalValues;
}
export type CategoricalHyperParameterRanges = CategoricalHyperParameterRange[];
export type CategoricalValue = string;
export type CategoricalValues = CategoricalValue[];
export interface ContinuousHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* The minimum allowable value for the hyperparameter.
*/
minValue?: ContinuousMinValue;
/**
* The maximum allowable value for the hyperparameter.
*/
maxValue?: ContinuousMaxValue;
}
export type ContinuousHyperParameterRanges = ContinuousHyperParameterRange[];
export type ContinuousMaxValue = number;
export type ContinuousMinValue = number;
export interface CreateBatchInferenceJobRequest {
/**
* The name of the batch inference job to create.
*/
jobName: Name;
/**
* The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
*/
solutionVersionArn: Arn;
/**
* The ARN of the filter to apply to the batch inference job. For more information on using filters, see Using Filters with Amazon Personalize.
*/
filterArn?: Arn;
/**
* The number of recommendations to retreive.
*/
numResults?: NumBatchResults;
/**
* The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
*/
jobInput: BatchInferenceJobInput;
/**
* The path to the Amazon S3 bucket where the job's output will be stored.
*/
jobOutput: BatchInferenceJobOutput;
/**
* The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.
*/
roleArn: RoleArn;
/**
* The configuration details of a batch inference job.
*/
batchInferenceJobConfig?: BatchInferenceJobConfig;
}
export interface CreateBatchInferenceJobResponse {
/**
* The ARN of the batch inference job.
*/
batchInferenceJobArn?: Arn;
}
export interface CreateCampaignRequest {
/**
* A name for the new campaign. The campaign name must be unique within your account.
*/
name: Name;
/**
* The Amazon Resource Name (ARN) of the solution version to deploy.
*/
solutionVersionArn: Arn;
/**
* Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
*/
minProvisionedTPS: TransactionsPerSecond;
/**
* The configuration details of a campaign.
*/
campaignConfig?: CampaignConfig;
}
export interface CreateCampaignResponse {
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
campaignArn?: Arn;
}
export interface CreateDatasetGroupRequest {
/**
* The name for the new dataset group.
*/
name: Name;
/**
* The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.
*/
roleArn?: RoleArn;
/**
* The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
*/
kmsKeyArn?: KmsKeyArn;
}
export interface CreateDatasetGroupResponse {
/**
* The Amazon Resource Name (ARN) of the new dataset group.
*/
datasetGroupArn?: Arn;
}
export interface CreateDatasetImportJobRequest {
/**
* The name for the dataset import job.
*/
jobName: Name;
/**
* The ARN of the dataset that receives the imported data.
*/
datasetArn: Arn;
/**
* The Amazon S3 bucket that contains the training data to import.
*/
dataSource: DataSource;
/**
* The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
*/
roleArn: RoleArn;
}
export interface CreateDatasetImportJobResponse {
/**
* The ARN of the dataset import job.
*/
datasetImportJobArn?: Arn;
}
export interface CreateDatasetRequest {
/**
* The name for the dataset.
*/
name: Name;
/**
* The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
*/
schemaArn: Arn;
/**
* The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
*/
datasetGroupArn: Arn;
/**
* The type of dataset. One of the following (case insensitive) values: Interactions Items Users
*/
datasetType: DatasetType;
}
export interface CreateDatasetResponse {
/**
* The ARN of the dataset.
*/
datasetArn?: Arn;
}
export interface CreateEventTrackerRequest {
/**
* The name for the event tracker.
*/
name: Name;
/**
* The Amazon Resource Name (ARN) of the dataset group that receives the event data.
*/
datasetGroupArn: Arn;
}
export interface CreateEventTrackerResponse {
/**
* The ARN of the event tracker.
*/
eventTrackerArn?: Arn;
/**
* The ID of the event tracker. Include this ID in requests to the PutEvents API.
*/
trackingId?: TrackingId;
}
export interface CreateFilterRequest {
/**
* The name of the filter to create.
*/
name: Name;
/**
* The ARN of the dataset group that the filter will belong to.
*/
datasetGroupArn: Arn;
/**
* The filter expression that designates the interaction types that the filter will filter out. A filter expression must follow the following format: EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type of event to filter out. To filter out all items with any interactions history, set "*" as the EVENT_TYPE. For more information, see Using Filters with Amazon Personalize.
*/
filterExpression: FilterExpression;
}
export interface CreateFilterResponse {
/**
* The ARN of the new filter.
*/
filterArn?: Arn;
}
export interface CreateSchemaRequest {
/**
* The name for the schema.
*/
name: Name;
/**
* A schema in Avro JSON format.
*/
schema: AvroSchema;
}
export interface CreateSchemaResponse {
/**
* The Amazon Resource Name (ARN) of the created schema.
*/
schemaArn?: Arn;
}
export interface CreateSolutionRequest {
/**
* The name for the solution.
*/
name: Name;
/**
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
*/
performHPO?: Boolean;
/**
* Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
*/
performAutoML?: PerformAutoML;
/**
* The ARN of the recipe to use for model training. Only specified when performAutoML is false.
*/
recipeArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the dataset group that provides the training data.
*/
datasetGroupArn: Arn;
/**
* When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.
*/
eventType?: EventType;
/**
* The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
*/
solutionConfig?: SolutionConfig;
}
export interface CreateSolutionResponse {
/**
* The ARN of the solution.
*/
solutionArn?: Arn;
}
export interface CreateSolutionVersionRequest {
/**
* The Amazon Resource Name (ARN) of the solution containing the training configuration information.
*/
solutionArn: Arn;
/**
* The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one. The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the native-recipe-hrnn-coldstart recipe.
*/
trainingMode?: TrainingMode;
}
export interface CreateSolutionVersionResponse {
/**
* The ARN of the new solution version.
*/
solutionVersionArn?: Arn;
}
export interface DataSource {
/**
* The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: s3://bucket-name/training-data.csv
*/
dataLocation?: S3Location;
}
export interface Dataset {
/**
* The name of the dataset.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the dataset that you want metadata for.
*/
datasetArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the dataset group.
*/
datasetGroupArn?: Arn;
/**
* One of the following values: Interactions Items Users
*/
datasetType?: DatasetType;
/**
* The ARN of the associated schema.
*/
schemaArn?: Arn;
/**
* The status of the dataset. A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The creation date and time (in Unix time) of the dataset.
*/
creationDateTime?: _Date;
/**
* A time stamp that shows when the dataset was updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface DatasetGroup {
/**
* The name of the dataset group.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the dataset group.
*/
datasetGroupArn?: Arn;
/**
* The current status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING
*/
status?: Status;
/**
* The ARN of the IAM role that has permissions to create the dataset group.
*/
roleArn?: RoleArn;
/**
* The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
*/
kmsKeyArn?: KmsKeyArn;
/**
* The creation date and time (in Unix time) of the dataset group.
*/
creationDateTime?: _Date;
/**
* The last update date and time (in Unix time) of the dataset group.
*/
lastUpdatedDateTime?: _Date;
/**
* If creating a dataset group fails, provides the reason why.
*/
failureReason?: FailureReason;
}
export interface DatasetGroupSummary {
/**
* The name of the dataset group.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the dataset group.
*/
datasetGroupArn?: Arn;
/**
* The status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING
*/
status?: Status;
/**
* The date and time (in Unix time) that the dataset group was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the dataset group was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If creating a dataset group fails, the reason behind the failure.
*/
failureReason?: FailureReason;
}
export type DatasetGroups = DatasetGroupSummary[];
export interface DatasetImportJob {
/**
* The name of the import job.
*/
jobName?: Name;
/**
* The ARN of the dataset import job.
*/
datasetImportJobArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the dataset that receives the imported data.
*/
datasetArn?: Arn;
/**
* The Amazon S3 bucket that contains the training data to import.
*/
dataSource?: DataSource;
/**
* The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.
*/
roleArn?: Arn;
/**
* The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*/
status?: Status;
/**
* The creation date and time (in Unix time) of the dataset import job.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) the dataset was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If a dataset import job fails, provides the reason why.
*/
failureReason?: FailureReason;
}
export interface DatasetImportJobSummary {
/**
* The Amazon Resource Name (ARN) of the dataset import job.
*/
datasetImportJobArn?: Arn;
/**
* The name of the dataset import job.
*/
jobName?: Name;
/**
* The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*/
status?: Status;
/**
* The date and time (in Unix time) that the dataset import job was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the dataset was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If a dataset import job fails, the reason behind the failure.
*/
failureReason?: FailureReason;
}
export type DatasetImportJobs = DatasetImportJobSummary[];
export interface DatasetSchema {
/**
* The name of the schema.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the schema.
*/
schemaArn?: Arn;
/**
* The schema.
*/
schema?: AvroSchema;
/**
* The date and time (in Unix time) that the schema was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the schema was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface DatasetSchemaSummary {
/**
* The name of the schema.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the schema.
*/
schemaArn?: Arn;
/**
* The date and time (in Unix time) that the schema was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the schema was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface DatasetSummary {
/**
* The name of the dataset.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
datasetArn?: Arn;
/**
* The dataset type. One of the following values: Interactions Items Users Event-Interactions
*/
datasetType?: DatasetType;
/**
* The status of the dataset. A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The date and time (in Unix time) that the dataset was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the dataset was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export type DatasetType = string;
export type Datasets = DatasetSummary[];
export type _Date = Date;
export interface DefaultCategoricalHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* A list of the categories for the hyperparameter.
*/
values?: CategoricalValues;
/**
* Whether the hyperparameter is tunable.
*/
isTunable?: Tunable;
}
export type DefaultCategoricalHyperParameterRanges = DefaultCategoricalHyperParameterRange[];
export interface DefaultContinuousHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* The minimum allowable value for the hyperparameter.
*/
minValue?: ContinuousMinValue;
/**
* The maximum allowable value for the hyperparameter.
*/
maxValue?: ContinuousMaxValue;
/**
* Whether the hyperparameter is tunable.
*/
isTunable?: Tunable;
}
export type DefaultContinuousHyperParameterRanges = DefaultContinuousHyperParameterRange[];
export interface DefaultHyperParameterRanges {
/**
* The integer-valued hyperparameters and their default ranges.
*/
integerHyperParameterRanges?: DefaultIntegerHyperParameterRanges;
/**
* The continuous hyperparameters and their default ranges.
*/
continuousHyperParameterRanges?: DefaultContinuousHyperParameterRanges;
/**
* The categorical hyperparameters and their default ranges.
*/
categoricalHyperParameterRanges?: DefaultCategoricalHyperParameterRanges;
}
export interface DefaultIntegerHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* The minimum allowable value for the hyperparameter.
*/
minValue?: IntegerMinValue;
/**
* The maximum allowable value for the hyperparameter.
*/
maxValue?: IntegerMaxValue;
/**
* Indicates whether the hyperparameter is tunable.
*/
isTunable?: Tunable;
}
export type DefaultIntegerHyperParameterRanges = DefaultIntegerHyperParameterRange[];
export interface DeleteCampaignRequest {
/**
* The Amazon Resource Name (ARN) of the campaign to delete.
*/
campaignArn: Arn;
}
export interface DeleteDatasetGroupRequest {
/**
* The ARN of the dataset group to delete.
*/
datasetGroupArn: Arn;
}
export interface DeleteDatasetRequest {
/**
* The Amazon Resource Name (ARN) of the dataset to delete.
*/
datasetArn: Arn;
}
export interface DeleteEventTrackerRequest {
/**
* The Amazon Resource Name (ARN) of the event tracker to delete.
*/
eventTrackerArn: Arn;
}
export interface DeleteFilterRequest {
/**
* The ARN of the filter to delete.
*/
filterArn: Arn;
}
export interface DeleteSchemaRequest {
/**
* The Amazon Resource Name (ARN) of the schema to delete.
*/
schemaArn: Arn;
}
export interface DeleteSolutionRequest {
/**
* The ARN of the solution to delete.
*/
solutionArn: Arn;
}
export interface DescribeAlgorithmRequest {
/**
* The Amazon Resource Name (ARN) of the algorithm to describe.
*/
algorithmArn: Arn;
}
export interface DescribeAlgorithmResponse {
/**
* A listing of the properties of the algorithm.
*/
algorithm?: Algorithm;
}
export interface DescribeBatchInferenceJobRequest {
/**
* The ARN of the batch inference job to describe.
*/
batchInferenceJobArn: Arn;
}
export interface DescribeBatchInferenceJobResponse {
/**
* Information on the specified batch inference job.
*/
batchInferenceJob?: BatchInferenceJob;
}
export interface DescribeCampaignRequest {
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
campaignArn: Arn;
}
export interface DescribeCampaignResponse {
/**
* The properties of the campaign.
*/
campaign?: Campaign;
}
export interface DescribeDatasetGroupRequest {
/**
* The Amazon Resource Name (ARN) of the dataset group to describe.
*/
datasetGroupArn: Arn;
}
export interface DescribeDatasetGroupResponse {
/**
* A listing of the dataset group's properties.
*/
datasetGroup?: DatasetGroup;
}
export interface DescribeDatasetImportJobRequest {
/**
* The Amazon Resource Name (ARN) of the dataset import job to describe.
*/
datasetImportJobArn: Arn;
}
export interface DescribeDatasetImportJobResponse {
/**
* Information about the dataset import job, including the status. The status is one of the following values: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
*/
datasetImportJob?: DatasetImportJob;
}
export interface DescribeDatasetRequest {
/**
* The Amazon Resource Name (ARN) of the dataset to describe.
*/
datasetArn: Arn;
}
export interface DescribeDatasetResponse {
/**
* A listing of the dataset's properties.
*/
dataset?: Dataset;
}
export interface DescribeEventTrackerRequest {
/**
* The Amazon Resource Name (ARN) of the event tracker to describe.
*/
eventTrackerArn: Arn;
}
export interface DescribeEventTrackerResponse {
/**
* An object that describes the event tracker.
*/
eventTracker?: EventTracker;
}
export interface DescribeFeatureTransformationRequest {
/**
* The Amazon Resource Name (ARN) of the feature transformation to describe.
*/
featureTransformationArn: Arn;
}
export interface DescribeFeatureTransformationResponse {
/**
* A listing of the FeatureTransformation properties.
*/
featureTransformation?: FeatureTransformation;
}
export interface DescribeFilterRequest {
/**
* The ARN of the filter to describe.
*/
filterArn: Arn;
}
export interface DescribeFilterResponse {
/**
* The filter's details.
*/
filter?: Filter;
}
export interface DescribeRecipeRequest {
/**
* The Amazon Resource Name (ARN) of the recipe to describe.
*/
recipeArn: Arn;
}
export interface DescribeRecipeResponse {
/**
* An object that describes the recipe.
*/
recipe?: Recipe;
}
export interface DescribeSchemaRequest {
/**
* The Amazon Resource Name (ARN) of the schema to retrieve.
*/
schemaArn: Arn;
}
export interface DescribeSchemaResponse {
/**
* The requested schema.
*/
schema?: DatasetSchema;
}
export interface DescribeSolutionRequest {
/**
* The Amazon Resource Name (ARN) of the solution to describe.
*/
solutionArn: Arn;
}
export interface DescribeSolutionResponse {
/**
* An object that describes the solution.
*/
solution?: Solution;
}
export interface DescribeSolutionVersionRequest {
/**
* The Amazon Resource Name (ARN) of the solution version.
*/
solutionVersionArn: Arn;
}
export interface DescribeSolutionVersionResponse {
/**
* The solution version.
*/
solutionVersion?: SolutionVersion;
}
export type Description = string;
export type DockerURI = string;
export interface EventTracker {
/**
* The name of the event tracker.
*/
name?: Name;
/**
* The ARN of the event tracker.
*/
eventTrackerArn?: Arn;
/**
* The Amazon AWS account that owns the event tracker.
*/
accountId?: AccountId;
/**
* The ID of the event tracker. Include this ID in requests to the PutEvents API.
*/
trackingId?: TrackingId;
/**
* The Amazon Resource Name (ARN) of the dataset group that receives the event data.
*/
datasetGroupArn?: Arn;
/**
* The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The date and time (in Unix format) that the event tracker was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the event tracker was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface EventTrackerSummary {
/**
* The name of the event tracker.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the event tracker.
*/
eventTrackerArn?: Arn;
/**
* The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The date and time (in Unix time) that the event tracker was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the event tracker was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export type EventTrackers = EventTrackerSummary[];
export type EventType = string;
export type EventValueThreshold = string;
export type FailureReason = string;
export interface FeatureTransformation {
/**
* The name of the feature transformation.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the FeatureTransformation object.
*/
featureTransformationArn?: Arn;
/**
* Provides the default parameters for feature transformation.
*/
defaultParameters?: FeaturizationParameters;
/**
* The creation date and time (in Unix time) of the feature transformation.
*/
creationDateTime?: _Date;
/**
* The last update date and time (in Unix time) of the feature transformation.
*/
lastUpdatedDateTime?: _Date;
/**
* The status of the feature transformation. A feature transformation can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*/
status?: Status;
}
export type FeatureTransformationParameters = {[key: string]: ParameterValue};
export type FeaturizationParameters = {[key: string]: ParameterValue};
export interface Filter {
/**
* The name of the filter.
*/
name?: Name;
/**
* The ARN of the filter.
*/
filterArn?: Arn;
/**
* The time at which the filter was created.
*/
creationDateTime?: _Date;
/**
* The time at which the filter was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* The ARN of the dataset group to which the filter belongs.
*/
datasetGroupArn?: Arn;
/**
* If the filter failed, the reason for its failure.
*/
failureReason?: FailureReason;
/**
* Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format: EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type of event to filter out. For more information, see Using Filters with Amazon Personalize.
*/
filterExpression?: FilterExpression;
/**
* The status of the filter.
*/
status?: Status;
}
export type FilterExpression = string;
export interface FilterSummary {
/**
* The name of the filter.
*/
name?: Name;
/**
* The ARN of the filter.
*/
filterArn?: Arn;
/**
* The time at which the filter was created.
*/
creationDateTime?: _Date;
/**
* The time at which the filter was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* The ARN of the dataset group to which the filter belongs.
*/
datasetGroupArn?: Arn;
/**
* If the filter failed, the reason for the failure.
*/
failureReason?: FailureReason;
/**
* The status of the filter.
*/
status?: Status;
}
export type Filters = FilterSummary[];
export interface GetSolutionMetricsRequest {
/**
* The Amazon Resource Name (ARN) of the solution version for which to get metrics.
*/
solutionVersionArn: Arn;
}
export interface GetSolutionMetricsResponse {
/**
* The same solution version ARN as specified in the request.
*/
solutionVersionArn?: Arn;
/**
* The metrics for the solution version.
*/
metrics?: Metrics;
}
export interface HPOConfig {
/**
* The metric to optimize during HPO.
*/
hpoObjective?: HPOObjective;
/**
* Describes the resource configuration for HPO.
*/
hpoResourceConfig?: HPOResourceConfig;
/**
* The hyperparameters and their allowable ranges.
*/
algorithmHyperParameterRanges?: HyperParameterRanges;
}
export interface HPOObjective {
/**
* The type of the metric. Valid values are Maximize and Minimize.
*/
type?: HPOObjectiveType;
/**
* The name of the metric.
*/
metricName?: MetricName;
/**
* A regular expression for finding the metric in the training job logs.
*/
metricRegex?: MetricRegex;
}
export type HPOObjectiveType = string;
export type HPOResource = string;
export interface HPOResourceConfig {
/**
* The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.
*/
maxNumberOfTrainingJobs?: HPOResource;
/**
* The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.
*/
maxParallelTrainingJobs?: HPOResource;
}
export interface HyperParameterRanges {
/**
* The integer-valued hyperparameters and their ranges.
*/
integerHyperParameterRanges?: IntegerHyperParameterRanges;
/**
* The continuous hyperparameters and their ranges.
*/
continuousHyperParameterRanges?: ContinuousHyperParameterRanges;
/**
* The categorical hyperparameters and their ranges.
*/
categoricalHyperParameterRanges?: CategoricalHyperParameterRanges;
}
export type HyperParameters = {[key: string]: ParameterValue};
export interface IntegerHyperParameterRange {
/**
* The name of the hyperparameter.
*/
name?: ParameterName;
/**
* The minimum allowable value for the hyperparameter.
*/
minValue?: IntegerMinValue;
/**
* The maximum allowable value for the hyperparameter.
*/
maxValue?: IntegerMaxValue;
}
export type IntegerHyperParameterRanges = IntegerHyperParameterRange[];
export type IntegerMaxValue = number;
export type IntegerMinValue = number;
export type KmsKeyArn = string;
export interface ListBatchInferenceJobsRequest {
/**
* The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
*/
solutionVersionArn?: Arn;
/**
* The token to request the next page of results.
*/
nextToken?: NextToken;
/**
* The maximum number of batch inference job results to return in each page. The default value is 100.
*/
maxResults?: MaxResults;
}
export interface ListBatchInferenceJobsResponse {
/**
* A list containing information on each job that is returned.
*/
batchInferenceJobs?: BatchInferenceJobs;
/**
* The token to use to retreive the next page of results. The value is null when there are no more results to return.
*/
nextToken?: NextToken;
}
export interface ListCampaignsRequest {
/**
* The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
*/
solutionArn?: Arn;
/**
* A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of campaigns to return.
*/
maxResults?: MaxResults;
}
export interface ListCampaignsResponse {
/**
* A list of the campaigns.
*/
campaigns?: Campaigns;
/**
* A token for getting the next set of campaigns (if they exist).
*/
nextToken?: NextToken;
}
export interface ListDatasetGroupsRequest {
/**
* A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of dataset groups to return.
*/
maxResults?: MaxResults;
}
export interface ListDatasetGroupsResponse {
/**
* The list of your dataset groups.
*/
datasetGroups?: DatasetGroups;
/**
* A token for getting the next set of dataset groups (if they exist).
*/
nextToken?: NextToken;
}
export interface ListDatasetImportJobsRequest {
/**
* The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
*/
datasetArn?: Arn;
/**
* A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of dataset import jobs to return.
*/
maxResults?: MaxResults;
}
export interface ListDatasetImportJobsResponse {
/**
* The list of dataset import jobs.
*/
datasetImportJobs?: DatasetImportJobs;
/**
* A token for getting the next set of dataset import jobs (if they exist).
*/
nextToken?: NextToken;
}
export interface ListDatasetsRequest {
/**
* The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
*/
datasetGroupArn?: Arn;
/**
* A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of datasets to return.
*/
maxResults?: MaxResults;
}
export interface ListDatasetsResponse {
/**
* An array of Dataset objects. Each object provides metadata information.
*/
datasets?: Datasets;
/**
* A token for getting the next set of datasets (if they exist).
*/
nextToken?: NextToken;
}
export interface ListEventTrackersRequest {
/**
* The ARN of a dataset group used to filter the response.
*/
datasetGroupArn?: Arn;
/**
* A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of event trackers to return.
*/
maxResults?: MaxResults;
}
export interface ListEventTrackersResponse {
/**
* A list of event trackers.
*/
eventTrackers?: EventTrackers;
/**
* A token for getting the next set of event trackers (if they exist).
*/
nextToken?: NextToken;
}
export interface ListFiltersRequest {
/**
* The ARN of the dataset group that contains the filters.
*/
datasetGroupArn?: Arn;
/**
* A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of filters to return.
*/
maxResults?: MaxResults;
}
export interface ListFiltersResponse {
/**
* A list of returned filters.
*/
Filters?: Filters;
/**
* A token for getting the next set of filters (if they exist).
*/
nextToken?: NextToken;
}
export interface ListRecipesRequest {
/**
* The default is SERVICE.
*/
recipeProvider?: RecipeProvider;
/**
* A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of recipes to return.
*/
maxResults?: MaxResults;
}
export interface ListRecipesResponse {
/**
* The list of available recipes.
*/
recipes?: Recipes;
/**
* A token for getting the next set of recipes.
*/
nextToken?: NextToken;
}
export interface ListSchemasRequest {
/**
* A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of schemas to return.
*/
maxResults?: MaxResults;
}
export interface ListSchemasResponse {
/**
* A list of schemas.
*/
schemas?: Schemas;
/**
* A token used to get the next set of schemas (if they exist).
*/
nextToken?: NextToken;
}
export interface ListSolutionVersionsRequest {
/**
* The Amazon Resource Name (ARN) of the solution.
*/
solutionArn?: Arn;
/**
* A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of solution versions to return.
*/
maxResults?: MaxResults;
}
export interface ListSolutionVersionsResponse {
/**
* A list of solution versions describing the version properties.
*/
solutionVersions?: SolutionVersions;
/**
* A token for getting the next set of solution versions (if they exist).
*/
nextToken?: NextToken;
}
export interface ListSolutionsRequest {
/**
* The Amazon Resource Name (ARN) of the dataset group.
*/
datasetGroupArn?: Arn;
/**
* A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).
*/
nextToken?: NextToken;
/**
* The maximum number of solutions to return.
*/
maxResults?: MaxResults;
}
export interface ListSolutionsResponse {
/**
* A list of the current solutions.
*/
solutions?: Solutions;
/**
* A token for getting the next set of solutions (if they exist).
*/
nextToken?: NextToken;
}
export type MaxResults = number;
export type MetricName = string;
export type MetricRegex = string;
export type MetricValue = number;
export type Metrics = {[key: string]: MetricValue};
export type Name = string;
export type NextToken = string;
export type NumBatchResults = number;
export type ParameterName = string;
export type ParameterValue = string;
export type PerformAutoML = boolean;
export type PerformHPO = boolean;
export interface Recipe {
/**
* The name of the recipe.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the recipe.
*/
recipeArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
*/
algorithmArn?: Arn;
/**
* The ARN of the FeatureTransformation object.
*/
featureTransformationArn?: Arn;
/**
* The status of the recipe.
*/
status?: Status;
/**
* The description of the recipe.
*/
description?: Description;
/**
* The date and time (in Unix format) that the recipe was created.
*/
creationDateTime?: _Date;
/**
* One of the following values: PERSONALIZED_RANKING RELATED_ITEMS USER_PERSONALIZATION
*/
recipeType?: RecipeType;
/**
* The date and time (in Unix format) that the recipe was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export type RecipeProvider = "SERVICE"|string;
export interface RecipeSummary {
/**
* The name of the recipe.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the recipe.
*/
recipeArn?: Arn;
/**
* The status of the recipe.
*/
status?: Status;
/**
* The date and time (in Unix time) that the recipe was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the recipe was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export type RecipeType = string;
export type Recipes = RecipeSummary[];
export type ResourceConfig = {[key: string]: ParameterValue};
export type RoleArn = string;
export interface S3DataConfig {
/**
* The file path of the Amazon S3 bucket.
*/
path: S3Location;
/**
* The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
*/
kmsKeyArn?: KmsKeyArn;
}
export type S3Location = string;
export type Schemas = DatasetSchemaSummary[];
export interface Solution {
/**
* The name of the solution.
*/
name?: Name;
/**
* The ARN of the solution.
*/
solutionArn?: Arn;
/**
* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
*/
performHPO?: PerformHPO;
/**
* When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
*/
performAutoML?: PerformAutoML;
/**
* The ARN of the recipe used to create the solution.
*/
recipeArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the dataset group that provides the training data.
*/
datasetGroupArn?: Arn;
/**
* The event type (for example, 'click' or 'like') that is used for training the model.
*/
eventType?: EventType;
/**
* Describes the configuration properties for the solution.
*/
solutionConfig?: SolutionConfig;
/**
* When performAutoML is true, specifies the best recipe found.
*/
autoMLResult?: AutoMLResult;
/**
* The status of the solution. A solution can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The creation date and time (in Unix time) of the solution.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the solution was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* Describes the latest version of the solution, including the status and the ARN.
*/
latestSolutionVersion?: SolutionVersionSummary;
}
export interface SolutionConfig {
/**
* Only events with a value greater than or equal to this threshold are used for training a model.
*/
eventValueThreshold?: EventValueThreshold;
/**
* Describes the properties for hyperparameter optimization (HPO).
*/
hpoConfig?: HPOConfig;
/**
* Lists the hyperparameter names and ranges.
*/
algorithmHyperParameters?: HyperParameters;
/**
* Lists the feature transformation parameters.
*/
featureTransformationParameters?: FeatureTransformationParameters;
/**
* The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
*/
autoMLConfig?: AutoMLConfig;
}
export interface SolutionSummary {
/**
* The name of the solution.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the solution.
*/
solutionArn?: Arn;
/**
* The status of the solution. A solution can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
*/
status?: Status;
/**
* The date and time (in Unix time) that the solution was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the solution was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface SolutionVersion {
/**
* The ARN of the solution version.
*/
solutionVersionArn?: Arn;
/**
* The ARN of the solution.
*/
solutionArn?: Arn;
/**
* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
*/
performHPO?: PerformHPO;
/**
* When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.
*/
performAutoML?: PerformAutoML;
/**
* The ARN of the recipe used in the solution.
*/
recipeArn?: Arn;
/**
* The event type (for example, 'click' or 'like') that is used for training the model.
*/
eventType?: EventType;
/**
* The Amazon Resource Name (ARN) of the dataset group providing the training data.
*/
datasetGroupArn?: Arn;
/**
* Describes the configuration properties for the solution.
*/
solutionConfig?: SolutionConfig;
/**
* The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
*/
trainingHours?: TrainingHours;
/**
* The scope of training used to create the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the training data that has changed since the creation of the last solution version. Choose UPDATE when you want to start recommending items added to the dataset without retraining the model. The UPDATE option can only be used after you've created a solution version with the FULL option and the training solution uses the native-recipe-hrnn-coldstart.
*/
trainingMode?: TrainingMode;
/**
* If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
*/
tunedHPOParams?: TunedHPOParams;
/**
* The status of the solution version. A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
*/
status?: Status;
/**
* If training a solution version fails, the reason for the failure.
*/
failureReason?: FailureReason;
/**
* The date and time (in Unix time) that this version of the solution was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the solution was last updated.
*/
lastUpdatedDateTime?: _Date;
}
export interface SolutionVersionSummary {
/**
* The Amazon Resource Name (ARN) of the solution version.
*/
solutionVersionArn?: Arn;
/**
* The status of the solution version. A solution version can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*/
status?: Status;
/**
* The date and time (in Unix time) that this version of a solution was created.
*/
creationDateTime?: _Date;
/**
* The date and time (in Unix time) that the solution version was last updated.
*/
lastUpdatedDateTime?: _Date;
/**
* If a solution version fails, the reason behind the failure.
*/
failureReason?: FailureReason;
}
export type SolutionVersions = SolutionVersionSummary[];
export type Solutions = SolutionSummary[];
export type Status = string;
export type TrackingId = string;
export type TrainingHours = number;
export type TrainingInputMode = string;
export type TrainingMode = "FULL"|"UPDATE"|string;
export type TransactionsPerSecond = number;
export type Tunable = boolean;
export interface TunedHPOParams {
/**
* A list of the hyperparameter values of the best performing model.
*/
algorithmHyperParameters?: HyperParameters;
}
export interface UpdateCampaignRequest {
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
campaignArn: Arn;
/**
* The ARN of a new solution version to deploy.
*/
solutionVersionArn?: Arn;
/**
* Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
*/
minProvisionedTPS?: TransactionsPerSecond;
/**
* The configuration details of a campaign.
*/
campaignConfig?: CampaignConfig;
}
export interface UpdateCampaignResponse {
/**
* The same campaign ARN as given in the request.
*/
campaignArn?: Arn;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-05-22"|"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 Personalize client.
*/
export import Types = Personalize;
}
export = Personalize;