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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Describes a custom algorithm.
type Algorithm struct {
// The Amazon Resource Name (ARN) of the algorithm.
AlgorithmArn *string
// The URI of the Docker container for the algorithm image.
AlgorithmImage *AlgorithmImage
// The date and time (in Unix time) that the algorithm was created.
CreationDateTime *time.Time
// 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 hyperparameters.
DefaultHyperParameters map[string]string
// Specifies the default maximum number of training jobs and parallel training
// jobs.
DefaultResourceConfig map[string]string
// The date and time (in Unix time) that the algorithm was last updated.
LastUpdatedDateTime *time.Time
// The name of the algorithm.
Name *string
// The Amazon Resource Name (ARN) of the role.
RoleArn *string
// The training input mode.
TrainingInputMode *string
noSmithyDocumentSerde
}
// Describes an algorithm image.
type AlgorithmImage struct {
// The URI of the Docker container for the algorithm image.
//
// This member is required.
DockerURI *string
// The name of the algorithm image.
Name *string
noSmithyDocumentSerde
}
// When the solution performs AutoML ( performAutoML is true in CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)
// ), Amazon Personalize determines which recipe, from the specified list,
// optimizes the given metric. Amazon Personalize then uses that recipe for the
// solution.
type AutoMLConfig struct {
// The metric to optimize.
MetricName *string
// The list of candidate recipes.
RecipeList []string
noSmithyDocumentSerde
}
// When the solution performs AutoML ( performAutoML is true in CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)
// ), specifies the recipe that best optimized the specified metric.
type AutoMLResult struct {
// The Amazon Resource Name (ARN) of the best recipe.
BestRecipeArn *string
noSmithyDocumentSerde
}
// Contains information on a batch inference job.
type BatchInferenceJob struct {
// The Amazon Resource Name (ARN) of the batch inference job.
BatchInferenceJobArn *string
// A string to string map of the configuration details of a batch inference job.
BatchInferenceJobConfig *BatchInferenceJobConfig
// The job's mode.
BatchInferenceJobMode BatchInferenceJobMode
// The time at which the batch inference job was created.
CreationDateTime *time.Time
// If the batch inference job failed, the reason for the failure.
FailureReason *string
// The ARN of the filter used on the batch inference job.
FilterArn *string
// The Amazon S3 path that leads to the input data used to generate the batch
// inference job.
JobInput *BatchInferenceJobInput
// The name of the batch inference job.
JobName *string
// The Amazon S3 bucket that contains the output data generated by the batch
// inference job.
JobOutput *BatchInferenceJobOutput
// The time at which the batch inference job was last updated.
LastUpdatedDateTime *time.Time
// The number of recommendations generated by the batch inference job. This number
// includes the error messages generated for failed input records.
NumResults *int32
// The ARN of the Amazon Identity and Access Management (IAM) role that requested
// the batch inference job.
RoleArn *string
// The Amazon Resource Name (ARN) of the solution version from which the batch
// inference job was created.
SolutionVersionArn *string
// The status of the batch inference job. The status is one of the following
// values:
// - PENDING
// - IN PROGRESS
// - ACTIVE
// - CREATE FAILED
Status *string
// The job's theme generation settings.
ThemeGenerationConfig *ThemeGenerationConfig
noSmithyDocumentSerde
}
// The configuration details of a batch inference job.
type BatchInferenceJobConfig struct {
// A string to string map specifying the exploration configuration
// hyperparameters, including explorationWeight and explorationItemAgeCutOff , you
// want to use to configure the amount of item exploration Amazon Personalize uses
// when recommending items. See User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)
// .
ItemExplorationConfig map[string]string
noSmithyDocumentSerde
}
// The input configuration of a batch inference job.
type BatchInferenceJobInput struct {
// 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.
//
// This member is required.
S3DataSource *S3DataConfig
noSmithyDocumentSerde
}
// The output configuration parameters of a batch inference job.
type BatchInferenceJobOutput struct {
// Information on the Amazon S3 bucket in which the batch inference job's output
// is stored.
//
// This member is required.
S3DataDestination *S3DataConfig
noSmithyDocumentSerde
}
// A truncated version of the BatchInferenceJob (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html)
// . The ListBatchInferenceJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html)
// operation returns a list of batch inference job summaries.
type BatchInferenceJobSummary struct {
// The Amazon Resource Name (ARN) of the batch inference job.
BatchInferenceJobArn *string
// The job's mode.
BatchInferenceJobMode BatchInferenceJobMode
// The time at which the batch inference job was created.
CreationDateTime *time.Time
// If the batch inference job failed, the reason for the failure.
FailureReason *string
// The name of the batch inference job.
JobName *string
// The time at which the batch inference job was last updated.
LastUpdatedDateTime *time.Time
// The ARN of the solution version used by the batch inference job.
SolutionVersionArn *string
// The status of the batch inference job. The status is one of the following
// values:
// - PENDING
// - IN PROGRESS
// - ACTIVE
// - CREATE FAILED
Status *string
noSmithyDocumentSerde
}
// Contains information on a batch segment job.
type BatchSegmentJob struct {
// The Amazon Resource Name (ARN) of the batch segment job.
BatchSegmentJobArn *string
// The time at which the batch segment job was created.
CreationDateTime *time.Time
// If the batch segment job failed, the reason for the failure.
FailureReason *string
// The ARN of the filter used on the batch segment job.
FilterArn *string
// The Amazon S3 path that leads to the input data used to generate the batch
// segment job.
JobInput *BatchSegmentJobInput
// The name of the batch segment job.
JobName *string
// The Amazon S3 bucket that contains the output data generated by the batch
// segment job.
JobOutput *BatchSegmentJobOutput
// The time at which the batch segment job last updated.
LastUpdatedDateTime *time.Time
// The number of predicted users generated by the batch segment job for each line
// of input data. The maximum number of users per segment is 5 million.
NumResults *int32
// The ARN of the Amazon Identity and Access Management (IAM) role that requested
// the batch segment job.
RoleArn *string
// The Amazon Resource Name (ARN) of the solution version used by the batch
// segment job to generate batch segments.
SolutionVersionArn *string
// The status of the batch segment job. The status is one of the following values:
// - PENDING
// - IN PROGRESS
// - ACTIVE
// - CREATE FAILED
Status *string
noSmithyDocumentSerde
}
// The input configuration of a batch segment job.
type BatchSegmentJobInput struct {
// The configuration details of an Amazon S3 input or output bucket.
//
// This member is required.
S3DataSource *S3DataConfig
noSmithyDocumentSerde
}
// The output configuration parameters of a batch segment job.
type BatchSegmentJobOutput struct {
// The configuration details of an Amazon S3 input or output bucket.
//
// This member is required.
S3DataDestination *S3DataConfig
noSmithyDocumentSerde
}
// A truncated version of the BatchSegmentJob (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html)
// datatype. ListBatchSegmentJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html)
// operation returns a list of batch segment job summaries.
type BatchSegmentJobSummary struct {
// The Amazon Resource Name (ARN) of the batch segment job.
BatchSegmentJobArn *string
// The time at which the batch segment job was created.
CreationDateTime *time.Time
// If the batch segment job failed, the reason for the failure.
FailureReason *string
// The name of the batch segment job.
JobName *string
// The time at which the batch segment job was last updated.
LastUpdatedDateTime *time.Time
// The Amazon Resource Name (ARN) of the solution version used by the batch
// segment job to generate batch segments.
SolutionVersionArn *string
// The status of the batch segment job. The status is one of the following values:
// - PENDING
// - IN PROGRESS
// - ACTIVE
// - CREATE FAILED
Status *string
noSmithyDocumentSerde
}
// An object that describes the deployment of a solution version. For more
// information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)
// .
type Campaign struct {
// The Amazon Resource Name (ARN) of the campaign.
CampaignArn *string
// The configuration details of a campaign.
CampaignConfig *CampaignConfig
// The date and time (in Unix format) that the campaign was created.
CreationDateTime *time.Time
// If a campaign fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix format) that the campaign was last updated.
LastUpdatedDateTime *time.Time
// Provides a summary of the properties of a campaign update. For a complete
// listing, call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)
// API.
LatestCampaignUpdate *CampaignUpdateSummary
// Specifies the requested minimum provisioned transactions (recommendations) per
// second. A high minProvisionedTPS will increase your bill. We recommend starting
// with 1 for minProvisionedTPS (the default). Track your usage using Amazon
// CloudWatch metrics, and increase the minProvisionedTPS as necessary.
MinProvisionedTPS *int32
// The name of the campaign.
Name *string
// The Amazon Resource Name (ARN) of a specific version of the solution.
SolutionVersionArn *string
// 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 *string
noSmithyDocumentSerde
}
// The configuration details of a campaign.
type CampaignConfig struct {
// Whether metadata with recommendations is enabled for the campaign. If enabled,
// you can specify the columns from your Items dataset in your request for
// recommendations. Amazon Personalize returns this data for each item in the
// recommendation response. If you enable metadata in recommendations, you will
// incur additional costs. For more information, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/)
// .
EnableMetadataWithRecommendations *bool
// Specifies the exploration configuration hyperparameters, including
// explorationWeight and explorationItemAgeCutOff , you want to use to configure
// the amount of item exploration Amazon Personalize uses when recommending items.
// Provide itemExplorationConfig data only if your solution uses the
// User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)
// recipe.
ItemExplorationConfig map[string]string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a campaign. For a complete listing,
// call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)
// API.
type CampaignSummary struct {
// The Amazon Resource Name (ARN) of the campaign.
CampaignArn *string
// The date and time (in Unix time) that the campaign was created.
CreationDateTime *time.Time
// If a campaign fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix time) that the campaign was last updated.
LastUpdatedDateTime *time.Time
// The name of the campaign.
Name *string
// 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 *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a campaign update. For a complete
// listing, call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)
// API.
type CampaignUpdateSummary struct {
// The configuration details of a campaign.
CampaignConfig *CampaignConfig
// The date and time (in Unix time) that the campaign update was created.
CreationDateTime *time.Time
// If a campaign update fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix time) that the campaign update was last updated.
LastUpdatedDateTime *time.Time
// Specifies the requested minimum provisioned transactions (recommendations) per
// second that Amazon Personalize will support.
MinProvisionedTPS *int32
// The Amazon Resource Name (ARN) of the deployed solution version.
SolutionVersionArn *string
// 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 *string
noSmithyDocumentSerde
}
// Provides the name and range of a categorical hyperparameter.
type CategoricalHyperParameterRange struct {
// The name of the hyperparameter.
Name *string
// A list of the categories for the hyperparameter.
Values []string
noSmithyDocumentSerde
}
// Provides the name and range of a continuous hyperparameter.
type ContinuousHyperParameterRange struct {
// The maximum allowable value for the hyperparameter.
MaxValue float64
// The minimum allowable value for the hyperparameter.
MinValue float64
// The name of the hyperparameter.
Name *string
noSmithyDocumentSerde
}
// Provides metadata for a dataset.
type Dataset struct {
// The creation date and time (in Unix time) of the dataset.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset that you want metadata for.
DatasetArn *string
// The Amazon Resource Name (ARN) of the dataset group.
DatasetGroupArn *string
// One of the following values:
// - Interactions
// - Items
// - Users
// - Actions
// - Action_Interactions
DatasetType *string
// A time stamp that shows when the dataset was updated.
LastUpdatedDateTime *time.Time
// Describes the latest update to the dataset.
LatestDatasetUpdate *DatasetUpdateSummary
// The name of the dataset.
Name *string
// The ARN of the associated schema.
SchemaArn *string
// 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 *string
// The ID of the event tracker for an Action interactions dataset. You specify the
// tracker's ID in the PutActionInteractions API operation. Amazon Personalize
// uses it to direct new data to the Action interactions dataset in your dataset
// group.
TrackingId *string
noSmithyDocumentSerde
}
// Describes a job that exports a dataset to an Amazon S3 bucket. For more
// information, see CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)
// . A dataset export job can be in one of the following states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
type DatasetExportJob struct {
// The creation date and time (in Unix time) of the dataset export job.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset to export.
DatasetArn *string
// The Amazon Resource Name (ARN) of the dataset export job.
DatasetExportJobArn *string
// If a dataset export job fails, provides the reason why.
FailureReason *string
// The data to export, based on how you imported the data. You can choose to
// export BULK data that you imported using a dataset import job, PUT data that
// you imported incrementally (using the console, PutEvents, PutUsers and PutItems
// operations), or ALL for both types. The default value is PUT .
IngestionMode IngestionMode
// The name of the export job.
JobName *string
// The path to the Amazon S3 bucket where the job's output is stored. For example:
// s3://bucket-name/folder-name/
JobOutput *DatasetExportJobOutput
// The date and time (in Unix time) the status of the dataset export job was last
// updated.
LastUpdatedDateTime *time.Time
// The Amazon Resource Name (ARN) of the IAM service role that has permissions to
// add data to your output Amazon S3 bucket.
RoleArn *string
// The status of the dataset export job. A dataset export job can be in one of the
// following states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Status *string
noSmithyDocumentSerde
}
// The output configuration parameters of a dataset export job.
type DatasetExportJobOutput struct {
// The configuration details of an Amazon S3 input or output bucket.
//
// This member is required.
S3DataDestination *S3DataConfig
noSmithyDocumentSerde
}
// Provides a summary of the properties of a dataset export job. For a complete
// listing, call the DescribeDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html)
// API.
type DatasetExportJobSummary struct {
// The date and time (in Unix time) that the dataset export job was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset export job.
DatasetExportJobArn *string
// If a dataset export job fails, the reason behind the failure.
FailureReason *string
// The name of the dataset export job.
JobName *string
// The date and time (in Unix time) that the dataset export job status was last
// updated.
LastUpdatedDateTime *time.Time
// The status of the dataset export job. A dataset export job can be in one of the
// following states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Status *string
noSmithyDocumentSerde
}
// A dataset group is a collection of related datasets (Item interactions, Users,
// Items, Actions, Action interactions). You create a dataset group by calling
// CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)
// . You then create a dataset and add it to a dataset group by calling
// CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)
// . The dataset group is used to create and train a solution by calling
// CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)
// . A dataset group can contain only one of each type of dataset. You can specify
// an Key Management Service (KMS) key to encrypt the datasets in the group.
type DatasetGroup struct {
// The creation date and time (in Unix time) of the dataset group.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset group.
DatasetGroupArn *string
// The domain of a Domain dataset group.
Domain Domain
// If creating a dataset group fails, provides the reason why.
FailureReason *string
// The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to
// encrypt the datasets.
KmsKeyArn *string
// The last update date and time (in Unix time) of the dataset group.
LastUpdatedDateTime *time.Time
// The name of the dataset group.
Name *string
// The ARN of the Identity and Access Management (IAM) role that has permissions
// to access the Key Management Service (KMS) key. Supplying an IAM role is only
// valid when also specifying a KMS key.
RoleArn *string
// 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 *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a dataset group. For a complete
// listing, call the DescribeDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html)
// API.
type DatasetGroupSummary struct {
// The date and time (in Unix time) that the dataset group was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset group.
DatasetGroupArn *string
// The domain of a Domain dataset group.
Domain Domain
// If creating a dataset group fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix time) that the dataset group was last updated.
LastUpdatedDateTime *time.Time
// The name of the dataset group.
Name *string
// 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 *string
noSmithyDocumentSerde
}
// Describes a job that imports training data from a data source (Amazon S3
// bucket) to an Amazon Personalize dataset. For more information, see
// CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)
// . A dataset import job can be in one of the following states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
type DatasetImportJob struct {
// The creation date and time (in Unix time) of the dataset import job.
CreationDateTime *time.Time
// The Amazon S3 bucket that contains the training data to import.
DataSource *DataSource
// The Amazon Resource Name (ARN) of the dataset that receives the imported data.
DatasetArn *string
// The ARN of the dataset import job.
DatasetImportJobArn *string
// If a dataset import job fails, provides the reason why.
FailureReason *string
// The import mode used by the dataset import job to import new records.
ImportMode ImportMode
// The name of the import job.
JobName *string
// The date and time (in Unix time) the dataset was last updated.
LastUpdatedDateTime *time.Time
// Whether the job publishes metrics to Amazon S3 for a metric attribution.
PublishAttributionMetricsToS3 *bool
// The ARN of the IAM role that has permissions to read from the Amazon S3 data
// source.
RoleArn *string
// 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 *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a dataset import job. For a complete
// listing, call the DescribeDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html)
// API.
type DatasetImportJobSummary struct {
// The date and time (in Unix time) that the dataset import job was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset import job.
DatasetImportJobArn *string
// If a dataset import job fails, the reason behind the failure.
FailureReason *string
// The import mode the dataset import job used to update the data in the dataset.
// For more information see Updating existing bulk data (https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html)
// .
ImportMode ImportMode
// The name of the dataset import job.
JobName *string
// The date and time (in Unix time) that the dataset import job status was last
// updated.
LastUpdatedDateTime *time.Time
// 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 *string
noSmithyDocumentSerde
}
// Describes the schema for a dataset. For more information on schemas, see
// CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)
// .
type DatasetSchema struct {
// The date and time (in Unix time) that the schema was created.
CreationDateTime *time.Time
// The domain of a schema that you created for a dataset in a Domain dataset group.
Domain Domain
// The date and time (in Unix time) that the schema was last updated.
LastUpdatedDateTime *time.Time
// The name of the schema.
Name *string
// The schema.
Schema *string
// The Amazon Resource Name (ARN) of the schema.
SchemaArn *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a dataset schema. For a complete
// listing, call the DescribeSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html)
// API.
type DatasetSchemaSummary struct {
// The date and time (in Unix time) that the schema was created.
CreationDateTime *time.Time
// The domain of a schema that you created for a dataset in a Domain dataset group.
Domain Domain
// The date and time (in Unix time) that the schema was last updated.
LastUpdatedDateTime *time.Time
// The name of the schema.
Name *string
// The Amazon Resource Name (ARN) of the schema.
SchemaArn *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a dataset. For a complete listing, call
// the DescribeDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)
// API.
type DatasetSummary struct {
// The date and time (in Unix time) that the dataset was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The dataset type. One of the following values:
// - Interactions
// - Items
// - Users
// - Event-Interactions
DatasetType *string
// The date and time (in Unix time) that the dataset was last updated.
LastUpdatedDateTime *time.Time
// The name of the dataset.
Name *string
// 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 *string
noSmithyDocumentSerde
}
// Describes an update to a dataset.
type DatasetUpdateSummary struct {
// The creation date and time (in Unix time) of the dataset update.
CreationDateTime *time.Time
// If updating a dataset fails, provides the reason why.
FailureReason *string
// The last update date and time (in Unix time) of the dataset.
LastUpdatedDateTime *time.Time
// The Amazon Resource Name (ARN) of the schema that replaced the previous schema
// of the dataset.
SchemaArn *string
// The status of the dataset update.
Status *string
noSmithyDocumentSerde
}
// Describes the data source that contains the data to upload to a dataset.
type DataSource struct {
// 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/folder-name/
DataLocation *string
noSmithyDocumentSerde
}
// Provides the name and default range of a categorical hyperparameter and whether
// the hyperparameter is tunable. A tunable hyperparameter can have its value
// determined during hyperparameter optimization (HPO).
type DefaultCategoricalHyperParameterRange struct {
// Whether the hyperparameter is tunable.
IsTunable bool
// The name of the hyperparameter.
Name *string
// A list of the categories for the hyperparameter.
Values []string
noSmithyDocumentSerde
}
// Provides the name and default range of a continuous hyperparameter and whether
// the hyperparameter is tunable. A tunable hyperparameter can have its value
// determined during hyperparameter optimization (HPO).
type DefaultContinuousHyperParameterRange struct {
// Whether the hyperparameter is tunable.
IsTunable bool
// The maximum allowable value for the hyperparameter.
MaxValue float64
// The minimum allowable value for the hyperparameter.
MinValue float64
// The name of the hyperparameter.
Name *string
noSmithyDocumentSerde
}
// Specifies the hyperparameters and their default ranges. Hyperparameters can be
// categorical, continuous, or integer-valued.
type DefaultHyperParameterRanges struct {
// The categorical hyperparameters and their default ranges.
CategoricalHyperParameterRanges []DefaultCategoricalHyperParameterRange
// The continuous hyperparameters and their default ranges.
ContinuousHyperParameterRanges []DefaultContinuousHyperParameterRange
// The integer-valued hyperparameters and their default ranges.
IntegerHyperParameterRanges []DefaultIntegerHyperParameterRange
noSmithyDocumentSerde
}
// Provides the name and default range of a integer-valued hyperparameter and
// whether the hyperparameter is tunable. A tunable hyperparameter can have its
// value determined during hyperparameter optimization (HPO).
type DefaultIntegerHyperParameterRange struct {
// Indicates whether the hyperparameter is tunable.
IsTunable bool
// The maximum allowable value for the hyperparameter.
MaxValue int32
// The minimum allowable value for the hyperparameter.
MinValue int32
// The name of the hyperparameter.
Name *string
noSmithyDocumentSerde
}
// Provides information about an event tracker.
type EventTracker struct {
// The Amazon Web Services account that owns the event tracker.
AccountId *string
// The date and time (in Unix format) that the event tracker was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset group that receives the event
// data.
DatasetGroupArn *string
// The ARN of the event tracker.
EventTrackerArn *string
// The date and time (in Unix time) that the event tracker was last updated.
LastUpdatedDateTime *time.Time
// The name of the event tracker.
Name *string
// 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 *string
// The ID of the event tracker. Include this ID in requests to the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)
// API.
TrackingId *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of an event tracker. For a complete
// listing, call the DescribeEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html)
// API.
type EventTrackerSummary struct {
// The date and time (in Unix time) that the event tracker was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the event tracker.
EventTrackerArn *string
// The date and time (in Unix time) that the event tracker was last updated.
LastUpdatedDateTime *time.Time
// The name of the event tracker.
Name *string
// 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 *string
noSmithyDocumentSerde
}
// Provides feature transformation information. Feature transformation is the
// process of modifying raw input data into a form more suitable for model
// training.
type FeatureTransformation struct {
// The creation date and time (in Unix time) of the feature transformation.
CreationDateTime *time.Time
// Provides the default parameters for feature transformation.
DefaultParameters map[string]string
// The Amazon Resource Name (ARN) of the FeatureTransformation object.
FeatureTransformationArn *string
// The last update date and time (in Unix time) of the feature transformation.
LastUpdatedDateTime *time.Time
// The name of the feature transformation.
Name *string
// 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 *string
noSmithyDocumentSerde
}
// A string to string map of the configuration details for theme generation.
type FieldsForThemeGeneration struct {
// The name of the Items dataset column that stores the name of each item in the
// dataset.
//
// This member is required.
ItemName *string
noSmithyDocumentSerde
}
// Contains information on a recommendation filter, including its ARN, status, and
// filter expression.
type Filter struct {
// The time at which the filter was created.
CreationDateTime *time.Time
// The ARN of the dataset group to which the filter belongs.
DatasetGroupArn *string
// If the filter failed, the reason for its failure.
FailureReason *string
// The ARN of the filter.
FilterArn *string
// Specifies the type of item interactions to filter out of recommendation
// results. The filter expression must follow specific format rules. For
// information about filter expression structure and syntax, see Filter expressions (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html)
// .
FilterExpression *string
// The time at which the filter was last updated.
LastUpdatedDateTime *time.Time
// The name of the filter.
Name *string
// The status of the filter.
Status *string
noSmithyDocumentSerde
}
// A short summary of a filter's attributes.
type FilterSummary struct {
// The time at which the filter was created.
CreationDateTime *time.Time
// The ARN of the dataset group to which the filter belongs.
DatasetGroupArn *string
// If the filter failed, the reason for the failure.
FailureReason *string
// The ARN of the filter.
FilterArn *string
// The time at which the filter was last updated.
LastUpdatedDateTime *time.Time
// The name of the filter.
Name *string
// The status of the filter.
Status *string
noSmithyDocumentSerde
}
// Describes the properties for hyperparameter optimization (HPO).
type HPOConfig struct {
// The hyperparameters and their allowable ranges.
AlgorithmHyperParameterRanges *HyperParameterRanges
// The metric to optimize during HPO. Amazon Personalize doesn't support
// configuring the hpoObjective at this time.
HpoObjective *HPOObjective
// Describes the resource configuration for HPO.
HpoResourceConfig *HPOResourceConfig
noSmithyDocumentSerde
}
// The metric to optimize during hyperparameter optimization (HPO). Amazon
// Personalize doesn't support configuring the hpoObjective at this time.
type HPOObjective struct {
// The name of the metric.
MetricName *string
// A regular expression for finding the metric in the training job logs.
MetricRegex *string
// The type of the metric. Valid values are Maximize and Minimize .
Type *string
noSmithyDocumentSerde
}
// Describes the resource configuration for hyperparameter optimization (HPO).
type HPOResourceConfig struct {
// The maximum number of training jobs when you create a solution version. The
// maximum value for maxNumberOfTrainingJobs is 40 .
MaxNumberOfTrainingJobs *string
// The maximum number of parallel training jobs when you create a solution
// version. The maximum value for maxParallelTrainingJobs is 10 .
MaxParallelTrainingJobs *string
noSmithyDocumentSerde
}
// Specifies the hyperparameters and their ranges. Hyperparameters can be
// categorical, continuous, or integer-valued.
type HyperParameterRanges struct {
// The categorical hyperparameters and their ranges.
CategoricalHyperParameterRanges []CategoricalHyperParameterRange
// The continuous hyperparameters and their ranges.
ContinuousHyperParameterRanges []ContinuousHyperParameterRange
// The integer-valued hyperparameters and their ranges.
IntegerHyperParameterRanges []IntegerHyperParameterRange
noSmithyDocumentSerde
}
// Provides the name and range of an integer-valued hyperparameter.
type IntegerHyperParameterRange struct {
// The maximum allowable value for the hyperparameter.
MaxValue int32
// The minimum allowable value for the hyperparameter.
MinValue int32
// The name of the hyperparameter.
Name *string
noSmithyDocumentSerde
}
// Contains information on a metric that a metric attribution reports on. For more
// information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)
// .
type MetricAttribute struct {
// The metric's event type.
//
// This member is required.
EventType *string
// The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For
// SUM() functions, provide the dataset type (either Interactions or Items) and
// column to sum as a parameter. For example SUM(Items.PRICE).
//
// This member is required.
Expression *string
// The metric's name. The name helps you identify the metric in Amazon CloudWatch
// or Amazon S3.
//
// This member is required.
MetricName *string
noSmithyDocumentSerde
}
// Contains information on a metric attribution. A metric attribution creates
// reports on the data that you import into Amazon Personalize. Depending on how
// you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For
// more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)
// .
type MetricAttribution struct {
// The metric attribution's creation date time.
CreationDateTime *time.Time
// The metric attribution's dataset group Amazon Resource Name (ARN).
DatasetGroupArn *string
// The metric attribution's failure reason.
FailureReason *string
// The metric attribution's last updated date time.
LastUpdatedDateTime *time.Time
// The metric attribution's Amazon Resource Name (ARN).
MetricAttributionArn *string
// The metric attribution's output configuration.
MetricsOutputConfig *MetricAttributionOutput
// The metric attribution's name.
Name *string
// The metric attribution's status.
Status *string
noSmithyDocumentSerde
}
// The output configuration details for a metric attribution.
type MetricAttributionOutput struct {
// The Amazon Resource Name (ARN) of the IAM service role that has permissions to
// add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch.
// For more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)
// .
//
// This member is required.
RoleArn *string
// The configuration details of an Amazon S3 input or output bucket.
S3DataDestination *S3DataConfig
noSmithyDocumentSerde
}
// Provides a summary of the properties of a metric attribution. For a complete
// listing, call the DescribeMetricAttribution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html)
// .
type MetricAttributionSummary struct {
// The metric attribution's creation date time.
CreationDateTime *time.Time
// The metric attribution's failure reason.
FailureReason *string
// The metric attribution's last updated date time.
LastUpdatedDateTime *time.Time
// The metric attribution's Amazon Resource Name (ARN).
MetricAttributionArn *string
// The name of the metric attribution.
Name *string
// The metric attribution's status.
Status *string
noSmithyDocumentSerde
}
// Describes the additional objective for the solution, such as maximizing
// streaming minutes or increasing revenue. For more information see Optimizing a
// solution (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)
// .
type OptimizationObjective struct {
// The numerical metadata column in an Items dataset related to the optimization
// objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE
// (to maximize revenue).
ItemAttribute *string
// Specifies how Amazon Personalize balances the importance of your optimization
// objective versus relevance.
ObjectiveSensitivity ObjectiveSensitivity
noSmithyDocumentSerde
}
// Provides information about a recipe. Each recipe provides an algorithm that
// Amazon Personalize uses in model training when you use the CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)
// operation.
type Recipe struct {
// The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to
// train the model.
AlgorithmArn *string
// The date and time (in Unix format) that the recipe was created.
CreationDateTime *time.Time
// The description of the recipe.
Description *string
// The ARN of the FeatureTransformation object.
FeatureTransformationArn *string
// The date and time (in Unix format) that the recipe was last updated.
LastUpdatedDateTime *time.Time
// The name of the recipe.
Name *string
// The Amazon Resource Name (ARN) of the recipe.
RecipeArn *string
// One of the following values:
// - PERSONALIZED_RANKING
// - RELATED_ITEMS
// - USER_PERSONALIZATION
RecipeType *string
// The status of the recipe.
Status *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a recipe. For a complete listing, call
// the DescribeRecipe (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html)
// API.
type RecipeSummary struct {
// The date and time (in Unix time) that the recipe was created.
CreationDateTime *time.Time
// The domain of the recipe (if the recipe is a Domain dataset group use case).
Domain Domain
// The date and time (in Unix time) that the recipe was last updated.
LastUpdatedDateTime *time.Time
// The name of the recipe.
Name *string
// The Amazon Resource Name (ARN) of the recipe.
RecipeArn *string
// The status of the recipe.
Status *string
noSmithyDocumentSerde
}
// Describes a recommendation generator for a Domain dataset group. You create a
// recommender in a Domain dataset group for a specific domain use case (domain
// recipe), and specify the recommender in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)
// request.
type Recommender struct {
// The date and time (in Unix format) that the recommender was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the Domain dataset group that contains the
// recommender.
DatasetGroupArn *string
// If a recommender fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix format) that the recommender was last updated.
LastUpdatedDateTime *time.Time
// Provides a summary of the latest updates to the recommender.
LatestRecommenderUpdate *RecommenderUpdateSummary
// Provides evaluation metrics that help you determine the performance of a
// recommender. For more information, see Evaluating a recommender (https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html)
// .
ModelMetrics map[string]float64
// The name of the recommender.
Name *string
// The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case)
// that the recommender was created for.
RecipeArn *string
// The Amazon Resource Name (ARN) of the recommender.
RecommenderArn *string
// The configuration details of the recommender.
RecommenderConfig *RecommenderConfig
// The status of the recommender. A recommender can be in one of the following
// states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
// - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
// IN_PROGRESS > ACTIVE
// - DELETE PENDING > DELETE IN_PROGRESS
Status *string
noSmithyDocumentSerde
}
// The configuration details of the recommender.
type RecommenderConfig struct {
// Whether metadata with recommendations is enabled for the recommender. If
// enabled, you can specify the columns from your Items dataset in your request for
// recommendations. Amazon Personalize returns this data for each item in the
// recommendation response. If you enable metadata in recommendations, you will
// incur additional costs. For more information, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/)
// .
EnableMetadataWithRecommendations *bool
// Specifies the exploration configuration hyperparameters, including
// explorationWeight and explorationItemAgeCutOff , you want to use to configure
// the amount of item exploration Amazon Personalize uses when recommending items.
// Provide itemExplorationConfig data only if your recommenders generate
// personalized recommendations for a user (not popular items or similar items).
ItemExplorationConfig map[string]string
// Specifies the requested minimum provisioned recommendation requests per second
// that Amazon Personalize will support. A high minRecommendationRequestsPerSecond
// will increase your bill. We recommend starting with 1 for
// minRecommendationRequestsPerSecond (the default). Track your usage using Amazon
// CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as
// necessary.
MinRecommendationRequestsPerSecond *int32
// Specifies the training data configuration to use when creating a domain
// recommender.
TrainingDataConfig *TrainingDataConfig
noSmithyDocumentSerde
}
// Provides a summary of the properties of the recommender.
type RecommenderSummary struct {
// The date and time (in Unix format) that the recommender was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the Domain dataset group that contains the
// recommender.
DatasetGroupArn *string
// The date and time (in Unix format) that the recommender was last updated.
LastUpdatedDateTime *time.Time
// The name of the recommender.
Name *string
// The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case)
// that the recommender was created for.
RecipeArn *string
// The Amazon Resource Name (ARN) of the recommender.
RecommenderArn *string
// The configuration details of the recommender.
RecommenderConfig *RecommenderConfig
// The status of the recommender. A recommender can be in one of the following
// states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
// - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
// IN_PROGRESS > ACTIVE
// - DELETE PENDING > DELETE IN_PROGRESS
Status *string
noSmithyDocumentSerde
}
// Provides a summary of the properties of a recommender update. For a complete
// listing, call the DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html)
// API.
type RecommenderUpdateSummary struct {
// The date and time (in Unix format) that the recommender update was created.
CreationDateTime *time.Time
// If a recommender update fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix time) that the recommender update was last updated.
LastUpdatedDateTime *time.Time
// The configuration details of the recommender update.
RecommenderConfig *RecommenderConfig
// The status of the recommender update. A recommender can be in one of the
// following states:
// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
// - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
// IN_PROGRESS > ACTIVE
// - DELETE PENDING > DELETE IN_PROGRESS
Status *string
noSmithyDocumentSerde
}
// The configuration details of an Amazon S3 input or output bucket.
type S3DataConfig struct {
// The file path of the Amazon S3 bucket.
//
// This member is required.
Path *string
// The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that
// Amazon Personalize uses to encrypt or decrypt the input and output files.
KmsKeyArn *string
noSmithyDocumentSerde
}
// An object that provides information about a solution. A solution is a trained
// model that can be deployed as a campaign.
type Solution struct {
// When performAutoML is true, specifies the best recipe found.
AutoMLResult *AutoMLResult
// The creation date and time (in Unix time) of the solution.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset group that provides the training
// data.
DatasetGroupArn *string
// The event type (for example, 'click' or 'like') that is used for training the
// model. If no eventType is provided, Amazon Personalize uses all interactions
// for training with equal weight regardless of type.
EventType *string
// The date and time (in Unix time) that the solution was last updated.
LastUpdatedDateTime *time.Time
// Describes the latest version of the solution, including the status and the ARN.
LatestSolutionVersion *SolutionVersionSummary
// The name of the solution.
Name *string
// We don't recommend enabling automated machine learning. Instead, match your use
// case to the available Amazon Personalize recipes. For more information, see
// Determining your use case. (https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html)
// 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 bool
// Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The
// default is false .
PerformHPO bool
// The ARN of the recipe used to create the solution. This is required when
// performAutoML is false.
RecipeArn *string
// The ARN of the solution.
SolutionArn *string
// Describes the configuration properties for the solution.
SolutionConfig *SolutionConfig
// 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 *string
noSmithyDocumentSerde
}
// Describes the configuration properties for the solution.
type SolutionConfig struct {
// Lists the algorithm hyperparameters and their values.
AlgorithmHyperParameters map[string]string
// The AutoMLConfig (https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html)
// object containing a list of recipes to search when AutoML is performed.
AutoMLConfig *AutoMLConfig
// Only events with a value greater than or equal to this threshold are used for
// training a model.
EventValueThreshold *string
// Lists the feature transformation parameters.
FeatureTransformationParameters map[string]string
// Describes the properties for hyperparameter optimization (HPO).
HpoConfig *HPOConfig
// Describes the additional objective for the solution, such as maximizing
// streaming minutes or increasing revenue. For more information see Optimizing a
// solution (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)
// .
OptimizationObjective *OptimizationObjective
// Specifies the training data configuration to use when creating a custom
// solution version (trained model).
TrainingDataConfig *TrainingDataConfig
noSmithyDocumentSerde
}
// Provides a summary of the properties of a solution. For a complete listing,
// call the DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)
// API.
type SolutionSummary struct {
// The date and time (in Unix time) that the solution was created.
CreationDateTime *time.Time
// The date and time (in Unix time) that the solution was last updated.
LastUpdatedDateTime *time.Time
// The name of the solution.
Name *string
// The Amazon Resource Name (ARN) of the recipe used by the solution.
RecipeArn *string
// The Amazon Resource Name (ARN) of the solution.
SolutionArn *string
// 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 *string
noSmithyDocumentSerde
}
// An object that provides information about a specific version of a Solution (https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html)
// in a Custom dataset group.
type SolutionVersion struct {
// The date and time (in Unix time) that this version of the solution was created.
CreationDateTime *time.Time
// The Amazon Resource Name (ARN) of the dataset group providing the training data.
DatasetGroupArn *string
// The event type (for example, 'click' or 'like') that is used for training the
// model.
EventType *string
// If training a solution version fails, the reason for the failure.
FailureReason *string
// The date and time (in Unix time) that the solution was last updated.
LastUpdatedDateTime *time.Time
// The name of the solution version.
Name *string
// When true, Amazon Personalize searches for the most optimal recipe according to
// the solution configuration. When false (the default), Amazon Personalize uses
// recipeArn .
PerformAutoML bool
// Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The
// default is false .
PerformHPO bool
// The ARN of the recipe used in the solution.
RecipeArn *string
// The ARN of the solution.
SolutionArn *string
// Describes the configuration properties for the solution.
SolutionConfig *SolutionConfig
// The ARN of the solution version.
SolutionVersionArn *string
// 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
// - CREATE STOPPING
// - CREATE STOPPED
Status *string
// 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 *float64
// 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 User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)
// recipe or the HRNN-Coldstart (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html)
// recipe.
TrainingMode TrainingMode
// If hyperparameter optimization was performed, contains the hyperparameter
// values of the best performing model.
TunedHPOParams *TunedHPOParams
noSmithyDocumentSerde
}
// Provides a summary of the properties of a solution version. For a complete
// listing, call the DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)
// API.
type SolutionVersionSummary struct {
// The date and time (in Unix time) that this version of a solution was created.
CreationDateTime *time.Time
// If a solution version fails, the reason behind the failure.
FailureReason *string
// The date and time (in Unix time) that the solution version was last updated.
LastUpdatedDateTime *time.Time
// The Amazon Resource Name (ARN) of the solution version.
SolutionVersionArn *string
// 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 *string
noSmithyDocumentSerde
}
// The optional metadata that you apply to resources to help you categorize and
// organize them. Each tag consists of a key and an optional value, both of which
// you define. For more information see Tagging Amazon Personalize recources (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)
// .
type Tag struct {
// One part of a key-value pair that makes up a tag. A key is a general label that
// acts like a category for more specific tag values.
//
// This member is required.
TagKey *string
// The optional part of a key-value pair that makes up a tag. A value acts as a
// descriptor within a tag category (key).
//
// This member is required.
TagValue *string
noSmithyDocumentSerde
}
// The configuration details for generating themes with a batch inference job.
type ThemeGenerationConfig struct {
// Fields used to generate descriptive themes for a batch inference job.
//
// This member is required.
FieldsForThemeGeneration *FieldsForThemeGeneration
noSmithyDocumentSerde
}
// The training data configuration to use when creating a domain recommender or
// custom solution version (trained model).
type TrainingDataConfig struct {
// Specifies the columns to exclude from training. Each key is a dataset type, and
// each value is a list of columns. Exclude columns to control what data Amazon
// Personalize uses to generate recommendations. For example, you might have a
// column that you want to use only to filter recommendations. You can exclude this
// column from training and Amazon Personalize considers it only when filtering.
ExcludedDatasetColumns map[string][]string
noSmithyDocumentSerde
}
// If hyperparameter optimization (HPO) was performed, contains the hyperparameter
// values of the best performing model.
type TunedHPOParams struct {
// A list of the hyperparameter values of the best performing model.
AlgorithmHyperParameters map[string]string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|