1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package types 4 5import ( 6 "time" 7) 8 9// Describes a custom algorithm. 10type Algorithm struct { 11 12 // The Amazon Resource Name (ARN) of the algorithm. 13 AlgorithmArn *string 14 15 // The URI of the Docker container for the algorithm image. 16 AlgorithmImage *AlgorithmImage 17 18 // The date and time (in Unix time) that the algorithm was created. 19 CreationDateTime *time.Time 20 21 // Specifies the default hyperparameters, their ranges, and whether they are 22 // tunable. A tunable hyperparameter can have its value determined during 23 // hyperparameter optimization (HPO). 24 DefaultHyperParameterRanges *DefaultHyperParameterRanges 25 26 // Specifies the default hyperparameters. 27 DefaultHyperParameters map[string]string 28 29 // Specifies the default maximum number of training jobs and parallel training 30 // jobs. 31 DefaultResourceConfig map[string]string 32 33 // The date and time (in Unix time) that the algorithm was last updated. 34 LastUpdatedDateTime *time.Time 35 36 // The name of the algorithm. 37 Name *string 38 39 // The Amazon Resource Name (ARN) of the role. 40 RoleArn *string 41 42 // The training input mode. 43 TrainingInputMode *string 44} 45 46// Describes an algorithm image. 47type AlgorithmImage struct { 48 49 // The URI of the Docker container for the algorithm image. 50 // 51 // This member is required. 52 DockerURI *string 53 54 // The name of the algorithm image. 55 Name *string 56} 57 58// When the solution performs AutoML (performAutoML is true in CreateSolution), 59// Amazon Personalize determines which recipe, from the specified list, optimizes 60// the given metric. Amazon Personalize then uses that recipe for the solution. 61type AutoMLConfig struct { 62 63 // The metric to optimize. 64 MetricName *string 65 66 // The list of candidate recipes. 67 RecipeList []string 68} 69 70// When the solution performs AutoML (performAutoML is true in CreateSolution), 71// specifies the recipe that best optimized the specified metric. 72type AutoMLResult struct { 73 74 // The Amazon Resource Name (ARN) of the best recipe. 75 BestRecipeArn *string 76} 77 78// Contains information on a batch inference job. 79type BatchInferenceJob struct { 80 81 // The Amazon Resource Name (ARN) of the batch inference job. 82 BatchInferenceJobArn *string 83 84 // A string to string map of the configuration details of a batch inference job. 85 BatchInferenceJobConfig *BatchInferenceJobConfig 86 87 // The time at which the batch inference job was created. 88 CreationDateTime *time.Time 89 90 // If the batch inference job failed, the reason for the failure. 91 FailureReason *string 92 93 // The ARN of the filter used on the batch inference job. 94 FilterArn *string 95 96 // The Amazon S3 path that leads to the input data used to generate the batch 97 // inference job. 98 JobInput *BatchInferenceJobInput 99 100 // The name of the batch inference job. 101 JobName *string 102 103 // The Amazon S3 bucket that contains the output data generated by the batch 104 // inference job. 105 JobOutput *BatchInferenceJobOutput 106 107 // The time at which the batch inference job was last updated. 108 LastUpdatedDateTime *time.Time 109 110 // The number of recommendations generated by the batch inference job. This number 111 // includes the error messages generated for failed input records. 112 NumResults *int32 113 114 // The ARN of the Amazon Identity and Access Management (IAM) role that requested 115 // the batch inference job. 116 RoleArn *string 117 118 // The Amazon Resource Name (ARN) of the solution version from which the batch 119 // inference job was created. 120 SolutionVersionArn *string 121 122 // The status of the batch inference job. The status is one of the following 123 // values: 124 // 125 // * PENDING 126 // 127 // * IN PROGRESS 128 // 129 // * ACTIVE 130 // 131 // * CREATE FAILED 132 Status *string 133} 134 135// The configuration details of a batch inference job. 136type BatchInferenceJobConfig struct { 137 138 // A string to string map specifying the inference hyperparameters you wish to use 139 // for hyperparameter optimization. See customizing-solution-config-hpo. 140 ItemExplorationConfig map[string]string 141} 142 143// The input configuration of a batch inference job. 144type BatchInferenceJobInput struct { 145 146 // The URI of the Amazon S3 location that contains your input data. The Amazon S3 147 // bucket must be in the same region as the API endpoint you are calling. 148 // 149 // This member is required. 150 S3DataSource *S3DataConfig 151} 152 153// The output configuration parameters of a batch inference job. 154type BatchInferenceJobOutput struct { 155 156 // Information on the Amazon S3 bucket in which the batch inference job's output is 157 // stored. 158 // 159 // This member is required. 160 S3DataDestination *S3DataConfig 161} 162 163// A truncated version of the BatchInferenceJob datatype. The 164// ListBatchInferenceJobs operation returns a list of batch inference job 165// summaries. 166type BatchInferenceJobSummary struct { 167 168 // The Amazon Resource Name (ARN) of the batch inference job. 169 BatchInferenceJobArn *string 170 171 // The time at which the batch inference job was created. 172 CreationDateTime *time.Time 173 174 // If the batch inference job failed, the reason for the failure. 175 FailureReason *string 176 177 // The name of the batch inference job. 178 JobName *string 179 180 // The time at which the batch inference job was last updated. 181 LastUpdatedDateTime *time.Time 182 183 // The ARN of the solution version used by the batch inference job. 184 SolutionVersionArn *string 185 186 // The status of the batch inference job. The status is one of the following 187 // values: 188 // 189 // * PENDING 190 // 191 // * IN PROGRESS 192 // 193 // * ACTIVE 194 // 195 // * CREATE FAILED 196 Status *string 197} 198 199// Describes a deployed solution version, otherwise known as a campaign. For more 200// information on campaigns, see CreateCampaign. 201type Campaign struct { 202 203 // The Amazon Resource Name (ARN) of the campaign. 204 CampaignArn *string 205 206 // The configuration details of a campaign. 207 CampaignConfig *CampaignConfig 208 209 // The date and time (in Unix format) that the campaign was created. 210 CreationDateTime *time.Time 211 212 // If a campaign fails, the reason behind the failure. 213 FailureReason *string 214 215 // The date and time (in Unix format) that the campaign was last updated. 216 LastUpdatedDateTime *time.Time 217 218 // Provides a summary of the properties of a campaign update. For a complete 219 // listing, call the DescribeCampaign API. 220 LatestCampaignUpdate *CampaignUpdateSummary 221 222 // Specifies the requested minimum provisioned transactions (recommendations) per 223 // second. 224 MinProvisionedTPS *int32 225 226 // The name of the campaign. 227 Name *string 228 229 // The Amazon Resource Name (ARN) of a specific version of the solution. 230 SolutionVersionArn *string 231 232 // The status of the campaign. A campaign can be in one of the following states: 233 // 234 // * 235 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 236 // 237 // * DELETE 238 // PENDING > DELETE IN_PROGRESS 239 Status *string 240} 241 242// The configuration details of a campaign. 243type CampaignConfig struct { 244 245 // A string to string map specifying the inference hyperparameters you wish to use 246 // for hyperparameter optimization. See customizing-solution-config-hpo. 247 ItemExplorationConfig map[string]string 248} 249 250// Provides a summary of the properties of a campaign. For a complete listing, call 251// the DescribeCampaign API. 252type CampaignSummary struct { 253 254 // The Amazon Resource Name (ARN) of the campaign. 255 CampaignArn *string 256 257 // The date and time (in Unix time) that the campaign was created. 258 CreationDateTime *time.Time 259 260 // If a campaign fails, the reason behind the failure. 261 FailureReason *string 262 263 // The date and time (in Unix time) that the campaign was last updated. 264 LastUpdatedDateTime *time.Time 265 266 // The name of the campaign. 267 Name *string 268 269 // The status of the campaign. A campaign can be in one of the following states: 270 // 271 // * 272 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 273 // 274 // * DELETE 275 // PENDING > DELETE IN_PROGRESS 276 Status *string 277} 278 279// Provides a summary of the properties of a campaign update. For a complete 280// listing, call the DescribeCampaign API. 281type CampaignUpdateSummary struct { 282 283 // The configuration details of a campaign. 284 CampaignConfig *CampaignConfig 285 286 // The date and time (in Unix time) that the campaign update was created. 287 CreationDateTime *time.Time 288 289 // If a campaign update fails, the reason behind the failure. 290 FailureReason *string 291 292 // The date and time (in Unix time) that the campaign update was last updated. 293 LastUpdatedDateTime *time.Time 294 295 // Specifies the requested minimum provisioned transactions (recommendations) per 296 // second that Amazon Personalize will support. 297 MinProvisionedTPS *int32 298 299 // The Amazon Resource Name (ARN) of the deployed solution version. 300 SolutionVersionArn *string 301 302 // The status of the campaign update. A campaign update can be in one of the 303 // following states: 304 // 305 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE 306 // FAILED 307 // 308 // * DELETE PENDING > DELETE IN_PROGRESS 309 Status *string 310} 311 312// Provides the name and range of a categorical hyperparameter. 313type CategoricalHyperParameterRange struct { 314 315 // The name of the hyperparameter. 316 Name *string 317 318 // A list of the categories for the hyperparameter. 319 Values []string 320} 321 322// Provides the name and range of a continuous hyperparameter. 323type ContinuousHyperParameterRange struct { 324 325 // The maximum allowable value for the hyperparameter. 326 MaxValue float64 327 328 // The minimum allowable value for the hyperparameter. 329 MinValue float64 330 331 // The name of the hyperparameter. 332 Name *string 333} 334 335// Provides metadata for a dataset. 336type Dataset struct { 337 338 // The creation date and time (in Unix time) of the dataset. 339 CreationDateTime *time.Time 340 341 // The Amazon Resource Name (ARN) of the dataset that you want metadata for. 342 DatasetArn *string 343 344 // The Amazon Resource Name (ARN) of the dataset group. 345 DatasetGroupArn *string 346 347 // One of the following values: 348 // 349 // * Interactions 350 // 351 // * Items 352 // 353 // * Users 354 DatasetType *string 355 356 // A time stamp that shows when the dataset was updated. 357 LastUpdatedDateTime *time.Time 358 359 // The name of the dataset. 360 Name *string 361 362 // The ARN of the associated schema. 363 SchemaArn *string 364 365 // The status of the dataset. A dataset can be in one of the following states: 366 // 367 // * 368 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 369 // 370 // * DELETE 371 // PENDING > DELETE IN_PROGRESS 372 Status *string 373} 374 375// A dataset group is a collection of related datasets (Interactions, User, and 376// Item). You create a dataset group by calling CreateDatasetGroup. You then create 377// a dataset and add it to a dataset group by calling CreateDataset. The dataset 378// group is used to create and train a solution by calling CreateSolution. A 379// dataset group can contain only one of each type of dataset. You can specify an 380// AWS Key Management Service (KMS) key to encrypt the datasets in the group. 381type DatasetGroup struct { 382 383 // The creation date and time (in Unix time) of the dataset group. 384 CreationDateTime *time.Time 385 386 // The Amazon Resource Name (ARN) of the dataset group. 387 DatasetGroupArn *string 388 389 // If creating a dataset group fails, provides the reason why. 390 FailureReason *string 391 392 // The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets. 393 KmsKeyArn *string 394 395 // The last update date and time (in Unix time) of the dataset group. 396 LastUpdatedDateTime *time.Time 397 398 // The name of the dataset group. 399 Name *string 400 401 // The ARN of the IAM role that has permissions to create the dataset group. 402 RoleArn *string 403 404 // The current status of the dataset group. A dataset group can be in one of the 405 // following states: 406 // 407 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE 408 // FAILED 409 // 410 // * DELETE PENDING 411 Status *string 412} 413 414// Provides a summary of the properties of a dataset group. For a complete listing, 415// call the DescribeDatasetGroup API. 416type DatasetGroupSummary struct { 417 418 // The date and time (in Unix time) that the dataset group was created. 419 CreationDateTime *time.Time 420 421 // The Amazon Resource Name (ARN) of the dataset group. 422 DatasetGroupArn *string 423 424 // If creating a dataset group fails, the reason behind the failure. 425 FailureReason *string 426 427 // The date and time (in Unix time) that the dataset group was last updated. 428 LastUpdatedDateTime *time.Time 429 430 // The name of the dataset group. 431 Name *string 432 433 // The status of the dataset group. A dataset group can be in one of the following 434 // states: 435 // 436 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 437 // 438 // * 439 // DELETE PENDING 440 Status *string 441} 442 443// Describes a job that imports training data from a data source (Amazon S3 bucket) 444// to an Amazon Personalize dataset. For more information, see 445// CreateDatasetImportJob. A dataset import job can be in one of the following 446// states: 447// 448// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 449type DatasetImportJob struct { 450 451 // The creation date and time (in Unix time) of the dataset import job. 452 CreationDateTime *time.Time 453 454 // The Amazon S3 bucket that contains the training data to import. 455 DataSource *DataSource 456 457 // The Amazon Resource Name (ARN) of the dataset that receives the imported data. 458 DatasetArn *string 459 460 // The ARN of the dataset import job. 461 DatasetImportJobArn *string 462 463 // If a dataset import job fails, provides the reason why. 464 FailureReason *string 465 466 // The name of the import job. 467 JobName *string 468 469 // The date and time (in Unix time) the dataset was last updated. 470 LastUpdatedDateTime *time.Time 471 472 // The ARN of the AWS Identity and Access Management (IAM) role that has 473 // permissions to read from the Amazon S3 data source. 474 RoleArn *string 475 476 // The status of the dataset import job. A dataset import job can be in one of the 477 // following states: 478 // 479 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE 480 // FAILED 481 Status *string 482} 483 484// Provides a summary of the properties of a dataset import job. For a complete 485// listing, call the DescribeDatasetImportJob API. 486type DatasetImportJobSummary struct { 487 488 // The date and time (in Unix time) that the dataset import job was created. 489 CreationDateTime *time.Time 490 491 // The Amazon Resource Name (ARN) of the dataset import job. 492 DatasetImportJobArn *string 493 494 // If a dataset import job fails, the reason behind the failure. 495 FailureReason *string 496 497 // The name of the dataset import job. 498 JobName *string 499 500 // The date and time (in Unix time) that the dataset was last updated. 501 LastUpdatedDateTime *time.Time 502 503 // The status of the dataset import job. A dataset import job can be in one of the 504 // following states: 505 // 506 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE 507 // FAILED 508 Status *string 509} 510 511// Describes the schema for a dataset. For more information on schemas, see 512// CreateSchema. 513type DatasetSchema struct { 514 515 // The date and time (in Unix time) that the schema was created. 516 CreationDateTime *time.Time 517 518 // The date and time (in Unix time) that the schema was last updated. 519 LastUpdatedDateTime *time.Time 520 521 // The name of the schema. 522 Name *string 523 524 // The schema. 525 Schema *string 526 527 // The Amazon Resource Name (ARN) of the schema. 528 SchemaArn *string 529} 530 531// Provides a summary of the properties of a dataset schema. For a complete 532// listing, call the DescribeSchema API. 533type DatasetSchemaSummary struct { 534 535 // The date and time (in Unix time) that the schema was created. 536 CreationDateTime *time.Time 537 538 // The date and time (in Unix time) that the schema was last updated. 539 LastUpdatedDateTime *time.Time 540 541 // The name of the schema. 542 Name *string 543 544 // The Amazon Resource Name (ARN) of the schema. 545 SchemaArn *string 546} 547 548// Provides a summary of the properties of a dataset. For a complete listing, call 549// the DescribeDataset API. 550type DatasetSummary struct { 551 552 // The date and time (in Unix time) that the dataset was created. 553 CreationDateTime *time.Time 554 555 // The Amazon Resource Name (ARN) of the dataset. 556 DatasetArn *string 557 558 // The dataset type. One of the following values: 559 // 560 // * Interactions 561 // 562 // * Items 563 // 564 // * 565 // Users 566 // 567 // * Event-Interactions 568 DatasetType *string 569 570 // The date and time (in Unix time) that the dataset was last updated. 571 LastUpdatedDateTime *time.Time 572 573 // The name of the dataset. 574 Name *string 575 576 // The status of the dataset. A dataset can be in one of the following states: 577 // 578 // * 579 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 580 // 581 // * DELETE 582 // PENDING > DELETE IN_PROGRESS 583 Status *string 584} 585 586// Describes the data source that contains the data to upload to a dataset. 587type DataSource struct { 588 589 // The path to the Amazon S3 bucket where the data that you want to upload to your 590 // dataset is stored. For example: s3://bucket-name/training-data.csv 591 DataLocation *string 592} 593 594// Provides the name and default range of a categorical hyperparameter and whether 595// the hyperparameter is tunable. A tunable hyperparameter can have its value 596// determined during hyperparameter optimization (HPO). 597type DefaultCategoricalHyperParameterRange struct { 598 599 // Whether the hyperparameter is tunable. 600 IsTunable bool 601 602 // The name of the hyperparameter. 603 Name *string 604 605 // A list of the categories for the hyperparameter. 606 Values []string 607} 608 609// Provides the name and default range of a continuous hyperparameter and whether 610// the hyperparameter is tunable. A tunable hyperparameter can have its value 611// determined during hyperparameter optimization (HPO). 612type DefaultContinuousHyperParameterRange struct { 613 614 // Whether the hyperparameter is tunable. 615 IsTunable bool 616 617 // The maximum allowable value for the hyperparameter. 618 MaxValue float64 619 620 // The minimum allowable value for the hyperparameter. 621 MinValue float64 622 623 // The name of the hyperparameter. 624 Name *string 625} 626 627// Specifies the hyperparameters and their default ranges. Hyperparameters can be 628// categorical, continuous, or integer-valued. 629type DefaultHyperParameterRanges struct { 630 631 // The categorical hyperparameters and their default ranges. 632 CategoricalHyperParameterRanges []DefaultCategoricalHyperParameterRange 633 634 // The continuous hyperparameters and their default ranges. 635 ContinuousHyperParameterRanges []DefaultContinuousHyperParameterRange 636 637 // The integer-valued hyperparameters and their default ranges. 638 IntegerHyperParameterRanges []DefaultIntegerHyperParameterRange 639} 640 641// Provides the name and default range of a integer-valued hyperparameter and 642// whether the hyperparameter is tunable. A tunable hyperparameter can have its 643// value determined during hyperparameter optimization (HPO). 644type DefaultIntegerHyperParameterRange struct { 645 646 // Indicates whether the hyperparameter is tunable. 647 IsTunable bool 648 649 // The maximum allowable value for the hyperparameter. 650 MaxValue int32 651 652 // The minimum allowable value for the hyperparameter. 653 MinValue int32 654 655 // The name of the hyperparameter. 656 Name *string 657} 658 659// Provides information about an event tracker. 660type EventTracker struct { 661 662 // The Amazon AWS account that owns the event tracker. 663 AccountId *string 664 665 // The date and time (in Unix format) that the event tracker was created. 666 CreationDateTime *time.Time 667 668 // The Amazon Resource Name (ARN) of the dataset group that receives the event 669 // data. 670 DatasetGroupArn *string 671 672 // The ARN of the event tracker. 673 EventTrackerArn *string 674 675 // The date and time (in Unix time) that the event tracker was last updated. 676 LastUpdatedDateTime *time.Time 677 678 // The name of the event tracker. 679 Name *string 680 681 // The status of the event tracker. An event tracker can be in one of the following 682 // states: 683 // 684 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 685 // 686 // * 687 // DELETE PENDING > DELETE IN_PROGRESS 688 Status *string 689 690 // The ID of the event tracker. Include this ID in requests to the PutEvents 691 // (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. 692 TrackingId *string 693} 694 695// Provides a summary of the properties of an event tracker. For a complete 696// listing, call the DescribeEventTracker API. 697type EventTrackerSummary struct { 698 699 // The date and time (in Unix time) that the event tracker was created. 700 CreationDateTime *time.Time 701 702 // The Amazon Resource Name (ARN) of the event tracker. 703 EventTrackerArn *string 704 705 // The date and time (in Unix time) that the event tracker was last updated. 706 LastUpdatedDateTime *time.Time 707 708 // The name of the event tracker. 709 Name *string 710 711 // The status of the event tracker. An event tracker can be in one of the following 712 // states: 713 // 714 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 715 // 716 // * 717 // DELETE PENDING > DELETE IN_PROGRESS 718 Status *string 719} 720 721// Provides feature transformation information. Feature transformation is the 722// process of modifying raw input data into a form more suitable for model 723// training. 724type FeatureTransformation struct { 725 726 // The creation date and time (in Unix time) of the feature transformation. 727 CreationDateTime *time.Time 728 729 // Provides the default parameters for feature transformation. 730 DefaultParameters map[string]string 731 732 // The Amazon Resource Name (ARN) of the FeatureTransformation object. 733 FeatureTransformationArn *string 734 735 // The last update date and time (in Unix time) of the feature transformation. 736 LastUpdatedDateTime *time.Time 737 738 // The name of the feature transformation. 739 Name *string 740 741 // The status of the feature transformation. A feature transformation can be in one 742 // of the following states: 743 // 744 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- 745 // CREATE FAILED 746 Status *string 747} 748 749// Contains information on a recommendation filter, including its ARN, status, and 750// filter expression. 751type Filter struct { 752 753 // The time at which the filter was created. 754 CreationDateTime *time.Time 755 756 // The ARN of the dataset group to which the filter belongs. 757 DatasetGroupArn *string 758 759 // If the filter failed, the reason for its failure. 760 FailureReason *string 761 762 // The ARN of the filter. 763 FilterArn *string 764 765 // Specifies the type of item interactions to filter out of recommendation results. 766 // The filter expression must follow the following format: EXCLUDE itemId WHERE 767 // INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type of 768 // event to filter out. For more information, see Using Filters with Amazon 769 // Personalize (https://docs.aws.amazon.com/personalize/latest/dg/filters.html). 770 FilterExpression *string 771 772 // The time at which the filter was last updated. 773 LastUpdatedDateTime *time.Time 774 775 // The name of the filter. 776 Name *string 777 778 // The status of the filter. 779 Status *string 780} 781 782// A short summary of a filter's attributes. 783type FilterSummary struct { 784 785 // The time at which the filter was created. 786 CreationDateTime *time.Time 787 788 // The ARN of the dataset group to which the filter belongs. 789 DatasetGroupArn *string 790 791 // If the filter failed, the reason for the failure. 792 FailureReason *string 793 794 // The ARN of the filter. 795 FilterArn *string 796 797 // The time at which the filter was last updated. 798 LastUpdatedDateTime *time.Time 799 800 // The name of the filter. 801 Name *string 802 803 // The status of the filter. 804 Status *string 805} 806 807// Describes the properties for hyperparameter optimization (HPO). For use with the 808// bring-your-own-recipe feature. Do not use for Amazon Personalize native recipes. 809type HPOConfig struct { 810 811 // The hyperparameters and their allowable ranges. 812 AlgorithmHyperParameterRanges *HyperParameterRanges 813 814 // The metric to optimize during HPO. 815 HpoObjective *HPOObjective 816 817 // Describes the resource configuration for HPO. 818 HpoResourceConfig *HPOResourceConfig 819} 820 821// The metric to optimize during hyperparameter optimization (HPO). 822type HPOObjective struct { 823 824 // The name of the metric. 825 MetricName *string 826 827 // A regular expression for finding the metric in the training job logs. 828 MetricRegex *string 829 830 // The type of the metric. Valid values are Maximize and Minimize. 831 Type *string 832} 833 834// Describes the resource configuration for hyperparameter optimization (HPO). 835type HPOResourceConfig struct { 836 837 // The maximum number of training jobs when you create a solution version. The 838 // maximum value for maxNumberOfTrainingJobs is 40. 839 MaxNumberOfTrainingJobs *string 840 841 // The maximum number of parallel training jobs when you create a solution version. 842 // The maximum value for maxParallelTrainingJobs is 10. 843 MaxParallelTrainingJobs *string 844} 845 846// Specifies the hyperparameters and their ranges. Hyperparameters can be 847// categorical, continuous, or integer-valued. 848type HyperParameterRanges struct { 849 850 // The categorical hyperparameters and their ranges. 851 CategoricalHyperParameterRanges []CategoricalHyperParameterRange 852 853 // The continuous hyperparameters and their ranges. 854 ContinuousHyperParameterRanges []ContinuousHyperParameterRange 855 856 // The integer-valued hyperparameters and their ranges. 857 IntegerHyperParameterRanges []IntegerHyperParameterRange 858} 859 860// Provides the name and range of an integer-valued hyperparameter. 861type IntegerHyperParameterRange struct { 862 863 // The maximum allowable value for the hyperparameter. 864 MaxValue int32 865 866 // The minimum allowable value for the hyperparameter. 867 MinValue int32 868 869 // The name of the hyperparameter. 870 Name *string 871} 872 873// Provides information about a recipe. Each recipe provides an algorithm that 874// Amazon Personalize uses in model training when you use the CreateSolution 875// operation. 876type Recipe struct { 877 878 // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to 879 // train the model. 880 AlgorithmArn *string 881 882 // The date and time (in Unix format) that the recipe was created. 883 CreationDateTime *time.Time 884 885 // The description of the recipe. 886 Description *string 887 888 // The ARN of the FeatureTransformation object. 889 FeatureTransformationArn *string 890 891 // The date and time (in Unix format) that the recipe was last updated. 892 LastUpdatedDateTime *time.Time 893 894 // The name of the recipe. 895 Name *string 896 897 // The Amazon Resource Name (ARN) of the recipe. 898 RecipeArn *string 899 900 // One of the following values: 901 // 902 // * PERSONALIZED_RANKING 903 // 904 // * RELATED_ITEMS 905 // 906 // * 907 // USER_PERSONALIZATION 908 RecipeType *string 909 910 // The status of the recipe. 911 Status *string 912} 913 914// Provides a summary of the properties of a recipe. For a complete listing, call 915// the DescribeRecipe API. 916type RecipeSummary struct { 917 918 // The date and time (in Unix time) that the recipe was created. 919 CreationDateTime *time.Time 920 921 // The date and time (in Unix time) that the recipe was last updated. 922 LastUpdatedDateTime *time.Time 923 924 // The name of the recipe. 925 Name *string 926 927 // The Amazon Resource Name (ARN) of the recipe. 928 RecipeArn *string 929 930 // The status of the recipe. 931 Status *string 932} 933 934// The configuration details of an Amazon S3 input or output bucket. 935type S3DataConfig struct { 936 937 // The file path of the Amazon S3 bucket. 938 // 939 // This member is required. 940 Path *string 941 942 // The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key 943 // that Amazon Personalize uses to encrypt or decrypt the input and output files of 944 // a batch inference job. 945 KmsKeyArn *string 946} 947 948// An object that provides information about a solution. A solution is a trained 949// model that can be deployed as a campaign. 950type Solution struct { 951 952 // When performAutoML is true, specifies the best recipe found. 953 AutoMLResult *AutoMLResult 954 955 // The creation date and time (in Unix time) of the solution. 956 CreationDateTime *time.Time 957 958 // The Amazon Resource Name (ARN) of the dataset group that provides the training 959 // data. 960 DatasetGroupArn *string 961 962 // The event type (for example, 'click' or 'like') that is used for training the 963 // model. 964 EventType *string 965 966 // The date and time (in Unix time) that the solution was last updated. 967 LastUpdatedDateTime *time.Time 968 969 // Describes the latest version of the solution, including the status and the ARN. 970 LatestSolutionVersion *SolutionVersionSummary 971 972 // The name of the solution. 973 Name *string 974 975 // When true, Amazon Personalize performs a search for the best 976 // USER_PERSONALIZATION recipe from the list specified in the solution 977 // configuration (recipeArn must not be specified). When false (the default), 978 // Amazon Personalize uses recipeArn for training. 979 PerformAutoML bool 980 981 // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The 982 // default is false. 983 PerformHPO bool 984 985 // The ARN of the recipe used to create the solution. 986 RecipeArn *string 987 988 // The ARN of the solution. 989 SolutionArn *string 990 991 // Describes the configuration properties for the solution. 992 SolutionConfig *SolutionConfig 993 994 // The status of the solution. A solution can be in one of the following states: 995 // 996 // * 997 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 998 // 999 // * DELETE 1000 // PENDING > DELETE IN_PROGRESS 1001 Status *string 1002} 1003 1004// Describes the configuration properties for the solution. 1005type SolutionConfig struct { 1006 1007 // Lists the hyperparameter names and ranges. 1008 AlgorithmHyperParameters map[string]string 1009 1010 // The AutoMLConfig object containing a list of recipes to search when AutoML is 1011 // performed. 1012 AutoMLConfig *AutoMLConfig 1013 1014 // Only events with a value greater than or equal to this threshold are used for 1015 // training a model. 1016 EventValueThreshold *string 1017 1018 // Lists the feature transformation parameters. 1019 FeatureTransformationParameters map[string]string 1020 1021 // Describes the properties for hyperparameter optimization (HPO). 1022 HpoConfig *HPOConfig 1023} 1024 1025// Provides a summary of the properties of a solution. For a complete listing, call 1026// the DescribeSolution API. 1027type SolutionSummary struct { 1028 1029 // The date and time (in Unix time) that the solution was created. 1030 CreationDateTime *time.Time 1031 1032 // The date and time (in Unix time) that the solution was last updated. 1033 LastUpdatedDateTime *time.Time 1034 1035 // The name of the solution. 1036 Name *string 1037 1038 // The Amazon Resource Name (ARN) of the solution. 1039 SolutionArn *string 1040 1041 // The status of the solution. A solution can be in one of the following states: 1042 // 1043 // * 1044 // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED 1045 // 1046 // * DELETE 1047 // PENDING > DELETE IN_PROGRESS 1048 Status *string 1049} 1050 1051// An object that provides information about a specific version of a Solution. 1052type SolutionVersion struct { 1053 1054 // The date and time (in Unix time) that this version of the solution was created. 1055 CreationDateTime *time.Time 1056 1057 // The Amazon Resource Name (ARN) of the dataset group providing the training data. 1058 DatasetGroupArn *string 1059 1060 // The event type (for example, 'click' or 'like') that is used for training the 1061 // model. 1062 EventType *string 1063 1064 // If training a solution version fails, the reason for the failure. 1065 FailureReason *string 1066 1067 // The date and time (in Unix time) that the solution was last updated. 1068 LastUpdatedDateTime *time.Time 1069 1070 // When true, Amazon Personalize searches for the most optimal recipe according to 1071 // the solution configuration. When false (the default), Amazon Personalize uses 1072 // recipeArn. 1073 PerformAutoML bool 1074 1075 // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The 1076 // default is false. 1077 PerformHPO bool 1078 1079 // The ARN of the recipe used in the solution. 1080 RecipeArn *string 1081 1082 // The ARN of the solution. 1083 SolutionArn *string 1084 1085 // Describes the configuration properties for the solution. 1086 SolutionConfig *SolutionConfig 1087 1088 // The ARN of the solution version. 1089 SolutionVersionArn *string 1090 1091 // The status of the solution version. A solution version can be in one of the 1092 // following states: 1093 // 1094 // * CREATE PENDING 1095 // 1096 // * CREATE IN_PROGRESS 1097 // 1098 // * ACTIVE 1099 // 1100 // * CREATE 1101 // FAILED 1102 Status *string 1103 1104 // The time used to train the model. You are billed for the time it takes to train 1105 // a model. This field is visible only after Amazon Personalize successfully trains 1106 // a model. 1107 TrainingHours *float64 1108 1109 // The scope of training used to create the solution version. The FULL option 1110 // trains the solution version based on the entirety of the input solution's 1111 // training data, while the UPDATE option processes only the training data that has 1112 // changed since the creation of the last solution version. Choose UPDATE when you 1113 // want to start recommending items added to the dataset without retraining the 1114 // model. The UPDATE option can only be used after you've created a solution 1115 // version with the FULL option and the training solution uses the 1116 // native-recipe-hrnn-coldstart. 1117 TrainingMode TrainingMode 1118 1119 // If hyperparameter optimization was performed, contains the hyperparameter values 1120 // of the best performing model. 1121 TunedHPOParams *TunedHPOParams 1122} 1123 1124// Provides a summary of the properties of a solution version. For a complete 1125// listing, call the DescribeSolutionVersion API. 1126type SolutionVersionSummary struct { 1127 1128 // The date and time (in Unix time) that this version of a solution was created. 1129 CreationDateTime *time.Time 1130 1131 // If a solution version fails, the reason behind the failure. 1132 FailureReason *string 1133 1134 // The date and time (in Unix time) that the solution version was last updated. 1135 LastUpdatedDateTime *time.Time 1136 1137 // The Amazon Resource Name (ARN) of the solution version. 1138 SolutionVersionArn *string 1139 1140 // The status of the solution version. A solution version can be in one of the 1141 // following states: 1142 // 1143 // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE 1144 // FAILED 1145 Status *string 1146} 1147 1148// If hyperparameter optimization (HPO) was performed, contains the hyperparameter 1149// values of the best performing model. 1150type TunedHPOParams struct { 1151 1152 // A list of the hyperparameter values of the best performing model. 1153 AlgorithmHyperParameters map[string]string 1154} 1155