aws-sdk-personalize 1.37.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.
@@ -93,9 +93,13 @@ module Aws::Personalize
93
93
  end
94
94
 
95
95
  # When the solution performs AutoML (`performAutoML` is true in
96
- # CreateSolution), Amazon Personalize determines which recipe, from the
97
- # specified list, optimizes the given metric. Amazon Personalize then
98
- # uses that recipe for the solution.
96
+ # [CreateSolution][1]), Amazon Personalize determines which recipe, from
97
+ # the specified list, optimizes the given metric. Amazon Personalize
98
+ # then uses that recipe for the solution.
99
+ #
100
+ #
101
+ #
102
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
99
103
  #
100
104
  # @note When making an API call, you may pass AutoMLConfig
101
105
  # data as a hash:
@@ -123,9 +127,13 @@ module Aws::Personalize
123
127
  end
124
128
 
125
129
  # When the solution performs AutoML (`performAutoML` is true in
126
- # CreateSolution), specifies the recipe that best optimized the
130
+ # [CreateSolution][1]), specifies the recipe that best optimized the
127
131
  # specified metric.
128
132
  #
133
+ #
134
+ #
135
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
136
+ #
129
137
  # @!attribute [rw] best_recipe_arn
130
138
  # The Amazon Resource Name (ARN) of the best recipe.
131
139
  # @return [String]
@@ -310,9 +318,14 @@ module Aws::Personalize
310
318
  include Aws::Structure
311
319
  end
312
320
 
313
- # A truncated version of the BatchInferenceJob datatype. The
314
- # ListBatchInferenceJobs operation returns a list of batch inference job
315
- # summaries.
321
+ # A truncated version of the [BatchInferenceJob][1]. The
322
+ # [ListBatchInferenceJobs][2] operation returns a list of batch
323
+ # inference job summaries.
324
+ #
325
+ #
326
+ #
327
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html
328
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html
316
329
  #
317
330
  # @!attribute [rw] batch_inference_job_arn
318
331
  # The Amazon Resource Name (ARN) of the batch inference job.
@@ -496,9 +509,14 @@ module Aws::Personalize
496
509
  include Aws::Structure
497
510
  end
498
511
 
499
- # A truncated version of the BatchSegmentJob datatype. The
500
- # ListBatchSegmentJobs operation returns a list of batch segment job
501
- # summaries.
512
+ # A truncated version of the [BatchSegmentJob][1] datatype.
513
+ # [ListBatchSegmentJobs][2] operation returns a list of batch segment
514
+ # job summaries.
515
+ #
516
+ #
517
+ #
518
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html
519
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html
502
520
  #
503
521
  # @!attribute [rw] batch_segment_job_arn
504
522
  # The Amazon Resource Name (ARN) of the batch segment job.
@@ -553,7 +571,11 @@ module Aws::Personalize
553
571
  end
554
572
 
555
573
  # An object that describes the deployment of a solution version. For
556
- # more information on campaigns, see CreateCampaign.
574
+ # more information on campaigns, see [CreateCampaign][1].
575
+ #
576
+ #
577
+ #
578
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
557
579
  #
558
580
  # @!attribute [rw] name
559
581
  # The name of the campaign.
@@ -603,7 +625,11 @@ module Aws::Personalize
603
625
  #
604
626
  # @!attribute [rw] latest_campaign_update
605
627
  # Provides a summary of the properties of a campaign update. For a
606
- # complete listing, call the DescribeCampaign API.
628
+ # complete listing, call the [DescribeCampaign][1] API.
629
+ #
630
+ #
631
+ #
632
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
607
633
  # @return [Types::CampaignUpdateSummary]
608
634
  #
609
635
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Campaign AWS API Documentation
@@ -655,7 +681,11 @@ module Aws::Personalize
655
681
  end
656
682
 
657
683
  # Provides a summary of the properties of a campaign. For a complete
658
- # listing, call the DescribeCampaign API.
684
+ # listing, call the [DescribeCampaign][1] API.
685
+ #
686
+ #
687
+ #
688
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
659
689
  #
660
690
  # @!attribute [rw] name
661
691
  # The name of the campaign.
@@ -702,7 +732,11 @@ module Aws::Personalize
702
732
  end
703
733
 
704
734
  # Provides a summary of the properties of a campaign update. For a
705
- # complete listing, call the DescribeCampaign API.
735
+ # complete listing, call the [DescribeCampaign][1] API.
736
+ #
737
+ #
738
+ #
739
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
706
740
  #
707
741
  # @!attribute [rw] solution_version_arn
708
742
  # The Amazon Resource Name (ARN) of the deployed solution version.
@@ -842,6 +876,12 @@ module Aws::Personalize
842
876
  # "ParameterName" => "ParameterValue",
843
877
  # },
844
878
  # },
879
+ # tags: [
880
+ # {
881
+ # tag_key: "TagKey", # required
882
+ # tag_value: "TagValue", # required
883
+ # },
884
+ # ],
845
885
  # }
846
886
  #
847
887
  # @!attribute [rw] job_name
@@ -855,8 +895,8 @@ module Aws::Personalize
855
895
  #
856
896
  # @!attribute [rw] filter_arn
857
897
  # The ARN of the filter to apply to the batch inference job. For more
858
- # information on using filters, see [Filtering Batch
859
- # Recommendations][1]..
898
+ # information on using filters, see [Filtering batch
899
+ # recommendations][1].
860
900
  #
861
901
  #
862
902
  #
@@ -864,7 +904,7 @@ module Aws::Personalize
864
904
  # @return [String]
865
905
  #
866
906
  # @!attribute [rw] num_results
867
- # The number of recommendations to retreive.
907
+ # The number of recommendations to retrieve.
868
908
  # @return [Integer]
869
909
  #
870
910
  # @!attribute [rw] job_input
@@ -887,6 +927,14 @@ module Aws::Personalize
887
927
  # The configuration details of a batch inference job.
888
928
  # @return [Types::BatchInferenceJobConfig]
889
929
  #
930
+ # @!attribute [rw] tags
931
+ # A list of [tags][1] to apply to the batch inference job.
932
+ #
933
+ #
934
+ #
935
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
936
+ # @return [Array<Types::Tag>]
937
+ #
890
938
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
891
939
  #
892
940
  class CreateBatchInferenceJobRequest < Struct.new(
@@ -897,7 +945,8 @@ module Aws::Personalize
897
945
  :job_input,
898
946
  :job_output,
899
947
  :role_arn,
900
- :batch_inference_job_config)
948
+ :batch_inference_job_config,
949
+ :tags)
901
950
  SENSITIVE = []
902
951
  include Aws::Structure
903
952
  end
@@ -935,6 +984,12 @@ module Aws::Personalize
935
984
  # },
936
985
  # },
937
986
  # role_arn: "RoleArn", # required
987
+ # tags: [
988
+ # {
989
+ # tag_key: "TagKey", # required
990
+ # tag_value: "TagValue", # required
991
+ # },
992
+ # ],
938
993
  # }
939
994
  #
940
995
  # @!attribute [rw] job_name
@@ -948,7 +1003,12 @@ module Aws::Personalize
948
1003
  #
949
1004
  # @!attribute [rw] filter_arn
950
1005
  # The ARN of the filter to apply to the batch segment job. For more
951
- # information on using filters, see filter-batch.
1006
+ # information on using filters, see [Filtering batch
1007
+ # recommendations][1].
1008
+ #
1009
+ #
1010
+ #
1011
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
952
1012
  # @return [String]
953
1013
  #
954
1014
  # @!attribute [rw] num_results
@@ -972,6 +1032,14 @@ module Aws::Personalize
972
1032
  # buckets respectively.
973
1033
  # @return [String]
974
1034
  #
1035
+ # @!attribute [rw] tags
1036
+ # A list of [tags][1] to apply to the batch segment job.
1037
+ #
1038
+ #
1039
+ #
1040
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1041
+ # @return [Array<Types::Tag>]
1042
+ #
975
1043
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobRequest AWS API Documentation
976
1044
  #
977
1045
  class CreateBatchSegmentJobRequest < Struct.new(
@@ -981,7 +1049,8 @@ module Aws::Personalize
981
1049
  :num_results,
982
1050
  :job_input,
983
1051
  :job_output,
984
- :role_arn)
1052
+ :role_arn,
1053
+ :tags)
985
1054
  SENSITIVE = []
986
1055
  include Aws::Structure
987
1056
  end
@@ -1010,6 +1079,12 @@ module Aws::Personalize
1010
1079
  # "ParameterName" => "ParameterValue",
1011
1080
  # },
1012
1081
  # },
1082
+ # tags: [
1083
+ # {
1084
+ # tag_key: "TagKey", # required
1085
+ # tag_value: "TagValue", # required
1086
+ # },
1087
+ # ],
1013
1088
  # }
1014
1089
  #
1015
1090
  # @!attribute [rw] name
@@ -1030,13 +1105,22 @@ module Aws::Personalize
1030
1105
  # The configuration details of a campaign.
1031
1106
  # @return [Types::CampaignConfig]
1032
1107
  #
1108
+ # @!attribute [rw] tags
1109
+ # A list of [tags][1] to apply to the campaign.
1110
+ #
1111
+ #
1112
+ #
1113
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1114
+ # @return [Array<Types::Tag>]
1115
+ #
1033
1116
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaignRequest AWS API Documentation
1034
1117
  #
1035
1118
  class CreateCampaignRequest < Struct.new(
1036
1119
  :name,
1037
1120
  :solution_version_arn,
1038
1121
  :min_provisioned_tps,
1039
- :campaign_config)
1122
+ :campaign_config,
1123
+ :tags)
1040
1124
  SENSITIVE = []
1041
1125
  include Aws::Structure
1042
1126
  end
@@ -1067,6 +1151,12 @@ module Aws::Personalize
1067
1151
  # kms_key_arn: "KmsKeyArn",
1068
1152
  # },
1069
1153
  # },
1154
+ # tags: [
1155
+ # {
1156
+ # tag_key: "TagKey", # required
1157
+ # tag_value: "TagValue", # required
1158
+ # },
1159
+ # ],
1070
1160
  # }
1071
1161
  #
1072
1162
  # @!attribute [rw] job_name
@@ -1095,6 +1185,14 @@ module Aws::Personalize
1095
1185
  # The path to the Amazon S3 bucket where the job's output is stored.
1096
1186
  # @return [Types::DatasetExportJobOutput]
1097
1187
  #
1188
+ # @!attribute [rw] tags
1189
+ # A list of [tags][1] to apply to the dataset export job.
1190
+ #
1191
+ #
1192
+ #
1193
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1194
+ # @return [Array<Types::Tag>]
1195
+ #
1098
1196
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobRequest AWS API Documentation
1099
1197
  #
1100
1198
  class CreateDatasetExportJobRequest < Struct.new(
@@ -1102,7 +1200,8 @@ module Aws::Personalize
1102
1200
  :dataset_arn,
1103
1201
  :ingestion_mode,
1104
1202
  :role_arn,
1105
- :job_output)
1203
+ :job_output,
1204
+ :tags)
1106
1205
  SENSITIVE = []
1107
1206
  include Aws::Structure
1108
1207
  end
@@ -1127,6 +1226,12 @@ module Aws::Personalize
1127
1226
  # role_arn: "RoleArn",
1128
1227
  # kms_key_arn: "KmsKeyArn",
1129
1228
  # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
1229
+ # tags: [
1230
+ # {
1231
+ # tag_key: "TagKey", # required
1232
+ # tag_value: "TagValue", # required
1233
+ # },
1234
+ # ],
1130
1235
  # }
1131
1236
  #
1132
1237
  # @!attribute [rw] name
@@ -1152,13 +1257,22 @@ module Aws::Personalize
1152
1257
  # solution versions that you deploy with a campaign.
1153
1258
  # @return [String]
1154
1259
  #
1260
+ # @!attribute [rw] tags
1261
+ # A list of [tags][1] to apply to the dataset group.
1262
+ #
1263
+ #
1264
+ #
1265
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1266
+ # @return [Array<Types::Tag>]
1267
+ #
1155
1268
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupRequest AWS API Documentation
1156
1269
  #
1157
1270
  class CreateDatasetGroupRequest < Struct.new(
1158
1271
  :name,
1159
1272
  :role_arn,
1160
1273
  :kms_key_arn,
1161
- :domain)
1274
+ :domain,
1275
+ :tags)
1162
1276
  SENSITIVE = []
1163
1277
  include Aws::Structure
1164
1278
  end
@@ -1190,6 +1304,12 @@ module Aws::Personalize
1190
1304
  # data_location: "S3Location",
1191
1305
  # },
1192
1306
  # role_arn: "RoleArn", # required
1307
+ # tags: [
1308
+ # {
1309
+ # tag_key: "TagKey", # required
1310
+ # tag_value: "TagValue", # required
1311
+ # },
1312
+ # ],
1193
1313
  # }
1194
1314
  #
1195
1315
  # @!attribute [rw] job_name
@@ -1209,13 +1329,22 @@ module Aws::Personalize
1209
1329
  # S3 data source.
1210
1330
  # @return [String]
1211
1331
  #
1332
+ # @!attribute [rw] tags
1333
+ # A list of [tags][1] to apply to the dataset import job.
1334
+ #
1335
+ #
1336
+ #
1337
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1338
+ # @return [Array<Types::Tag>]
1339
+ #
1212
1340
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJobRequest AWS API Documentation
1213
1341
  #
1214
1342
  class CreateDatasetImportJobRequest < Struct.new(
1215
1343
  :job_name,
1216
1344
  :dataset_arn,
1217
1345
  :data_source,
1218
- :role_arn)
1346
+ :role_arn,
1347
+ :tags)
1219
1348
  SENSITIVE = []
1220
1349
  include Aws::Structure
1221
1350
  end
@@ -1240,6 +1369,12 @@ module Aws::Personalize
1240
1369
  # schema_arn: "Arn", # required
1241
1370
  # dataset_group_arn: "Arn", # required
1242
1371
  # dataset_type: "DatasetType", # required
1372
+ # tags: [
1373
+ # {
1374
+ # tag_key: "TagKey", # required
1375
+ # tag_value: "TagValue", # required
1376
+ # },
1377
+ # ],
1243
1378
  # }
1244
1379
  #
1245
1380
  # @!attribute [rw] name
@@ -1268,13 +1403,22 @@ module Aws::Personalize
1268
1403
  # * Users
1269
1404
  # @return [String]
1270
1405
  #
1406
+ # @!attribute [rw] tags
1407
+ # A list of [tags][1] to apply to the dataset.
1408
+ #
1409
+ #
1410
+ #
1411
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1412
+ # @return [Array<Types::Tag>]
1413
+ #
1271
1414
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetRequest AWS API Documentation
1272
1415
  #
1273
1416
  class CreateDatasetRequest < Struct.new(
1274
1417
  :name,
1275
1418
  :schema_arn,
1276
1419
  :dataset_group_arn,
1277
- :dataset_type)
1420
+ :dataset_type,
1421
+ :tags)
1278
1422
  SENSITIVE = []
1279
1423
  include Aws::Structure
1280
1424
  end
@@ -1297,6 +1441,12 @@ module Aws::Personalize
1297
1441
  # {
1298
1442
  # name: "Name", # required
1299
1443
  # dataset_group_arn: "Arn", # required
1444
+ # tags: [
1445
+ # {
1446
+ # tag_key: "TagKey", # required
1447
+ # tag_value: "TagValue", # required
1448
+ # },
1449
+ # ],
1300
1450
  # }
1301
1451
  #
1302
1452
  # @!attribute [rw] name
@@ -1308,11 +1458,20 @@ module Aws::Personalize
1308
1458
  # the event data.
1309
1459
  # @return [String]
1310
1460
  #
1461
+ # @!attribute [rw] tags
1462
+ # A list of [tags][1] to apply to the event tracker.
1463
+ #
1464
+ #
1465
+ #
1466
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1467
+ # @return [Array<Types::Tag>]
1468
+ #
1311
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTrackerRequest AWS API Documentation
1312
1470
  #
1313
1471
  class CreateEventTrackerRequest < Struct.new(
1314
1472
  :name,
1315
- :dataset_group_arn)
1473
+ :dataset_group_arn,
1474
+ :tags)
1316
1475
  SENSITIVE = []
1317
1476
  include Aws::Structure
1318
1477
  end
@@ -1346,6 +1505,12 @@ module Aws::Personalize
1346
1505
  # name: "Name", # required
1347
1506
  # dataset_group_arn: "Arn", # required
1348
1507
  # filter_expression: "FilterExpression", # required
1508
+ # tags: [
1509
+ # {
1510
+ # tag_key: "TagKey", # required
1511
+ # tag_value: "TagValue", # required
1512
+ # },
1513
+ # ],
1349
1514
  # }
1350
1515
  #
1351
1516
  # @!attribute [rw] name
@@ -1360,15 +1525,28 @@ module Aws::Personalize
1360
1525
  # The filter expression defines which items are included or excluded
1361
1526
  # from recommendations. Filter expression must follow specific format
1362
1527
  # rules. For information about filter expression structure and syntax,
1363
- # see filter-expressions.
1528
+ # see [Filter expressions][1].
1529
+ #
1530
+ #
1531
+ #
1532
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html
1364
1533
  # @return [String]
1365
1534
  #
1535
+ # @!attribute [rw] tags
1536
+ # A list of [tags][1] to apply to the filter.
1537
+ #
1538
+ #
1539
+ #
1540
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1541
+ # @return [Array<Types::Tag>]
1542
+ #
1366
1543
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
1367
1544
  #
1368
1545
  class CreateFilterRequest < Struct.new(
1369
1546
  :name,
1370
1547
  :dataset_group_arn,
1371
- :filter_expression)
1548
+ :filter_expression,
1549
+ :tags)
1372
1550
  SENSITIVE = [:filter_expression]
1373
1551
  include Aws::Structure
1374
1552
  end
@@ -1398,6 +1576,12 @@ module Aws::Personalize
1398
1576
  # },
1399
1577
  # min_recommendation_requests_per_second: 1,
1400
1578
  # },
1579
+ # tags: [
1580
+ # {
1581
+ # tag_key: "TagKey", # required
1582
+ # tag_value: "TagValue", # required
1583
+ # },
1584
+ # ],
1401
1585
  # }
1402
1586
  #
1403
1587
  # @!attribute [rw] name
@@ -1425,13 +1609,22 @@ module Aws::Personalize
1425
1609
  # The configuration details of the recommender.
1426
1610
  # @return [Types::RecommenderConfig]
1427
1611
  #
1612
+ # @!attribute [rw] tags
1613
+ # A list of [tags][1] to apply to the recommender.
1614
+ #
1615
+ #
1616
+ #
1617
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1618
+ # @return [Array<Types::Tag>]
1619
+ #
1428
1620
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderRequest AWS API Documentation
1429
1621
  #
1430
1622
  class CreateRecommenderRequest < Struct.new(
1431
1623
  :name,
1432
1624
  :dataset_group_arn,
1433
1625
  :recipe_arn,
1434
- :recommender_config)
1626
+ :recommender_config,
1627
+ :tags)
1435
1628
  SENSITIVE = []
1436
1629
  include Aws::Structure
1437
1630
  end
@@ -1553,6 +1746,12 @@ module Aws::Personalize
1553
1746
  # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
1554
1747
  # },
1555
1748
  # },
1749
+ # tags: [
1750
+ # {
1751
+ # tag_key: "TagKey", # required
1752
+ # tag_value: "TagValue", # required
1753
+ # },
1754
+ # ],
1556
1755
  # }
1557
1756
  #
1558
1757
  # @!attribute [rw] name
@@ -1609,6 +1808,14 @@ module Aws::Personalize
1609
1808
  # </note>
1610
1809
  # @return [Types::SolutionConfig]
1611
1810
  #
1811
+ # @!attribute [rw] tags
1812
+ # A list of [tags][1] to apply to the solution.
1813
+ #
1814
+ #
1815
+ #
1816
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1817
+ # @return [Array<Types::Tag>]
1818
+ #
1612
1819
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
1613
1820
  #
1614
1821
  class CreateSolutionRequest < Struct.new(
@@ -1618,7 +1825,8 @@ module Aws::Personalize
1618
1825
  :recipe_arn,
1619
1826
  :dataset_group_arn,
1620
1827
  :event_type,
1621
- :solution_config)
1828
+ :solution_config,
1829
+ :tags)
1622
1830
  SENSITIVE = []
1623
1831
  include Aws::Structure
1624
1832
  end
@@ -1641,6 +1849,12 @@ module Aws::Personalize
1641
1849
  # {
1642
1850
  # solution_arn: "Arn", # required
1643
1851
  # training_mode: "FULL", # accepts FULL, UPDATE
1852
+ # tags: [
1853
+ # {
1854
+ # tag_key: "TagKey", # required
1855
+ # tag_value: "TagValue", # required
1856
+ # },
1857
+ # ],
1644
1858
  # }
1645
1859
  #
1646
1860
  # @!attribute [rw] solution_arn
@@ -1668,11 +1882,20 @@ module Aws::Personalize
1668
1882
  # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
1669
1883
  # @return [String]
1670
1884
  #
1885
+ # @!attribute [rw] tags
1886
+ # A list of [tags][1] to apply to the solution version.
1887
+ #
1888
+ #
1889
+ #
1890
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
1891
+ # @return [Array<Types::Tag>]
1892
+ #
1671
1893
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
1672
1894
  #
1673
1895
  class CreateSolutionVersionRequest < Struct.new(
1674
1896
  :solution_arn,
1675
- :training_mode)
1897
+ :training_mode,
1898
+ :tags)
1676
1899
  SENSITIVE = []
1677
1900
  include Aws::Structure
1678
1901
  end
@@ -1778,7 +2001,7 @@ module Aws::Personalize
1778
2001
  end
1779
2002
 
1780
2003
  # Describes a job that exports a dataset to an Amazon S3 bucket. For
1781
- # more information, see CreateDatasetExportJob.
2004
+ # more information, see [CreateDatasetExportJob][1].
1782
2005
  #
1783
2006
  # A dataset export job can be in one of the following states:
1784
2007
  #
@@ -1787,6 +2010,10 @@ module Aws::Personalize
1787
2010
  #
1788
2011
  # ^
1789
2012
  #
2013
+ #
2014
+ #
2015
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html
2016
+ #
1790
2017
  # @!attribute [rw] job_name
1791
2018
  # The name of the export job.
1792
2019
  # @return [String]
@@ -1885,7 +2112,11 @@ module Aws::Personalize
1885
2112
  end
1886
2113
 
1887
2114
  # Provides a summary of the properties of a dataset export job. For a
1888
- # complete listing, call the DescribeDatasetExportJob API.
2115
+ # complete listing, call the [DescribeDatasetExportJob][1] API.
2116
+ #
2117
+ #
2118
+ #
2119
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html
1889
2120
  #
1890
2121
  # @!attribute [rw] dataset_export_job_arn
1891
2122
  # The Amazon Resource Name (ARN) of the dataset export job.
@@ -1935,14 +2166,20 @@ module Aws::Personalize
1935
2166
 
1936
2167
  # A dataset group is a collection of related datasets (Interactions,
1937
2168
  # User, and Item). You create a dataset group by calling
1938
- # CreateDatasetGroup. You then create a dataset and add it to a dataset
1939
- # group by calling CreateDataset. The dataset group is used to create
1940
- # and train a solution by calling CreateSolution. A dataset group can
1941
- # contain only one of each type of dataset.
2169
+ # [CreateDatasetGroup][1]. You then create a dataset and add it to a
2170
+ # dataset group by calling [CreateDataset][2]. The dataset group is used
2171
+ # to create and train a solution by calling [CreateSolution][3]. A
2172
+ # dataset group can contain only one of each type of dataset.
1942
2173
  #
1943
2174
  # You can specify an Key Management Service (KMS) key to encrypt the
1944
2175
  # datasets in the group.
1945
2176
  #
2177
+ #
2178
+ #
2179
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
2180
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
2181
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
2182
+ #
1946
2183
  # @!attribute [rw] name
1947
2184
  # The name of the dataset group.
1948
2185
  # @return [String]
@@ -2005,7 +2242,11 @@ module Aws::Personalize
2005
2242
  end
2006
2243
 
2007
2244
  # Provides a summary of the properties of a dataset group. For a
2008
- # complete listing, call the DescribeDatasetGroup API.
2245
+ # complete listing, call the [DescribeDatasetGroup][1] API.
2246
+ #
2247
+ #
2248
+ #
2249
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html
2009
2250
  #
2010
2251
  # @!attribute [rw] name
2011
2252
  # The name of the dataset group.
@@ -2059,7 +2300,7 @@ module Aws::Personalize
2059
2300
 
2060
2301
  # Describes a job that imports training data from a data source (Amazon
2061
2302
  # S3 bucket) to an Amazon Personalize dataset. For more information, see
2062
- # CreateDatasetImportJob.
2303
+ # [CreateDatasetImportJob][1].
2063
2304
  #
2064
2305
  # A dataset import job can be in one of the following states:
2065
2306
  #
@@ -2068,6 +2309,10 @@ module Aws::Personalize
2068
2309
  #
2069
2310
  # ^
2070
2311
  #
2312
+ #
2313
+ #
2314
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
2315
+ #
2071
2316
  # @!attribute [rw] job_name
2072
2317
  # The name of the import job.
2073
2318
  # @return [String]
@@ -2130,7 +2375,11 @@ module Aws::Personalize
2130
2375
  end
2131
2376
 
2132
2377
  # Provides a summary of the properties of a dataset import job. For a
2133
- # complete listing, call the DescribeDatasetImportJob API.
2378
+ # complete listing, call the [DescribeDatasetImportJob][1] API.
2379
+ #
2380
+ #
2381
+ #
2382
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
2134
2383
  #
2135
2384
  # @!attribute [rw] dataset_import_job_arn
2136
2385
  # The Amazon Resource Name (ARN) of the dataset import job.
@@ -2179,7 +2428,11 @@ module Aws::Personalize
2179
2428
  end
2180
2429
 
2181
2430
  # Describes the schema for a dataset. For more information on schemas,
2182
- # see CreateSchema.
2431
+ # see [CreateSchema][1].
2432
+ #
2433
+ #
2434
+ #
2435
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
2183
2436
  #
2184
2437
  # @!attribute [rw] name
2185
2438
  # The name of the schema.
@@ -2220,7 +2473,11 @@ module Aws::Personalize
2220
2473
  end
2221
2474
 
2222
2475
  # Provides a summary of the properties of a dataset schema. For a
2223
- # complete listing, call the DescribeSchema API.
2476
+ # complete listing, call the [DescribeSchema][1] API.
2477
+ #
2478
+ #
2479
+ #
2480
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html
2224
2481
  #
2225
2482
  # @!attribute [rw] name
2226
2483
  # The name of the schema.
@@ -2256,7 +2513,11 @@ module Aws::Personalize
2256
2513
  end
2257
2514
 
2258
2515
  # Provides a summary of the properties of a dataset. For a complete
2259
- # listing, call the DescribeDataset API.
2516
+ # listing, call the [DescribeDataset][1] API.
2517
+ #
2518
+ #
2519
+ #
2520
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html
2260
2521
  #
2261
2522
  # @!attribute [rw] name
2262
2523
  # The name of the dataset.
@@ -3161,7 +3422,11 @@ module Aws::Personalize
3161
3422
  end
3162
3423
 
3163
3424
  # Provides a summary of the properties of an event tracker. For a
3164
- # complete listing, call the DescribeEventTracker API.
3425
+ # complete listing, call the [DescribeEventTracker][1] API.
3426
+ #
3427
+ #
3428
+ #
3429
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html
3165
3430
  #
3166
3431
  # @!attribute [rw] name
3167
3432
  # The name of the event tracker.
@@ -3284,7 +3549,11 @@ module Aws::Personalize
3284
3549
  # Specifies the type of item interactions to filter out of
3285
3550
  # recommendation results. The filter expression must follow specific
3286
3551
  # format rules. For information about filter expression structure and
3287
- # syntax, see filter-expressions.
3552
+ # syntax, see [Filter expressions][1].
3553
+ #
3554
+ #
3555
+ #
3556
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html
3288
3557
  # @return [String]
3289
3558
  #
3290
3559
  # @!attribute [rw] status
@@ -3764,8 +4033,12 @@ module Aws::Personalize
3764
4033
  # @return [String]
3765
4034
  #
3766
4035
  # @!attribute [rw] next_token
3767
- # A token returned from the previous call to `ListCampaigns` for
4036
+ # A token returned from the previous call to [ListCampaigns][1] for
3768
4037
  # getting the next set of campaigns (if they exist).
4038
+ #
4039
+ #
4040
+ #
4041
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
3769
4042
  # @return [String]
3770
4043
  #
3771
4044
  # @!attribute [rw] max_results
@@ -4119,8 +4392,8 @@ module Aws::Personalize
4119
4392
  # @!attribute [rw] domain
4120
4393
  # Filters returned recipes by domain for a Domain dataset group. Only
4121
4394
  # recipes (Domain dataset group use cases) for this domain are
4122
- # included in the response. If you don't specify a domain, only
4123
- # non-domain recipes are returned.
4395
+ # included in the response. If you don't specify a domain, all
4396
+ # recipes are returned.
4124
4397
  # @return [String]
4125
4398
  #
4126
4399
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesRequest AWS API Documentation
@@ -4344,6 +4617,37 @@ module Aws::Personalize
4344
4617
  include Aws::Structure
4345
4618
  end
4346
4619
 
4620
+ # @note When making an API call, you may pass ListTagsForResourceRequest
4621
+ # data as a hash:
4622
+ #
4623
+ # {
4624
+ # resource_arn: "Arn", # required
4625
+ # }
4626
+ #
4627
+ # @!attribute [rw] resource_arn
4628
+ # The resource's Amazon Resource Name.
4629
+ # @return [String]
4630
+ #
4631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListTagsForResourceRequest AWS API Documentation
4632
+ #
4633
+ class ListTagsForResourceRequest < Struct.new(
4634
+ :resource_arn)
4635
+ SENSITIVE = []
4636
+ include Aws::Structure
4637
+ end
4638
+
4639
+ # @!attribute [rw] tags
4640
+ # The resource's tags.
4641
+ # @return [Array<Types::Tag>]
4642
+ #
4643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListTagsForResourceResponse AWS API Documentation
4644
+ #
4645
+ class ListTagsForResourceResponse < Struct.new(
4646
+ :tags)
4647
+ SENSITIVE = []
4648
+ include Aws::Structure
4649
+ end
4650
+
4347
4651
  # Describes the additional objective for the solution, such as
4348
4652
  # maximizing streaming minutes or increasing revenue. For more
4349
4653
  # information see [Optimizing a solution][1].
@@ -4382,7 +4686,11 @@ module Aws::Personalize
4382
4686
 
4383
4687
  # Provides information about a recipe. Each recipe provides an algorithm
4384
4688
  # that Amazon Personalize uses in model training when you use the
4385
- # CreateSolution operation.
4689
+ # [CreateSolution][1] operation.
4690
+ #
4691
+ #
4692
+ #
4693
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
4386
4694
  #
4387
4695
  # @!attribute [rw] name
4388
4696
  # The name of the recipe.
@@ -4444,7 +4752,11 @@ module Aws::Personalize
4444
4752
  end
4445
4753
 
4446
4754
  # Provides a summary of the properties of a recipe. For a complete
4447
- # listing, call the DescribeRecipe API.
4755
+ # listing, call the [DescribeRecipe][1] API.
4756
+ #
4757
+ #
4758
+ #
4759
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html
4448
4760
  #
4449
4761
  # @!attribute [rw] name
4450
4762
  # The name of the recipe.
@@ -4654,7 +4966,11 @@ module Aws::Personalize
4654
4966
  end
4655
4967
 
4656
4968
  # Provides a summary of the properties of a recommender update. For a
4657
- # complete listing, call the DescribeRecommender API operation.
4969
+ # complete listing, call the [DescribeRecommender][1] API.
4970
+ #
4971
+ #
4972
+ #
4973
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html
4658
4974
  #
4659
4975
  # @!attribute [rw] recommender_config
4660
4976
  # The configuration details of the recommender update.
@@ -4930,8 +5246,12 @@ module Aws::Personalize
4930
5246
  # @return [Hash<String,String>]
4931
5247
  #
4932
5248
  # @!attribute [rw] auto_ml_config
4933
- # The AutoMLConfig object containing a list of recipes to search when
4934
- # AutoML is performed.
5249
+ # The [AutoMLConfig][1] object containing a list of recipes to search
5250
+ # when AutoML is performed.
5251
+ #
5252
+ #
5253
+ #
5254
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html
4935
5255
  # @return [Types::AutoMLConfig]
4936
5256
  #
4937
5257
  # @!attribute [rw] optimization_objective
@@ -4958,7 +5278,11 @@ module Aws::Personalize
4958
5278
  end
4959
5279
 
4960
5280
  # Provides a summary of the properties of a solution. For a complete
4961
- # listing, call the DescribeSolution API.
5281
+ # listing, call the [DescribeSolution][1] API.
5282
+ #
5283
+ #
5284
+ #
5285
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
4962
5286
  #
4963
5287
  # @!attribute [rw] name
4964
5288
  # The name of the solution.
@@ -5000,7 +5324,11 @@ module Aws::Personalize
5000
5324
  end
5001
5325
 
5002
5326
  # An object that provides information about a specific version of a
5003
- # Solution in a Custom dataset group.
5327
+ # [Solution][1] in a Custom dataset group.
5328
+ #
5329
+ #
5330
+ #
5331
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html
5004
5332
  #
5005
5333
  # @!attribute [rw] solution_version_arn
5006
5334
  # The ARN of the solution version.
@@ -5124,7 +5452,11 @@ module Aws::Personalize
5124
5452
  end
5125
5453
 
5126
5454
  # Provides a summary of the properties of a solution version. For a
5127
- # complete listing, call the DescribeSolutionVersion API.
5455
+ # complete listing, call the [DescribeSolutionVersion][1] API.
5456
+ #
5457
+ #
5458
+ #
5459
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
5128
5460
  #
5129
5461
  # @!attribute [rw] solution_version_arn
5130
5462
  # The Amazon Resource Name (ARN) of the solution version.
@@ -5187,6 +5519,109 @@ module Aws::Personalize
5187
5519
  include Aws::Structure
5188
5520
  end
5189
5521
 
5522
+ # The optional metadata that you apply to resources to help you
5523
+ # categorize and organize them. Each tag consists of a key and an
5524
+ # optional value, both of which you define. For more information see
5525
+ # [Tagging Personalize resources][1].
5526
+ #
5527
+ #
5528
+ #
5529
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
5530
+ #
5531
+ # @note When making an API call, you may pass Tag
5532
+ # data as a hash:
5533
+ #
5534
+ # {
5535
+ # tag_key: "TagKey", # required
5536
+ # tag_value: "TagValue", # required
5537
+ # }
5538
+ #
5539
+ # @!attribute [rw] tag_key
5540
+ # One part of a key-value pair that makes up a tag. A key is a general
5541
+ # label that acts like a category for more specific tag values.
5542
+ # @return [String]
5543
+ #
5544
+ # @!attribute [rw] tag_value
5545
+ # The optional part of a key-value pair that makes up a tag. A value
5546
+ # acts as a descriptor within a tag category (key).
5547
+ # @return [String]
5548
+ #
5549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Tag AWS API Documentation
5550
+ #
5551
+ class Tag < Struct.new(
5552
+ :tag_key,
5553
+ :tag_value)
5554
+ SENSITIVE = []
5555
+ include Aws::Structure
5556
+ end
5557
+
5558
+ # @note When making an API call, you may pass TagResourceRequest
5559
+ # data as a hash:
5560
+ #
5561
+ # {
5562
+ # resource_arn: "Arn", # required
5563
+ # tags: [ # required
5564
+ # {
5565
+ # tag_key: "TagKey", # required
5566
+ # tag_value: "TagValue", # required
5567
+ # },
5568
+ # ],
5569
+ # }
5570
+ #
5571
+ # @!attribute [rw] resource_arn
5572
+ # The resource's Amazon Resource Name (ARN).
5573
+ # @return [String]
5574
+ #
5575
+ # @!attribute [rw] tags
5576
+ # Tags to apply to the resource. For more information see [Tagging
5577
+ # Personalize resources][1].
5578
+ #
5579
+ #
5580
+ #
5581
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
5582
+ # @return [Array<Types::Tag>]
5583
+ #
5584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResourceRequest AWS API Documentation
5585
+ #
5586
+ class TagResourceRequest < Struct.new(
5587
+ :resource_arn,
5588
+ :tags)
5589
+ SENSITIVE = []
5590
+ include Aws::Structure
5591
+ end
5592
+
5593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResourceResponse AWS API Documentation
5594
+ #
5595
+ class TagResourceResponse < Aws::EmptyStructure; end
5596
+
5597
+ # The request contains more tag keys than can be associated with a
5598
+ # resource (50 tag keys per resource).
5599
+ #
5600
+ # @!attribute [rw] message
5601
+ # @return [String]
5602
+ #
5603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TooManyTagKeysException AWS API Documentation
5604
+ #
5605
+ class TooManyTagKeysException < Struct.new(
5606
+ :message)
5607
+ SENSITIVE = []
5608
+ include Aws::Structure
5609
+ end
5610
+
5611
+ # You have exceeded the maximum number of tags you can apply to this
5612
+ # resource.
5613
+ #
5614
+ # @!attribute [rw] message
5615
+ # @return [String]
5616
+ #
5617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TooManyTagsException AWS API Documentation
5618
+ #
5619
+ class TooManyTagsException < Struct.new(
5620
+ :message)
5621
+ SENSITIVE = []
5622
+ include Aws::Structure
5623
+ end
5624
+
5190
5625
  # If hyperparameter optimization (HPO) was performed, contains the
5191
5626
  # hyperparameter values of the best performing model.
5192
5627
  #
@@ -5202,6 +5637,35 @@ module Aws::Personalize
5202
5637
  include Aws::Structure
5203
5638
  end
5204
5639
 
5640
+ # @note When making an API call, you may pass UntagResourceRequest
5641
+ # data as a hash:
5642
+ #
5643
+ # {
5644
+ # resource_arn: "Arn", # required
5645
+ # tag_keys: ["TagKey"], # required
5646
+ # }
5647
+ #
5648
+ # @!attribute [rw] resource_arn
5649
+ # The resource's Amazon Resource Name (ARN).
5650
+ # @return [String]
5651
+ #
5652
+ # @!attribute [rw] tag_keys
5653
+ # Keys to remove from the resource's tags.
5654
+ # @return [Array<String>]
5655
+ #
5656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResourceRequest AWS API Documentation
5657
+ #
5658
+ class UntagResourceRequest < Struct.new(
5659
+ :resource_arn,
5660
+ :tag_keys)
5661
+ SENSITIVE = []
5662
+ include Aws::Structure
5663
+ end
5664
+
5665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResourceResponse AWS API Documentation
5666
+ #
5667
+ class UntagResourceResponse < Aws::EmptyStructure; end
5668
+
5205
5669
  # @note When making an API call, you may pass UpdateCampaignRequest
5206
5670
  # data as a hash:
5207
5671
  #