AWS.Tools.Personalize.XML
|
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 |
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Personalize</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSAlgorithmCmdlet"> <summary> Describes the given algorithm. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSAlgorithmCmdlet.AlgorithmArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the algorithm to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignCmdlet"> <summary> Describes the given campaign, including its status. <para> A campaign can be in one of the following states: </para><ul><li><para> CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED </para></li><li><para> DELETE PENDING > DELETE IN_PROGRESS </para></li></ul><para> When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the <code>failureReason</code> key, which describes why. </para><para> For more information on campaigns, see <a>CreateCampaign</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet"> <summary> Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see <a>CreateCampaign</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of campaigns to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSCampaignListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListCampaigns</code> for getting the next set of campaigns (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetCmdlet"> <summary> Describes the given dataset. For more information on datasets, see <a>CreateDataset</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupCmdlet"> <summary> Describes the given dataset group. For more information on dataset groups, see <a>CreateDatasetGroup</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet"> <summary> Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see <a>CreateDatasetGroup</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of dataset groups to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetGroupListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListDatasetGroups</code> for getting the next set of dataset groups (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobCmdlet"> <summary> Describes the dataset import job created by <a>CreateDatasetImportJob</a>, including the import job status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobCmdlet.DatasetImportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset import job to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet"> <summary> Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see <a>CreateDatasetImportJob</a>. For more information on datasets, see <a>CreateDataset</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of dataset import jobs to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetImportJobListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListDatasetImportJobs</code> for getting the next set of dataset import jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet"> <summary> Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see <a>CreateDataset</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of datasets to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSDatasetListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListDatasetImportJobs</code> for getting the next set of dataset import jobs (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerCmdlet"> <summary> Describes an event tracker. The response includes the <code>trackingId</code> and <code>status</code> of the event tracker. For more information on event trackers, see <a>CreateEventTracker</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerCmdlet.EventTrackerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the event tracker to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet"> <summary> Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see <a>CreateEventTracker</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of a dataset group used to filter the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of event trackers to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSEventTrackerListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListEventTrackers</code> for getting the next set of event trackers (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSFeatureTransformationCmdlet"> <summary> Describes the given feature transformation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSFeatureTransformationCmdlet.FeatureTransformationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the feature transformation to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeCmdlet"> <summary> Describes a recipe. <para> A recipe contains three items: </para><ul><li><para> An algorithm that trains a model. </para></li><li><para> Hyperparameters that govern the training. </para></li><li><para> Feature transformation information for modifying the input data before training. </para></li></ul><para> Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the <a>CreateSolution</a> API. <code>CreateSolution</code> trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeCmdlet.RecipeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recipe to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet"> <summary> Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.RecipeProvider"> <summary> <para> <para>The default is <code>SERVICE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recipes to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSRecipeListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListRecipes</code> for getting the next set of recipes (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaCmdlet"> <summary> Describes a schema. For more information on schemas, see <a>CreateSchema</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schema to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet"> <summary> Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see <a>CreateSchema</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of schemas to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSchemaListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListSchemas</code> for getting the next set of schemas (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionCmdlet"> <summary> Describes a solution. For more information on solutions, see <a>CreateSolution</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet"> <summary> Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see <a>CreateSolution</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of solutions to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListSolutions</code> for getting the next set of solutions (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionMetricCmdlet"> <summary> Gets the metrics for the specified solution version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionMetricCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version for which to get metrics.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionCmdlet"> <summary> Describes a specific version of a solution. For more information on solutions, see <a>CreateSolution</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet"> <summary> Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see <a>CreateSolution</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of solution versions to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.GetPERSSolutionVersionListCmdlet.NextToken"> <summary> <para> <para>A token returned from the previous call to <code>ListSolutionVersions</code> for getting the next set of solution versions (if they exist).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateCampaign </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.MinProvisionedTPS"> <summary> <para> <para>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Name"> <summary> <para> <para>A name for the new campaign. The campaign name must be unique within your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.SolutionVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution version to deploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateDataset </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to add the dataset to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.DatasetType"> <summary> <para> <para>The type of dataset.</para><para>One of the following (case insensitive) values:</para><ul><li><para>Interactions</para></li><li><para>Items</para></li><li><para>Users</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Name"> <summary> <para> <para>The name for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the schema to associate with the dataset. The schema defines the dataset fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateDatasetGroup </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Name"> <summary> <para> <para>The name for the new dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.RoleArn"> <summary> <para> <para>The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateDatasetImportJob </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.DataSource_DataLocation"> <summary> <para> <para>The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: </para><para><code>s3://bucket-name/training-data.csv</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.DatasetArn"> <summary> <para> <para>The ARN of the dataset that receives the imported data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.JobName"> <summary> <para> <para>The name for the dataset import job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.RoleArn"> <summary> <para> <para>The ARN of the IAM role that has permissions to read from the Amazon S3 data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSDatasetImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateEventTracker </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Name"> <summary> <para> <para>The name for the event tracker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSEventTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateSchema </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Name"> <summary> <para> <para>The name for the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Schema"> <summary> <para> <para>A schema in Avro JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateSolution </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_AlgorithmHyperParameter"> <summary> <para> <para>Lists the hyperparameter names and ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_CategoricalHyperParameterRange"> <summary> <para> <para>The categorical hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_ContinuousHyperParameterRange"> <summary> <para> <para>The continuous hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.EventType"> <summary> <para> <para>When your have multiple event types (using an <code>EVENT_TYPE</code> schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_EventValueThreshold"> <summary> <para> <para>Only events with a value greater than or equal to this threshold are used for training a model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.SolutionConfig_FeatureTransformationParameter"> <summary> <para> <para>Lists the feature transformation parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AlgorithmHyperParameterRanges_IntegerHyperParameterRange"> <summary> <para> <para>The integer-valued hyperparameters and their ranges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoResourceConfig_MaxNumberOfTrainingJob"> <summary> <para> <para>The maximum number of training jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoResourceConfig_MaxParallelTrainingJob"> <summary> <para> <para>The maximum number of parallel training jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AutoMLConfig_MetricName"> <summary> <para> <para>The metric to optimize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_MetricName"> <summary> <para> <para>The name of the metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_MetricRegex"> <summary> <para> <para>A regular expression for finding the metric in the training job logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Name"> <summary> <para> <para>The name for the solution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.PerformAutoML"> <summary> <para> <para>Whether to perform automated machine learning (AutoML). The default is <code>false</code>. For this case, you must specify <code>recipeArn</code>.</para><para>When set to <code>true</code>, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit <code>recipeArn</code>. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.PerformHPO"> <summary> <para> <para>Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is <code>false</code>.</para><para>When performing AutoML, this parameter is always <code>true</code> and you should not set it to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.RecipeArn"> <summary> <para> <para>The ARN of the recipe to use for model training. Only specified when <code>performAutoML</code> is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.AutoMLConfig_RecipeList"> <summary> <para> <para>The list of candidate recipes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.HpoObjective_Type"> <summary> <para> <para>The data type of the metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet"> <summary> Amazon.Personalize.IAmazonPersonalize.CreateSolutionVersion </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.SolutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the solution containing the training configuration information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.NewPERSSolutionVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet"> <summary> Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> request. For more information on campaigns, see <a>CreateCampaign</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.PassThru"> <summary> Returns the value passed to the CampaignArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet"> <summary> Deletes a dataset. You can't delete a dataset if an associated <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see <a>CreateDataset</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.PassThru"> <summary> Returns the value passed to the DatasetArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet"> <summary> Deletes a dataset group. Before you delete a dataset group, you must delete the following: <ul><li><para> All associated event trackers. </para></li><li><para> All associated solutions. </para></li><li><para> All datasets in the dataset group. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of the dataset group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.PassThru"> <summary> Returns the value passed to the DatasetGroupArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet"> <summary> Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see <a>CreateEventTracker</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.EventTrackerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the event tracker to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.PassThru"> <summary> Returns the value passed to the EventTrackerArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSEventTrackerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet"> <summary> Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see <a>CreateSchema</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the schema to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.PassThru"> <summary> Returns the value passed to the SchemaArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet"> <summary> Deletes all versions of a solution and the <code>Solution</code> object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call <a>ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see <a>CreateSolution</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.SolutionArn"> <summary> <para> <para>The ARN of the solution to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.PassThru"> <summary> Returns the value passed to the SolutionArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.RemovePERSSolutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet"> <summary> Updates a campaign by either deploying a new solution or changing the value of the campaign's <code>minProvisionedTPS</code> parameter. <para> To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the <a>DescribeCampaign</a> API. </para><note><para> You must wait until the <code>status</code> of the updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations. </para></note><para> For more information on campaigns, see <a>CreateCampaign</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.MinProvisionedTPS"> <summary> <para> <para>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.SolutionVersionArn"> <summary> <para> <para>The ARN of a new solution version to deploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERS.UpdatePERSCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |