aws-sdk-personalize 1.39.0 → 1.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -363,7 +363,11 @@ module Aws::Personalize
363
363
 
364
364
  # Creates a batch inference job. The operation can handle up to 50
365
365
  # million records and the input file must be in JSON format. For more
366
- # information, see recommendations-batch.
366
+ # information, see [Creating a batch inference job][1].
367
+ #
368
+ #
369
+ #
370
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html
367
371
  #
368
372
  # @option params [required, String] :job_name
369
373
  # The name of the batch inference job to create.
@@ -374,15 +378,15 @@ module Aws::Personalize
374
378
  #
375
379
  # @option params [String] :filter_arn
376
380
  # The ARN of the filter to apply to the batch inference job. For more
377
- # information on using filters, see [Filtering Batch
378
- # Recommendations][1]..
381
+ # information on using filters, see [Filtering batch
382
+ # recommendations][1].
379
383
  #
380
384
  #
381
385
  #
382
386
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
383
387
  #
384
388
  # @option params [Integer] :num_results
385
- # The number of recommendations to retreive.
389
+ # The number of recommendations to retrieve.
386
390
  #
387
391
  # @option params [required, Types::BatchInferenceJobInput] :job_input
388
392
  # The Amazon S3 path that leads to the input file to base your
@@ -400,6 +404,13 @@ module Aws::Personalize
400
404
  # @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
401
405
  # The configuration details of a batch inference job.
402
406
  #
407
+ # @option params [Array<Types::Tag>] :tags
408
+ # A list of [tags][1] to apply to the batch inference job.
409
+ #
410
+ #
411
+ #
412
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
413
+ #
403
414
  # @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
404
415
  #
405
416
  # * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
@@ -429,6 +440,12 @@ module Aws::Personalize
429
440
  # "ParameterName" => "ParameterValue",
430
441
  # },
431
442
  # },
443
+ # tags: [
444
+ # {
445
+ # tag_key: "TagKey", # required
446
+ # tag_value: "TagValue", # required
447
+ # },
448
+ # ],
432
449
  # })
433
450
  #
434
451
  # @example Response structure
@@ -446,7 +463,11 @@ module Aws::Personalize
446
463
 
447
464
  # Creates a batch segment job. The operation can handle up to 50 million
448
465
  # records and the input file must be in JSON format. For more
449
- # information, see recommendations-batch.
466
+ # information, see [Getting batch recommendations and user segments][1].
467
+ #
468
+ #
469
+ #
470
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html
450
471
  #
451
472
  # @option params [required, String] :job_name
452
473
  # The name of the batch segment job to create.
@@ -457,7 +478,12 @@ module Aws::Personalize
457
478
  #
458
479
  # @option params [String] :filter_arn
459
480
  # The ARN of the filter to apply to the batch segment job. For more
460
- # information on using filters, see filter-batch.
481
+ # information on using filters, see [Filtering batch
482
+ # recommendations][1].
483
+ #
484
+ #
485
+ #
486
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
461
487
  #
462
488
  # @option params [Integer] :num_results
463
489
  # The number of predicted users generated by the batch segment job for
@@ -476,6 +502,13 @@ module Aws::Personalize
476
502
  # permissions to read and write to your input and output Amazon S3
477
503
  # buckets respectively.
478
504
  #
505
+ # @option params [Array<Types::Tag>] :tags
506
+ # A list of [tags][1] to apply to the batch segment job.
507
+ #
508
+ #
509
+ #
510
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
511
+ #
479
512
  # @return [Types::CreateBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
480
513
  #
481
514
  # * {Types::CreateBatchSegmentJobResponse#batch_segment_job_arn #batch_segment_job_arn} => String
@@ -500,6 +533,12 @@ module Aws::Personalize
500
533
  # },
501
534
  # },
502
535
  # role_arn: "RoleArn", # required
536
+ # tags: [
537
+ # {
538
+ # tag_key: "TagKey", # required
539
+ # tag_value: "TagValue", # required
540
+ # },
541
+ # ],
503
542
  # })
504
543
  #
505
544
  # @example Response structure
@@ -548,7 +587,7 @@ module Aws::Personalize
548
587
  #
549
588
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
550
589
  #
551
- # To get the campaign status, call DescribeCampaign.
590
+ # To get the campaign status, call [DescribeCampaign][3].
552
591
  #
553
592
  # <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
554
593
  # campaign for recommendations.
@@ -557,18 +596,22 @@ module Aws::Personalize
557
596
  #
558
597
  # **Related APIs**
559
598
  #
560
- # * ListCampaigns
599
+ # * [ListCampaigns][4]
561
600
  #
562
- # * DescribeCampaign
601
+ # * [DescribeCampaign][3]
563
602
  #
564
- # * UpdateCampaign
603
+ # * [UpdateCampaign][5]
565
604
  #
566
- # * DeleteCampaign
605
+ # * [DeleteCampaign][6]
567
606
  #
568
607
  #
569
608
  #
570
609
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
571
610
  # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
611
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
612
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
613
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
614
+ # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html
572
615
  #
573
616
  # @option params [required, String] :name
574
617
  # A name for the new campaign. The campaign name must be unique within
@@ -584,6 +627,13 @@ module Aws::Personalize
584
627
  # @option params [Types::CampaignConfig] :campaign_config
585
628
  # The configuration details of a campaign.
586
629
  #
630
+ # @option params [Array<Types::Tag>] :tags
631
+ # A list of [tags][1] to apply to the campaign.
632
+ #
633
+ #
634
+ #
635
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
636
+ #
587
637
  # @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
588
638
  #
589
639
  # * {Types::CreateCampaignResponse#campaign_arn #campaign_arn} => String
@@ -599,6 +649,12 @@ module Aws::Personalize
599
649
  # "ParameterName" => "ParameterValue",
600
650
  # },
601
651
  # },
652
+ # tags: [
653
+ # {
654
+ # tag_key: "TagKey", # required
655
+ # tag_value: "TagValue", # required
656
+ # },
657
+ # ],
602
658
  # })
603
659
  #
604
660
  # @example Response structure
@@ -615,7 +671,8 @@ module Aws::Personalize
615
671
  end
616
672
 
617
673
  # Creates an empty dataset and adds it to the specified dataset group.
618
- # Use CreateDatasetImportJob to import your training data to a dataset.
674
+ # Use [CreateDatasetImportJob][1] to import your training data to a
675
+ # dataset.
619
676
  #
620
677
  # There are three types of datasets:
621
678
  #
@@ -636,17 +693,25 @@ module Aws::Personalize
636
693
  #
637
694
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
638
695
  #
639
- # To get the status of the dataset, call DescribeDataset.
696
+ # To get the status of the dataset, call [DescribeDataset][2].
640
697
  #
641
698
  # **Related APIs**
642
699
  #
643
- # * CreateDatasetGroup
700
+ # * [CreateDatasetGroup][3]
701
+ #
702
+ # * [ListDatasets][4]
703
+ #
704
+ # * [DescribeDataset][2]
644
705
  #
645
- # * ListDatasets
706
+ # * [DeleteDataset][5]
646
707
  #
647
- # * DescribeDataset
648
708
  #
649
- # * DeleteDataset
709
+ #
710
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
711
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html
712
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
713
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html
714
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html
650
715
  #
651
716
  # @option params [required, String] :name
652
717
  # The name for the dataset.
@@ -670,6 +735,13 @@ module Aws::Personalize
670
735
  #
671
736
  # * Users
672
737
  #
738
+ # @option params [Array<Types::Tag>] :tags
739
+ # A list of [tags][1] to apply to the dataset.
740
+ #
741
+ #
742
+ #
743
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
744
+ #
673
745
  # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
674
746
  #
675
747
  # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
@@ -681,6 +753,12 @@ module Aws::Personalize
681
753
  # schema_arn: "Arn", # required
682
754
  # dataset_group_arn: "Arn", # required
683
755
  # dataset_type: "DatasetType", # required
756
+ # tags: [
757
+ # {
758
+ # tag_key: "TagKey", # required
759
+ # tag_value: "TagValue", # required
760
+ # },
761
+ # ],
684
762
  # })
685
763
  #
686
764
  # @example Response structure
@@ -712,15 +790,17 @@ module Aws::Personalize
712
790
  #
713
791
  # ^
714
792
  #
715
- # To get the status of the export job, call DescribeDatasetExportJob,
716
- # and specify the Amazon Resource Name (ARN) of the dataset export job.
717
- # The dataset export is complete when the status shows as ACTIVE. If the
718
- # status shows as CREATE FAILED, the response includes a `failureReason`
719
- # key, which describes why the job failed.
793
+ # To get the status of the export job, call
794
+ # [DescribeDatasetExportJob][2], and specify the Amazon Resource Name
795
+ # (ARN) of the dataset export job. The dataset export is complete when
796
+ # the status shows as ACTIVE. If the status shows as CREATE FAILED, the
797
+ # response includes a `failureReason` key, which describes why the job
798
+ # failed.
720
799
  #
721
800
  #
722
801
  #
723
802
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/export-data.html
803
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html
724
804
  #
725
805
  # @option params [required, String] :job_name
726
806
  # The name for the dataset export job.
@@ -743,6 +823,13 @@ module Aws::Personalize
743
823
  # @option params [required, Types::DatasetExportJobOutput] :job_output
744
824
  # The path to the Amazon S3 bucket where the job's output is stored.
745
825
  #
826
+ # @option params [Array<Types::Tag>] :tags
827
+ # A list of [tags][1] to apply to the dataset export job.
828
+ #
829
+ #
830
+ #
831
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
832
+ #
746
833
  # @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
747
834
  #
748
835
  # * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
@@ -760,6 +847,12 @@ module Aws::Personalize
760
847
  # kms_key_arn: "KmsKeyArn",
761
848
  # },
762
849
  # },
850
+ # tags: [
851
+ # {
852
+ # tag_key: "TagKey", # required
853
+ # tag_value: "TagValue", # required
854
+ # },
855
+ # ],
763
856
  # })
764
857
  #
765
858
  # @example Response structure
@@ -800,9 +893,10 @@ module Aws::Personalize
800
893
  #
801
894
  # * DELETE PENDING
802
895
  #
803
- # To get the status of the dataset group, call DescribeDatasetGroup. If
804
- # the status shows as CREATE FAILED, the response includes a
805
- # `failureReason` key, which describes why the creation failed.
896
+ # To get the status of the dataset group, call
897
+ # [DescribeDatasetGroup][1]. If the status shows as CREATE FAILED, the
898
+ # response includes a `failureReason` key, which describes why the
899
+ # creation failed.
806
900
  #
807
901
  # <note markdown="1"> You must wait until the `status` of the dataset group is `ACTIVE`
808
902
  # before adding a dataset to the group.
@@ -816,19 +910,28 @@ module Aws::Personalize
816
910
  #
817
911
  # **APIs that require a dataset group ARN in the request**
818
912
  #
819
- # * CreateDataset
913
+ # * [CreateDataset][2]
820
914
  #
821
- # * CreateEventTracker
915
+ # * [CreateEventTracker][3]
822
916
  #
823
- # * CreateSolution
917
+ # * [CreateSolution][4]
824
918
  #
825
919
  # **Related APIs**
826
920
  #
827
- # * ListDatasetGroups
921
+ # * [ListDatasetGroups][5]
922
+ #
923
+ # * [DescribeDatasetGroup][1]
924
+ #
925
+ # * [DeleteDatasetGroup][6]
926
+ #
828
927
  #
829
- # * DescribeDatasetGroup
830
928
  #
831
- # * DeleteDatasetGroup
929
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html
930
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
931
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
932
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
933
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html
934
+ # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html
832
935
  #
833
936
  # @option params [required, String] :name
834
937
  # The name for the new dataset group.
@@ -849,6 +952,13 @@ module Aws::Personalize
849
952
  # don't specify a domain, you create a Custom dataset group with
850
953
  # solution versions that you deploy with a campaign.
851
954
  #
955
+ # @option params [Array<Types::Tag>] :tags
956
+ # A list of [tags][1] to apply to the dataset group.
957
+ #
958
+ #
959
+ #
960
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
961
+ #
852
962
  # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
853
963
  #
854
964
  # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
@@ -861,6 +971,12 @@ module Aws::Personalize
861
971
  # role_arn: "RoleArn",
862
972
  # kms_key_arn: "KmsKeyArn",
863
973
  # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
974
+ # tags: [
975
+ # {
976
+ # tag_key: "TagKey", # required
977
+ # tag_value: "TagValue", # required
978
+ # },
979
+ # ],
864
980
  # })
865
981
  #
866
982
  # @example Response structure
@@ -898,11 +1014,12 @@ module Aws::Personalize
898
1014
  #
899
1015
  # ^
900
1016
  #
901
- # To get the status of the import job, call DescribeDatasetImportJob,
902
- # providing the Amazon Resource Name (ARN) of the dataset import job.
903
- # The dataset import is complete when the status shows as ACTIVE. If the
904
- # status shows as CREATE FAILED, the response includes a `failureReason`
905
- # key, which describes why the job failed.
1017
+ # To get the status of the import job, call
1018
+ # [DescribeDatasetImportJob][2], providing the Amazon Resource Name
1019
+ # (ARN) of the dataset import job. The dataset import is complete when
1020
+ # the status shows as ACTIVE. If the status shows as CREATE FAILED, the
1021
+ # response includes a `failureReason` key, which describes why the job
1022
+ # failed.
906
1023
  #
907
1024
  # <note markdown="1"> Importing takes time. You must wait until the status shows as ACTIVE
908
1025
  # before training a model using the dataset.
@@ -911,13 +1028,15 @@ module Aws::Personalize
911
1028
  #
912
1029
  # **Related APIs**
913
1030
  #
914
- # * ListDatasetImportJobs
1031
+ # * [ListDatasetImportJobs][3]
915
1032
  #
916
- # * DescribeDatasetImportJob
1033
+ # * [DescribeDatasetImportJob][2]
917
1034
  #
918
1035
  #
919
1036
  #
920
1037
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
1038
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
1039
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html
921
1040
  #
922
1041
  # @option params [required, String] :job_name
923
1042
  # The name for the dataset import job.
@@ -932,6 +1051,13 @@ module Aws::Personalize
932
1051
  # The ARN of the IAM role that has permissions to read from the Amazon
933
1052
  # S3 data source.
934
1053
  #
1054
+ # @option params [Array<Types::Tag>] :tags
1055
+ # A list of [tags][1] to apply to the dataset import job.
1056
+ #
1057
+ #
1058
+ #
1059
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1060
+ #
935
1061
  # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
936
1062
  #
937
1063
  # * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
@@ -945,6 +1071,12 @@ module Aws::Personalize
945
1071
  # data_location: "S3Location",
946
1072
  # },
947
1073
  # role_arn: "RoleArn", # required
1074
+ # tags: [
1075
+ # {
1076
+ # tag_key: "TagKey", # required
1077
+ # tag_value: "TagValue", # required
1078
+ # },
1079
+ # ],
948
1080
  # })
949
1081
  #
950
1082
  # @example Response structure
@@ -982,7 +1114,8 @@ module Aws::Personalize
982
1114
  #
983
1115
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
984
1116
  #
985
- # To get the status of the event tracker, call DescribeEventTracker.
1117
+ # To get the status of the event tracker, call
1118
+ # [DescribeEventTracker][2].
986
1119
  #
987
1120
  # <note markdown="1"> The event tracker must be in the ACTIVE state before using the
988
1121
  # tracking ID.
@@ -991,15 +1124,18 @@ module Aws::Personalize
991
1124
  #
992
1125
  # **Related APIs**
993
1126
  #
994
- # * ListEventTrackers
1127
+ # * [ListEventTrackers][3]
995
1128
  #
996
- # * DescribeEventTracker
1129
+ # * [DescribeEventTracker][2]
997
1130
  #
998
- # * DeleteEventTracker
1131
+ # * [DeleteEventTracker][4]
999
1132
  #
1000
1133
  #
1001
1134
  #
1002
1135
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html
1136
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html
1137
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html
1138
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html
1003
1139
  #
1004
1140
  # @option params [required, String] :name
1005
1141
  # The name for the event tracker.
@@ -1008,6 +1144,13 @@ module Aws::Personalize
1008
1144
  # The Amazon Resource Name (ARN) of the dataset group that receives the
1009
1145
  # event data.
1010
1146
  #
1147
+ # @option params [Array<Types::Tag>] :tags
1148
+ # A list of [tags][1] to apply to the event tracker.
1149
+ #
1150
+ #
1151
+ #
1152
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1153
+ #
1011
1154
  # @return [Types::CreateEventTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1012
1155
  #
1013
1156
  # * {Types::CreateEventTrackerResponse#event_tracker_arn #event_tracker_arn} => String
@@ -1018,6 +1161,12 @@ module Aws::Personalize
1018
1161
  # resp = client.create_event_tracker({
1019
1162
  # name: "Name", # required
1020
1163
  # dataset_group_arn: "Arn", # required
1164
+ # tags: [
1165
+ # {
1166
+ # tag_key: "TagKey", # required
1167
+ # tag_value: "TagValue", # required
1168
+ # },
1169
+ # ],
1021
1170
  # })
1022
1171
  #
1023
1172
  # @example Response structure
@@ -1034,7 +1183,12 @@ module Aws::Personalize
1034
1183
  req.send_request(options)
1035
1184
  end
1036
1185
 
1037
- # Creates a recommendation filter. For more information, see filter.
1186
+ # Creates a recommendation filter. For more information, see [Filtering
1187
+ # recommendations and user segments][1].
1188
+ #
1189
+ #
1190
+ #
1191
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
1038
1192
  #
1039
1193
  # @option params [required, String] :name
1040
1194
  # The name of the filter to create.
@@ -1046,7 +1200,18 @@ module Aws::Personalize
1046
1200
  # The filter expression defines which items are included or excluded
1047
1201
  # from recommendations. Filter expression must follow specific format
1048
1202
  # rules. For information about filter expression structure and syntax,
1049
- # see filter-expressions.
1203
+ # see [Filter expressions][1].
1204
+ #
1205
+ #
1206
+ #
1207
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html
1208
+ #
1209
+ # @option params [Array<Types::Tag>] :tags
1210
+ # A list of [tags][1] to apply to the filter.
1211
+ #
1212
+ #
1213
+ #
1214
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1050
1215
  #
1051
1216
  # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1052
1217
  #
@@ -1058,6 +1223,12 @@ module Aws::Personalize
1058
1223
  # name: "Name", # required
1059
1224
  # dataset_group_arn: "Arn", # required
1060
1225
  # filter_expression: "FilterExpression", # required
1226
+ # tags: [
1227
+ # {
1228
+ # tag_key: "TagKey", # required
1229
+ # tag_value: "TagValue", # required
1230
+ # },
1231
+ # ],
1061
1232
  # })
1062
1233
  #
1063
1234
  # @example Response structure
@@ -1113,7 +1284,7 @@ module Aws::Personalize
1113
1284
  #
1114
1285
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1115
1286
  #
1116
- # To get the recommender status, call DescribeRecommender.
1287
+ # To get the recommender status, call [DescribeRecommender][2].
1117
1288
  #
1118
1289
  # <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
1119
1290
  # the recommender for recommendations.
@@ -1122,17 +1293,21 @@ module Aws::Personalize
1122
1293
  #
1123
1294
  # **Related APIs**
1124
1295
  #
1125
- # * ListRecommenders
1296
+ # * [ListRecommenders][3]
1126
1297
  #
1127
- # * DescribeRecommender
1298
+ # * [DescribeRecommender][2]
1128
1299
  #
1129
- # * UpdateRecommender
1300
+ # * [UpdateRecommender][4]
1130
1301
  #
1131
- # * DeleteRecommender
1302
+ # * [DeleteRecommender][5]
1132
1303
  #
1133
1304
  #
1134
1305
  #
1135
1306
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1307
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html
1308
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html
1309
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html
1310
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html
1136
1311
  #
1137
1312
  # @option params [required, String] :name
1138
1313
  # The name of the recommender.
@@ -1155,6 +1330,13 @@ module Aws::Personalize
1155
1330
  # @option params [Types::RecommenderConfig] :recommender_config
1156
1331
  # The configuration details of the recommender.
1157
1332
  #
1333
+ # @option params [Array<Types::Tag>] :tags
1334
+ # A list of [tags][1] to apply to the recommender.
1335
+ #
1336
+ #
1337
+ #
1338
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1339
+ #
1158
1340
  # @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1159
1341
  #
1160
1342
  # * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
@@ -1171,6 +1353,12 @@ module Aws::Personalize
1171
1353
  # },
1172
1354
  # min_recommendation_requests_per_second: 1,
1173
1355
  # },
1356
+ # tags: [
1357
+ # {
1358
+ # tag_key: "TagKey", # required
1359
+ # tag_value: "TagValue", # required
1360
+ # },
1361
+ # ],
1174
1362
  # })
1175
1363
  #
1176
1364
  # @example Response structure
@@ -1193,15 +1381,22 @@ module Aws::Personalize
1193
1381
  # associated with a dataset type and has a set of required field and
1194
1382
  # keywords. If you are creating a schema for a dataset in a Domain
1195
1383
  # dataset group, you provide the domain of the Domain dataset group. You
1196
- # specify a schema when you call CreateDataset.
1384
+ # specify a schema when you call [CreateDataset][1].
1197
1385
  #
1198
1386
  # **Related APIs**
1199
1387
  #
1200
- # * ListSchemas
1388
+ # * [ListSchemas][2]
1389
+ #
1390
+ # * [DescribeSchema][3]
1391
+ #
1392
+ # * [DeleteSchema][4]
1393
+ #
1201
1394
  #
1202
- # * DescribeSchema
1203
1395
  #
1204
- # * DeleteSchema
1396
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
1397
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html
1398
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html
1399
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html
1205
1400
  #
1206
1401
  # @option params [required, String] :name
1207
1402
  # The name for the schema.
@@ -1241,14 +1436,14 @@ module Aws::Personalize
1241
1436
 
1242
1437
  # Creates the configuration for training a model. A trained model is
1243
1438
  # known as a solution. After the configuration is created, you train the
1244
- # model (create a solution) by calling the CreateSolutionVersion
1439
+ # model (create a solution) by calling the [CreateSolutionVersion][1]
1245
1440
  # operation. Every time you call `CreateSolutionVersion`, a new version
1246
1441
  # of the solution is created.
1247
1442
  #
1248
1443
  # After creating a solution version, you check its accuracy by calling
1249
- # GetSolutionMetrics. When you are satisfied with the version, you
1250
- # deploy it using CreateCampaign. The campaign provides recommendations
1251
- # to a client through the [GetRecommendations][1] API.
1444
+ # [GetSolutionMetrics][2]. When you are satisfied with the version, you
1445
+ # deploy it using [CreateCampaign][3]. The campaign provides
1446
+ # recommendations to a client through the [GetRecommendations][4] API.
1252
1447
  #
1253
1448
  # To train a model, Amazon Personalize requires training data and a
1254
1449
  # recipe. The training data comes from the dataset group that you
@@ -1272,27 +1467,36 @@ module Aws::Personalize
1272
1467
  #
1273
1468
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1274
1469
  #
1275
- # To get the status of the solution, call DescribeSolution. Wait until
1276
- # the status shows as ACTIVE before calling `CreateSolutionVersion`.
1470
+ # To get the status of the solution, call [DescribeSolution][5]. Wait
1471
+ # until the status shows as ACTIVE before calling
1472
+ # `CreateSolutionVersion`.
1277
1473
  #
1278
1474
  # **Related APIs**
1279
1475
  #
1280
- # * ListSolutions
1476
+ # * [ListSolutions][6]
1281
1477
  #
1282
- # * CreateSolutionVersion
1478
+ # * [CreateSolutionVersion][1]
1283
1479
  #
1284
- # * DescribeSolution
1480
+ # * [DescribeSolution][5]
1285
1481
  #
1286
- # * DeleteSolution
1482
+ # * [DeleteSolution][7]
1287
1483
  # ^
1288
1484
  #
1289
- # * ListSolutionVersions
1485
+ # * [ListSolutionVersions][8]
1290
1486
  #
1291
- # * DescribeSolutionVersion
1487
+ # * [DescribeSolutionVersion][9]
1292
1488
  #
1293
1489
  #
1294
1490
  #
1295
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1491
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html
1492
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html
1493
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
1494
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1495
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
1496
+ # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
1497
+ # [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
1498
+ # [8]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1499
+ # [9]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1296
1500
  #
1297
1501
  # @option params [required, String] :name
1298
1502
  # The name for the solution.
@@ -1341,6 +1545,13 @@ module Aws::Personalize
1341
1545
  #
1342
1546
  # </note>
1343
1547
  #
1548
+ # @option params [Array<Types::Tag>] :tags
1549
+ # A list of [tags][1] to apply to the solution.
1550
+ #
1551
+ #
1552
+ #
1553
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1554
+ #
1344
1555
  # @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1345
1556
  #
1346
1557
  # * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
@@ -1404,6 +1615,12 @@ module Aws::Personalize
1404
1615
  # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
1405
1616
  # },
1406
1617
  # },
1618
+ # tags: [
1619
+ # {
1620
+ # tag_key: "TagKey", # required
1621
+ # tag_value: "TagValue", # required
1622
+ # },
1623
+ # ],
1407
1624
  # })
1408
1625
  #
1409
1626
  # @example Response structure
@@ -1420,9 +1637,9 @@ module Aws::Personalize
1420
1637
  end
1421
1638
 
1422
1639
  # Trains or retrains an active solution in a Custom dataset group. A
1423
- # solution is created using the CreateSolution operation and must be in
1424
- # the ACTIVE state before calling `CreateSolutionVersion`. A new version
1425
- # of the solution is created every time you call this operation.
1640
+ # solution is created using the [CreateSolution][1] operation and must
1641
+ # be in the ACTIVE state before calling `CreateSolutionVersion`. A new
1642
+ # version of the solution is created every time you call this operation.
1426
1643
  #
1427
1644
  # **Status**
1428
1645
  #
@@ -1440,26 +1657,34 @@ module Aws::Personalize
1440
1657
  #
1441
1658
  # * CREATE STOPPED
1442
1659
  #
1443
- # To get the status of the version, call DescribeSolutionVersion. Wait
1444
- # until the status shows as ACTIVE before calling `CreateCampaign`.
1660
+ # To get the status of the version, call [DescribeSolutionVersion][2].
1661
+ # Wait until the status shows as ACTIVE before calling `CreateCampaign`.
1445
1662
  #
1446
1663
  # If the status shows as CREATE FAILED, the response includes a
1447
1664
  # `failureReason` key, which describes why the job failed.
1448
1665
  #
1449
1666
  # **Related APIs**
1450
1667
  #
1451
- # * ListSolutionVersions
1668
+ # * [ListSolutionVersions][3]
1452
1669
  #
1453
- # * DescribeSolutionVersion
1454
- # ^
1670
+ # * [DescribeSolutionVersion][2]
1671
+ #
1672
+ # * [ListSolutions][4]
1673
+ #
1674
+ # * [CreateSolution][1]
1675
+ #
1676
+ # * [DescribeSolution][5]
1455
1677
  #
1456
- # * ListSolutions
1678
+ # * [DeleteSolution][6]
1457
1679
  #
1458
- # * CreateSolution
1459
1680
  #
1460
- # * DescribeSolution
1461
1681
  #
1462
- # * DeleteSolution
1682
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
1683
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1684
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1685
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
1686
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
1687
+ # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
1463
1688
  #
1464
1689
  # @option params [required, String] :solution_arn
1465
1690
  # The Amazon Resource Name (ARN) of the solution containing the training
@@ -1483,6 +1708,13 @@ module Aws::Personalize
1483
1708
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
1484
1709
  # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
1485
1710
  #
1711
+ # @option params [Array<Types::Tag>] :tags
1712
+ # A list of [tags][1] to apply to the solution version.
1713
+ #
1714
+ #
1715
+ #
1716
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1717
+ #
1486
1718
  # @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1487
1719
  #
1488
1720
  # * {Types::CreateSolutionVersionResponse#solution_version_arn #solution_version_arn} => String
@@ -1492,6 +1724,12 @@ module Aws::Personalize
1492
1724
  # resp = client.create_solution_version({
1493
1725
  # solution_arn: "Arn", # required
1494
1726
  # training_mode: "FULL", # accepts FULL, UPDATE
1727
+ # tags: [
1728
+ # {
1729
+ # tag_key: "TagKey", # required
1730
+ # tag_value: "TagValue", # required
1731
+ # },
1732
+ # ],
1495
1733
  # })
1496
1734
  #
1497
1735
  # @example Response structure
@@ -1510,12 +1748,13 @@ module Aws::Personalize
1510
1748
  # Removes a campaign by deleting the solution deployment. The solution
1511
1749
  # that the campaign is based on is not deleted and can be redeployed
1512
1750
  # when needed. A deleted campaign can no longer be specified in a
1513
- # [GetRecommendations][1] request. For more information on campaigns,
1514
- # see CreateCampaign.
1751
+ # [GetRecommendations][1] request. For information on creating
1752
+ # campaigns, see [CreateCampaign][2].
1515
1753
  #
1516
1754
  #
1517
1755
  #
1518
1756
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1757
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
1519
1758
  #
1520
1759
  # @option params [required, String] :campaign_arn
1521
1760
  # The Amazon Resource Name (ARN) of the campaign to delete.
@@ -1539,7 +1778,12 @@ module Aws::Personalize
1539
1778
 
1540
1779
  # Deletes a dataset. You can't delete a dataset if an associated
1541
1780
  # `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN
1542
- # PROGRESS state. For more information on datasets, see CreateDataset.
1781
+ # PROGRESS state. For more information on datasets, see
1782
+ # [CreateDataset][1].
1783
+ #
1784
+ #
1785
+ #
1786
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
1543
1787
  #
1544
1788
  # @option params [required, String] :dataset_arn
1545
1789
  # The Amazon Resource Name (ARN) of the dataset to delete.
@@ -1592,7 +1836,11 @@ module Aws::Personalize
1592
1836
 
1593
1837
  # Deletes the event tracker. Does not delete the event-interactions
1594
1838
  # dataset from the associated dataset group. For more information on
1595
- # event trackers, see CreateEventTracker.
1839
+ # event trackers, see [CreateEventTracker][1].
1840
+ #
1841
+ #
1842
+ #
1843
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
1596
1844
  #
1597
1845
  # @option params [required, String] :event_tracker_arn
1598
1846
  # The Amazon Resource Name (ARN) of the event tracker to delete.
@@ -1665,7 +1913,11 @@ module Aws::Personalize
1665
1913
 
1666
1914
  # Deletes a schema. Before deleting a schema, you must delete all
1667
1915
  # datasets referencing the schema. For more information on schemas, see
1668
- # CreateSchema.
1916
+ # [CreateSchema][1].
1917
+ #
1918
+ #
1919
+ #
1920
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
1669
1921
  #
1670
1922
  # @option params [required, String] :schema_arn
1671
1923
  # The Amazon Resource Name (ARN) of the schema to delete.
@@ -1690,10 +1942,15 @@ module Aws::Personalize
1690
1942
  # Deletes all versions of a solution and the `Solution` object itself.
1691
1943
  # Before deleting a solution, you must delete all campaigns based on the
1692
1944
  # solution. To determine what campaigns are using the solution, call
1693
- # ListCampaigns and supply the Amazon Resource Name (ARN) of the
1945
+ # [ListCampaigns][1] and supply the Amazon Resource Name (ARN) of the
1694
1946
  # solution. You can't delete a solution if an associated
1695
1947
  # `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For
1696
- # more information on solutions, see CreateSolution.
1948
+ # more information on solutions, see [CreateSolution][2].
1949
+ #
1950
+ #
1951
+ #
1952
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
1953
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
1697
1954
  #
1698
1955
  # @option params [required, String] :solution_arn
1699
1956
  # The ARN of the solution to delete.
@@ -1869,7 +2126,11 @@ module Aws::Personalize
1869
2126
  # When the `status` is `CREATE FAILED`, the response includes the
1870
2127
  # `failureReason` key, which describes why.
1871
2128
  #
1872
- # For more information on campaigns, see CreateCampaign.
2129
+ # For more information on campaigns, see [CreateCampaign][1].
2130
+ #
2131
+ #
2132
+ #
2133
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
1873
2134
  #
1874
2135
  # @option params [required, String] :campaign_arn
1875
2136
  # The Amazon Resource Name (ARN) of the campaign.
@@ -1915,7 +2176,11 @@ module Aws::Personalize
1915
2176
  end
1916
2177
 
1917
2178
  # Describes the given dataset. For more information on datasets, see
1918
- # CreateDataset.
2179
+ # [CreateDataset][1].
2180
+ #
2181
+ #
2182
+ #
2183
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
1919
2184
  #
1920
2185
  # @option params [required, String] :dataset_arn
1921
2186
  # The Amazon Resource Name (ARN) of the dataset to describe.
@@ -1950,8 +2215,12 @@ module Aws::Personalize
1950
2215
  req.send_request(options)
1951
2216
  end
1952
2217
 
1953
- # Describes the dataset export job created by CreateDatasetExportJob,
1954
- # including the export job status.
2218
+ # Describes the dataset export job created by
2219
+ # [CreateDatasetExportJob][1], including the export job status.
2220
+ #
2221
+ #
2222
+ #
2223
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html
1955
2224
  #
1956
2225
  # @option params [required, String] :dataset_export_job_arn
1957
2226
  # The Amazon Resource Name (ARN) of the dataset export job to describe.
@@ -1990,7 +2259,11 @@ module Aws::Personalize
1990
2259
  end
1991
2260
 
1992
2261
  # Describes the given dataset group. For more information on dataset
1993
- # groups, see CreateDatasetGroup.
2262
+ # groups, see [CreateDatasetGroup][1].
2263
+ #
2264
+ #
2265
+ #
2266
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
1994
2267
  #
1995
2268
  # @option params [required, String] :dataset_group_arn
1996
2269
  # The Amazon Resource Name (ARN) of the dataset group to describe.
@@ -2026,8 +2299,12 @@ module Aws::Personalize
2026
2299
  req.send_request(options)
2027
2300
  end
2028
2301
 
2029
- # Describes the dataset import job created by CreateDatasetImportJob,
2030
- # including the import job status.
2302
+ # Describes the dataset import job created by
2303
+ # [CreateDatasetImportJob][1], including the import job status.
2304
+ #
2305
+ #
2306
+ #
2307
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
2031
2308
  #
2032
2309
  # @option params [required, String] :dataset_import_job_arn
2033
2310
  # The Amazon Resource Name (ARN) of the dataset import job to describe.
@@ -2065,7 +2342,11 @@ module Aws::Personalize
2065
2342
 
2066
2343
  # Describes an event tracker. The response includes the `trackingId` and
2067
2344
  # `status` of the event tracker. For more information on event trackers,
2068
- # see CreateEventTracker.
2345
+ # see [CreateEventTracker][1].
2346
+ #
2347
+ #
2348
+ #
2349
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
2069
2350
  #
2070
2351
  # @option params [required, String] :event_tracker_arn
2071
2352
  # The Amazon Resource Name (ARN) of the event tracker to describe.
@@ -2182,15 +2463,16 @@ module Aws::Personalize
2182
2463
  # before training.
2183
2464
  #
2184
2465
  # Amazon Personalize provides a set of predefined recipes. You specify a
2185
- # recipe when you create a solution with the CreateSolution API.
2466
+ # recipe when you create a solution with the [CreateSolution][1] API.
2186
2467
  # `CreateSolution` trains a model by using the algorithm in the
2187
2468
  # specified recipe and a training dataset. The solution, when deployed
2188
2469
  # as a campaign, can provide recommendations using the
2189
- # [GetRecommendations][1] API.
2470
+ # [GetRecommendations][2] API.
2190
2471
  #
2191
2472
  #
2192
2473
  #
2193
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
2474
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
2475
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
2194
2476
  #
2195
2477
  # @option params [required, String] :recipe_arn
2196
2478
  # The Amazon Resource Name (ARN) of the recipe to describe.
@@ -2287,7 +2569,12 @@ module Aws::Personalize
2287
2569
  req.send_request(options)
2288
2570
  end
2289
2571
 
2290
- # Describes a schema. For more information on schemas, see CreateSchema.
2572
+ # Describes a schema. For more information on schemas, see
2573
+ # [CreateSchema][1].
2574
+ #
2575
+ #
2576
+ #
2577
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
2291
2578
  #
2292
2579
  # @option params [required, String] :schema_arn
2293
2580
  # The Amazon Resource Name (ARN) of the schema to retrieve.
@@ -2321,7 +2608,11 @@ module Aws::Personalize
2321
2608
  end
2322
2609
 
2323
2610
  # Describes a solution. For more information on solutions, see
2324
- # CreateSolution.
2611
+ # [CreateSolution][1].
2612
+ #
2613
+ #
2614
+ #
2615
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
2325
2616
  #
2326
2617
  # @option params [required, String] :solution_arn
2327
2618
  # The Amazon Resource Name (ARN) of the solution to describe.
@@ -2392,7 +2683,11 @@ module Aws::Personalize
2392
2683
  end
2393
2684
 
2394
2685
  # Describes a specific version of a solution. For more information on
2395
- # solutions, see CreateSolution.
2686
+ # solutions, see [CreateSolution][1]
2687
+ #
2688
+ #
2689
+ #
2690
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
2396
2691
  #
2397
2692
  # @option params [required, String] :solution_version_arn
2398
2693
  # The Amazon Resource Name (ARN) of the solution version.
@@ -2597,7 +2892,11 @@ module Aws::Personalize
2597
2892
  # solution is not specified, all the campaigns associated with the
2598
2893
  # account are listed. The response provides the properties for each
2599
2894
  # campaign, including the Amazon Resource Name (ARN). For more
2600
- # information on campaigns, see CreateCampaign.
2895
+ # information on campaigns, see [CreateCampaign][1].
2896
+ #
2897
+ #
2898
+ #
2899
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
2601
2900
  #
2602
2901
  # @option params [String] :solution_arn
2603
2902
  # The Amazon Resource Name (ARN) of the solution to list the campaigns
@@ -2605,8 +2904,12 @@ module Aws::Personalize
2605
2904
  # with the account are listed.
2606
2905
  #
2607
2906
  # @option params [String] :next_token
2608
- # A token returned from the previous call to `ListCampaigns` for getting
2609
- # the next set of campaigns (if they exist).
2907
+ # A token returned from the previous call to [ListCampaigns][1] for
2908
+ # getting the next set of campaigns (if they exist).
2909
+ #
2910
+ #
2911
+ #
2912
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
2610
2913
  #
2611
2914
  # @option params [Integer] :max_results
2612
2915
  # The maximum number of campaigns to return.
@@ -2650,8 +2953,14 @@ module Aws::Personalize
2650
2953
  # a dataset is not specified, all the dataset export jobs associated
2651
2954
  # with the account are listed. The response provides the properties for
2652
2955
  # each dataset export job, including the Amazon Resource Name (ARN). For
2653
- # more information on dataset export jobs, see CreateDatasetExportJob.
2654
- # For more information on datasets, see CreateDataset.
2956
+ # more information on dataset export jobs, see
2957
+ # [CreateDatasetExportJob][1]. For more information on datasets, see
2958
+ # [CreateDataset][2].
2959
+ #
2960
+ #
2961
+ #
2962
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html
2963
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
2655
2964
  #
2656
2965
  # @option params [String] :dataset_arn
2657
2966
  # The Amazon Resource Name (ARN) of the dataset to list the dataset
@@ -2701,7 +3010,11 @@ module Aws::Personalize
2701
3010
 
2702
3011
  # Returns a list of dataset groups. The response provides the properties
2703
3012
  # for each dataset group, including the Amazon Resource Name (ARN). For
2704
- # more information on dataset groups, see CreateDatasetGroup.
3013
+ # more information on dataset groups, see [CreateDatasetGroup][1].
3014
+ #
3015
+ #
3016
+ #
3017
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
2705
3018
  #
2706
3019
  # @option params [String] :next_token
2707
3020
  # A token returned from the previous call to `ListDatasetGroups` for
@@ -2749,8 +3062,14 @@ module Aws::Personalize
2749
3062
  # a dataset is not specified, all the dataset import jobs associated
2750
3063
  # with the account are listed. The response provides the properties for
2751
3064
  # each dataset import job, including the Amazon Resource Name (ARN). For
2752
- # more information on dataset import jobs, see CreateDatasetImportJob.
2753
- # For more information on datasets, see CreateDataset.
3065
+ # more information on dataset import jobs, see
3066
+ # [CreateDatasetImportJob][1]. For more information on datasets, see
3067
+ # [CreateDataset][2].
3068
+ #
3069
+ #
3070
+ #
3071
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
3072
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
2754
3073
  #
2755
3074
  # @option params [String] :dataset_arn
2756
3075
  # The Amazon Resource Name (ARN) of the dataset to list the dataset
@@ -2801,7 +3120,11 @@ module Aws::Personalize
2801
3120
  # Returns the list of datasets contained in the given dataset group. The
2802
3121
  # response provides the properties for each dataset, including the
2803
3122
  # Amazon Resource Name (ARN). For more information on datasets, see
2804
- # CreateDataset.
3123
+ # [CreateDataset][1].
3124
+ #
3125
+ #
3126
+ #
3127
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
2805
3128
  #
2806
3129
  # @option params [String] :dataset_group_arn
2807
3130
  # The Amazon Resource Name (ARN) of the dataset group that contains the
@@ -2852,7 +3175,11 @@ module Aws::Personalize
2852
3175
  # Returns the list of event trackers associated with the account. The
2853
3176
  # response provides the properties for each event tracker, including the
2854
3177
  # Amazon Resource Name (ARN) and tracking ID. For more information on
2855
- # event trackers, see CreateEventTracker.
3178
+ # event trackers, see [CreateEventTracker][1].
3179
+ #
3180
+ #
3181
+ #
3182
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
2856
3183
  #
2857
3184
  # @option params [String] :dataset_group_arn
2858
3185
  # The ARN of a dataset group used to filter the response.
@@ -2963,8 +3290,8 @@ module Aws::Personalize
2963
3290
  # @option params [String] :domain
2964
3291
  # Filters returned recipes by domain for a Domain dataset group. Only
2965
3292
  # recipes (Domain dataset group use cases) for this domain are included
2966
- # in the response. If you don't specify a domain, only non-domain
2967
- # recipes are returned.
3293
+ # in the response. If you don't specify a domain, all recipes are
3294
+ # returned.
2968
3295
  #
2969
3296
  # @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2970
3297
  #
@@ -3065,7 +3392,11 @@ module Aws::Personalize
3065
3392
 
3066
3393
  # Returns the list of schemas associated with the account. The response
3067
3394
  # provides the properties for each schema, including the Amazon Resource
3068
- # Name (ARN). For more information on schemas, see CreateSchema.
3395
+ # Name (ARN). For more information on schemas, see [CreateSchema][1].
3396
+ #
3397
+ #
3398
+ #
3399
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
3069
3400
  #
3070
3401
  # @option params [String] :next_token
3071
3402
  # A token returned from the previous call to `ListSchemas` for getting
@@ -3110,8 +3441,7 @@ module Aws::Personalize
3110
3441
  # Returns a list of solution versions for the given solution. When a
3111
3442
  # solution is not specified, all the solution versions associated with
3112
3443
  # the account are listed. The response provides the properties for each
3113
- # solution version, including the Amazon Resource Name (ARN). For more
3114
- # information on solutions, see CreateSolution.
3444
+ # solution version, including the Amazon Resource Name (ARN).
3115
3445
  #
3116
3446
  # @option params [String] :solution_arn
3117
3447
  # The Amazon Resource Name (ARN) of the solution.
@@ -3161,7 +3491,11 @@ module Aws::Personalize
3161
3491
  # dataset group is not specified, all the solutions associated with the
3162
3492
  # account are listed. The response provides the properties for each
3163
3493
  # solution, including the Amazon Resource Name (ARN). For more
3164
- # information on solutions, see CreateSolution.
3494
+ # information on solutions, see [CreateSolution][1].
3495
+ #
3496
+ #
3497
+ #
3498
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
3165
3499
  #
3166
3500
  # @option params [String] :dataset_group_arn
3167
3501
  # The Amazon Resource Name (ARN) of the dataset group.
@@ -3207,6 +3541,40 @@ module Aws::Personalize
3207
3541
  req.send_request(options)
3208
3542
  end
3209
3543
 
3544
+ # Get a list of [tags][1] attached to a resource.
3545
+ #
3546
+ #
3547
+ #
3548
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
3549
+ #
3550
+ # @option params [required, String] :resource_arn
3551
+ # The resource's Amazon Resource Name.
3552
+ #
3553
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3554
+ #
3555
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
3556
+ #
3557
+ # @example Request syntax with placeholder values
3558
+ #
3559
+ # resp = client.list_tags_for_resource({
3560
+ # resource_arn: "Arn", # required
3561
+ # })
3562
+ #
3563
+ # @example Response structure
3564
+ #
3565
+ # resp.tags #=> Array
3566
+ # resp.tags[0].tag_key #=> String
3567
+ # resp.tags[0].tag_value #=> String
3568
+ #
3569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListTagsForResource AWS API Documentation
3570
+ #
3571
+ # @overload list_tags_for_resource(params = {})
3572
+ # @param [Hash] params ({})
3573
+ def list_tags_for_resource(params = {}, options = {})
3574
+ req = build_request(:list_tags_for_resource, params)
3575
+ req.send_request(options)
3576
+ end
3577
+
3210
3578
  # Stops creating a solution version that is in a state of
3211
3579
  # CREATE\_PENDING or CREATE IN\_PROGRESS.
3212
3580
  #
@@ -3244,18 +3612,90 @@ module Aws::Personalize
3244
3612
  req.send_request(options)
3245
3613
  end
3246
3614
 
3615
+ # Add a list of tags to a resource.
3616
+ #
3617
+ # @option params [required, String] :resource_arn
3618
+ # The resource's Amazon Resource Name (ARN).
3619
+ #
3620
+ # @option params [required, Array<Types::Tag>] :tags
3621
+ # Tags to apply to the resource. For more information see [Tagging
3622
+ # Personalize resources][1].
3623
+ #
3624
+ #
3625
+ #
3626
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
3627
+ #
3628
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3629
+ #
3630
+ # @example Request syntax with placeholder values
3631
+ #
3632
+ # resp = client.tag_resource({
3633
+ # resource_arn: "Arn", # required
3634
+ # tags: [ # required
3635
+ # {
3636
+ # tag_key: "TagKey", # required
3637
+ # tag_value: "TagValue", # required
3638
+ # },
3639
+ # ],
3640
+ # })
3641
+ #
3642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResource AWS API Documentation
3643
+ #
3644
+ # @overload tag_resource(params = {})
3645
+ # @param [Hash] params ({})
3646
+ def tag_resource(params = {}, options = {})
3647
+ req = build_request(:tag_resource, params)
3648
+ req.send_request(options)
3649
+ end
3650
+
3651
+ # Remove [tags][1] that are attached to a resource.
3652
+ #
3653
+ #
3654
+ #
3655
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
3656
+ #
3657
+ # @option params [required, String] :resource_arn
3658
+ # The resource's Amazon Resource Name (ARN).
3659
+ #
3660
+ # @option params [required, Array<String>] :tag_keys
3661
+ # Keys to remove from the resource's tags.
3662
+ #
3663
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3664
+ #
3665
+ # @example Request syntax with placeholder values
3666
+ #
3667
+ # resp = client.untag_resource({
3668
+ # resource_arn: "Arn", # required
3669
+ # tag_keys: ["TagKey"], # required
3670
+ # })
3671
+ #
3672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResource AWS API Documentation
3673
+ #
3674
+ # @overload untag_resource(params = {})
3675
+ # @param [Hash] params ({})
3676
+ def untag_resource(params = {}, options = {})
3677
+ req = build_request(:untag_resource, params)
3678
+ req.send_request(options)
3679
+ end
3680
+
3247
3681
  # Updates a campaign by either deploying a new solution or changing the
3248
3682
  # value of the campaign's `minProvisionedTPS` parameter.
3249
3683
  #
3250
3684
  # To update a campaign, the campaign status must be ACTIVE or CREATE
3251
- # FAILED. Check the campaign status using the DescribeCampaign API.
3685
+ # FAILED. Check the campaign status using the [DescribeCampaign][1]
3686
+ # operation.
3252
3687
  #
3253
3688
  # <note markdown="1"> You must wait until the `status` of the updated campaign is `ACTIVE`
3254
3689
  # before asking the campaign for recommendations.
3255
3690
  #
3256
3691
  # </note>
3257
3692
  #
3258
- # For more information on campaigns, see CreateCampaign.
3693
+ # For more information on campaigns, see [CreateCampaign][2].
3694
+ #
3695
+ #
3696
+ #
3697
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
3698
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
3259
3699
  #
3260
3700
  # @option params [required, String] :campaign_arn
3261
3701
  # The Amazon Resource Name (ARN) of the campaign.
@@ -3350,7 +3790,7 @@ module Aws::Personalize
3350
3790
  params: params,
3351
3791
  config: config)
3352
3792
  context[:gem_name] = 'aws-sdk-personalize'
3353
- context[:gem_version] = '1.39.0'
3793
+ context[:gem_version] = '1.40.0'
3354
3794
  Seahorse::Client::Request.new(handlers, context)
3355
3795
  end
3356
3796