aws-sdk-personalize 1.44.0 → 1.46.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +282 -1
- data/lib/aws-sdk-personalize/client_api.rb +181 -0
- data/lib/aws-sdk-personalize/endpoint_provider.rb +35 -96
- data/lib/aws-sdk-personalize/endpoints.rb +84 -0
- data/lib/aws-sdk-personalize/plugins/endpoints.rb +12 -0
- data/lib/aws-sdk-personalize/types.rb +384 -942
- data/lib/aws-sdk-personalize.rb +1 -1
- metadata +2 -2
@@ -101,14 +101,6 @@ module Aws::Personalize
|
|
101
101
|
#
|
102
102
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
103
103
|
#
|
104
|
-
# @note When making an API call, you may pass AutoMLConfig
|
105
|
-
# data as a hash:
|
106
|
-
#
|
107
|
-
# {
|
108
|
-
# metric_name: "MetricName",
|
109
|
-
# recipe_list: ["Arn"],
|
110
|
-
# }
|
111
|
-
#
|
112
104
|
# @!attribute [rw] metric_name
|
113
105
|
# The metric to optimize.
|
114
106
|
# @return [String]
|
@@ -238,15 +230,6 @@ module Aws::Personalize
|
|
238
230
|
|
239
231
|
# The configuration details of a batch inference job.
|
240
232
|
#
|
241
|
-
# @note When making an API call, you may pass BatchInferenceJobConfig
|
242
|
-
# data as a hash:
|
243
|
-
#
|
244
|
-
# {
|
245
|
-
# item_exploration_config: {
|
246
|
-
# "ParameterName" => "ParameterValue",
|
247
|
-
# },
|
248
|
-
# }
|
249
|
-
#
|
250
233
|
# @!attribute [rw] item_exploration_config
|
251
234
|
# A string to string map specifying the exploration configuration
|
252
235
|
# hyperparameters, including `explorationWeight` and
|
@@ -269,16 +252,6 @@ module Aws::Personalize
|
|
269
252
|
|
270
253
|
# The input configuration of a batch inference job.
|
271
254
|
#
|
272
|
-
# @note When making an API call, you may pass BatchInferenceJobInput
|
273
|
-
# data as a hash:
|
274
|
-
#
|
275
|
-
# {
|
276
|
-
# s3_data_source: { # required
|
277
|
-
# path: "S3Location", # required
|
278
|
-
# kms_key_arn: "KmsKeyArn",
|
279
|
-
# },
|
280
|
-
# }
|
281
|
-
#
|
282
255
|
# @!attribute [rw] s3_data_source
|
283
256
|
# The URI of the Amazon S3 location that contains your input data. The
|
284
257
|
# Amazon S3 bucket must be in the same region as the API endpoint you
|
@@ -295,16 +268,6 @@ module Aws::Personalize
|
|
295
268
|
|
296
269
|
# The output configuration parameters of a batch inference job.
|
297
270
|
#
|
298
|
-
# @note When making an API call, you may pass BatchInferenceJobOutput
|
299
|
-
# data as a hash:
|
300
|
-
#
|
301
|
-
# {
|
302
|
-
# s3_data_destination: { # required
|
303
|
-
# path: "S3Location", # required
|
304
|
-
# kms_key_arn: "KmsKeyArn",
|
305
|
-
# },
|
306
|
-
# }
|
307
|
-
#
|
308
271
|
# @!attribute [rw] s3_data_destination
|
309
272
|
# Information on the Amazon S3 bucket in which the batch inference
|
310
273
|
# job's output is stored.
|
@@ -463,16 +426,6 @@ module Aws::Personalize
|
|
463
426
|
|
464
427
|
# The input configuration of a batch segment job.
|
465
428
|
#
|
466
|
-
# @note When making an API call, you may pass BatchSegmentJobInput
|
467
|
-
# data as a hash:
|
468
|
-
#
|
469
|
-
# {
|
470
|
-
# s3_data_source: { # required
|
471
|
-
# path: "S3Location", # required
|
472
|
-
# kms_key_arn: "KmsKeyArn",
|
473
|
-
# },
|
474
|
-
# }
|
475
|
-
#
|
476
429
|
# @!attribute [rw] s3_data_source
|
477
430
|
# The configuration details of an Amazon S3 input or output bucket.
|
478
431
|
# @return [Types::S3DataConfig]
|
@@ -487,16 +440,6 @@ module Aws::Personalize
|
|
487
440
|
|
488
441
|
# The output configuration parameters of a batch segment job.
|
489
442
|
#
|
490
|
-
# @note When making an API call, you may pass BatchSegmentJobOutput
|
491
|
-
# data as a hash:
|
492
|
-
#
|
493
|
-
# {
|
494
|
-
# s3_data_destination: { # required
|
495
|
-
# path: "S3Location", # required
|
496
|
-
# kms_key_arn: "KmsKeyArn",
|
497
|
-
# },
|
498
|
-
# }
|
499
|
-
#
|
500
443
|
# @!attribute [rw] s3_data_destination
|
501
444
|
# The configuration details of an Amazon S3 input or output bucket.
|
502
445
|
# @return [Types::S3DataConfig]
|
@@ -651,15 +594,6 @@ module Aws::Personalize
|
|
651
594
|
|
652
595
|
# The configuration details of a campaign.
|
653
596
|
#
|
654
|
-
# @note When making an API call, you may pass CampaignConfig
|
655
|
-
# data as a hash:
|
656
|
-
#
|
657
|
-
# {
|
658
|
-
# item_exploration_config: {
|
659
|
-
# "ParameterName" => "ParameterValue",
|
660
|
-
# },
|
661
|
-
# }
|
662
|
-
#
|
663
597
|
# @!attribute [rw] item_exploration_config
|
664
598
|
# Specifies the exploration configuration hyperparameters, including
|
665
599
|
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
@@ -792,14 +726,6 @@ module Aws::Personalize
|
|
792
726
|
|
793
727
|
# Provides the name and range of a categorical hyperparameter.
|
794
728
|
#
|
795
|
-
# @note When making an API call, you may pass CategoricalHyperParameterRange
|
796
|
-
# data as a hash:
|
797
|
-
#
|
798
|
-
# {
|
799
|
-
# name: "ParameterName",
|
800
|
-
# values: ["CategoricalValue"],
|
801
|
-
# }
|
802
|
-
#
|
803
729
|
# @!attribute [rw] name
|
804
730
|
# The name of the hyperparameter.
|
805
731
|
# @return [String]
|
@@ -819,15 +745,6 @@ module Aws::Personalize
|
|
819
745
|
|
820
746
|
# Provides the name and range of a continuous hyperparameter.
|
821
747
|
#
|
822
|
-
# @note When making an API call, you may pass ContinuousHyperParameterRange
|
823
|
-
# data as a hash:
|
824
|
-
#
|
825
|
-
# {
|
826
|
-
# name: "ParameterName",
|
827
|
-
# min_value: 1.0,
|
828
|
-
# max_value: 1.0,
|
829
|
-
# }
|
830
|
-
#
|
831
748
|
# @!attribute [rw] name
|
832
749
|
# The name of the hyperparameter.
|
833
750
|
# @return [String]
|
@@ -850,40 +767,6 @@ module Aws::Personalize
|
|
850
767
|
include Aws::Structure
|
851
768
|
end
|
852
769
|
|
853
|
-
# @note When making an API call, you may pass CreateBatchInferenceJobRequest
|
854
|
-
# data as a hash:
|
855
|
-
#
|
856
|
-
# {
|
857
|
-
# job_name: "Name", # required
|
858
|
-
# solution_version_arn: "Arn", # required
|
859
|
-
# filter_arn: "Arn",
|
860
|
-
# num_results: 1,
|
861
|
-
# job_input: { # required
|
862
|
-
# s3_data_source: { # required
|
863
|
-
# path: "S3Location", # required
|
864
|
-
# kms_key_arn: "KmsKeyArn",
|
865
|
-
# },
|
866
|
-
# },
|
867
|
-
# job_output: { # required
|
868
|
-
# s3_data_destination: { # required
|
869
|
-
# path: "S3Location", # required
|
870
|
-
# kms_key_arn: "KmsKeyArn",
|
871
|
-
# },
|
872
|
-
# },
|
873
|
-
# role_arn: "RoleArn", # required
|
874
|
-
# batch_inference_job_config: {
|
875
|
-
# item_exploration_config: {
|
876
|
-
# "ParameterName" => "ParameterValue",
|
877
|
-
# },
|
878
|
-
# },
|
879
|
-
# tags: [
|
880
|
-
# {
|
881
|
-
# tag_key: "TagKey", # required
|
882
|
-
# tag_value: "TagValue", # required
|
883
|
-
# },
|
884
|
-
# ],
|
885
|
-
# }
|
886
|
-
#
|
887
770
|
# @!attribute [rw] job_name
|
888
771
|
# The name of the batch inference job to create.
|
889
772
|
# @return [String]
|
@@ -963,35 +846,6 @@ module Aws::Personalize
|
|
963
846
|
include Aws::Structure
|
964
847
|
end
|
965
848
|
|
966
|
-
# @note When making an API call, you may pass CreateBatchSegmentJobRequest
|
967
|
-
# data as a hash:
|
968
|
-
#
|
969
|
-
# {
|
970
|
-
# job_name: "Name", # required
|
971
|
-
# solution_version_arn: "Arn", # required
|
972
|
-
# filter_arn: "Arn",
|
973
|
-
# num_results: 1,
|
974
|
-
# job_input: { # required
|
975
|
-
# s3_data_source: { # required
|
976
|
-
# path: "S3Location", # required
|
977
|
-
# kms_key_arn: "KmsKeyArn",
|
978
|
-
# },
|
979
|
-
# },
|
980
|
-
# job_output: { # required
|
981
|
-
# s3_data_destination: { # required
|
982
|
-
# path: "S3Location", # required
|
983
|
-
# kms_key_arn: "KmsKeyArn",
|
984
|
-
# },
|
985
|
-
# },
|
986
|
-
# role_arn: "RoleArn", # required
|
987
|
-
# tags: [
|
988
|
-
# {
|
989
|
-
# tag_key: "TagKey", # required
|
990
|
-
# tag_value: "TagValue", # required
|
991
|
-
# },
|
992
|
-
# ],
|
993
|
-
# }
|
994
|
-
#
|
995
849
|
# @!attribute [rw] job_name
|
996
850
|
# The name of the batch segment job to create.
|
997
851
|
# @return [String]
|
@@ -1067,26 +921,6 @@ module Aws::Personalize
|
|
1067
921
|
include Aws::Structure
|
1068
922
|
end
|
1069
923
|
|
1070
|
-
# @note When making an API call, you may pass CreateCampaignRequest
|
1071
|
-
# data as a hash:
|
1072
|
-
#
|
1073
|
-
# {
|
1074
|
-
# name: "Name", # required
|
1075
|
-
# solution_version_arn: "Arn", # required
|
1076
|
-
# min_provisioned_tps: 1,
|
1077
|
-
# campaign_config: {
|
1078
|
-
# item_exploration_config: {
|
1079
|
-
# "ParameterName" => "ParameterValue",
|
1080
|
-
# },
|
1081
|
-
# },
|
1082
|
-
# tags: [
|
1083
|
-
# {
|
1084
|
-
# tag_key: "TagKey", # required
|
1085
|
-
# tag_value: "TagValue", # required
|
1086
|
-
# },
|
1087
|
-
# ],
|
1088
|
-
# }
|
1089
|
-
#
|
1090
924
|
# @!attribute [rw] name
|
1091
925
|
# A name for the new campaign. The campaign name must be unique within
|
1092
926
|
# your account.
|
@@ -1137,28 +971,6 @@ module Aws::Personalize
|
|
1137
971
|
include Aws::Structure
|
1138
972
|
end
|
1139
973
|
|
1140
|
-
# @note When making an API call, you may pass CreateDatasetExportJobRequest
|
1141
|
-
# data as a hash:
|
1142
|
-
#
|
1143
|
-
# {
|
1144
|
-
# job_name: "Name", # required
|
1145
|
-
# dataset_arn: "Arn", # required
|
1146
|
-
# ingestion_mode: "BULK", # accepts BULK, PUT, ALL
|
1147
|
-
# role_arn: "RoleArn", # required
|
1148
|
-
# job_output: { # required
|
1149
|
-
# s3_data_destination: { # required
|
1150
|
-
# path: "S3Location", # required
|
1151
|
-
# kms_key_arn: "KmsKeyArn",
|
1152
|
-
# },
|
1153
|
-
# },
|
1154
|
-
# tags: [
|
1155
|
-
# {
|
1156
|
-
# tag_key: "TagKey", # required
|
1157
|
-
# tag_value: "TagValue", # required
|
1158
|
-
# },
|
1159
|
-
# ],
|
1160
|
-
# }
|
1161
|
-
#
|
1162
974
|
# @!attribute [rw] job_name
|
1163
975
|
# The name for the dataset export job.
|
1164
976
|
# @return [String]
|
@@ -1218,22 +1030,6 @@ module Aws::Personalize
|
|
1218
1030
|
include Aws::Structure
|
1219
1031
|
end
|
1220
1032
|
|
1221
|
-
# @note When making an API call, you may pass CreateDatasetGroupRequest
|
1222
|
-
# data as a hash:
|
1223
|
-
#
|
1224
|
-
# {
|
1225
|
-
# name: "Name", # required
|
1226
|
-
# role_arn: "RoleArn",
|
1227
|
-
# kms_key_arn: "KmsKeyArn",
|
1228
|
-
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
1229
|
-
# tags: [
|
1230
|
-
# {
|
1231
|
-
# tag_key: "TagKey", # required
|
1232
|
-
# tag_value: "TagValue", # required
|
1233
|
-
# },
|
1234
|
-
# ],
|
1235
|
-
# }
|
1236
|
-
#
|
1237
1033
|
# @!attribute [rw] name
|
1238
1034
|
# The name for the new dataset group.
|
1239
1035
|
# @return [String]
|
@@ -1294,25 +1090,6 @@ module Aws::Personalize
|
|
1294
1090
|
include Aws::Structure
|
1295
1091
|
end
|
1296
1092
|
|
1297
|
-
# @note When making an API call, you may pass CreateDatasetImportJobRequest
|
1298
|
-
# data as a hash:
|
1299
|
-
#
|
1300
|
-
# {
|
1301
|
-
# job_name: "Name", # required
|
1302
|
-
# dataset_arn: "Arn", # required
|
1303
|
-
# data_source: { # required
|
1304
|
-
# data_location: "S3Location",
|
1305
|
-
# },
|
1306
|
-
# role_arn: "RoleArn", # required
|
1307
|
-
# tags: [
|
1308
|
-
# {
|
1309
|
-
# tag_key: "TagKey", # required
|
1310
|
-
# tag_value: "TagValue", # required
|
1311
|
-
# },
|
1312
|
-
# ],
|
1313
|
-
# import_mode: "FULL", # accepts FULL, INCREMENTAL
|
1314
|
-
# }
|
1315
|
-
#
|
1316
1093
|
# @!attribute [rw] job_name
|
1317
1094
|
# The name for the dataset import job.
|
1318
1095
|
# @return [String]
|
@@ -1351,6 +1128,11 @@ module Aws::Personalize
|
|
1351
1128
|
# the same ID with the new one.
|
1352
1129
|
# @return [String]
|
1353
1130
|
#
|
1131
|
+
# @!attribute [rw] publish_attribution_metrics_to_s3
|
1132
|
+
# If you created a metric attribution, specify whether to publish
|
1133
|
+
# metrics for this import job to Amazon S3
|
1134
|
+
# @return [Boolean]
|
1135
|
+
#
|
1354
1136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJobRequest AWS API Documentation
|
1355
1137
|
#
|
1356
1138
|
class CreateDatasetImportJobRequest < Struct.new(
|
@@ -1359,7 +1141,8 @@ module Aws::Personalize
|
|
1359
1141
|
:data_source,
|
1360
1142
|
:role_arn,
|
1361
1143
|
:tags,
|
1362
|
-
:import_mode
|
1144
|
+
:import_mode,
|
1145
|
+
:publish_attribution_metrics_to_s3)
|
1363
1146
|
SENSITIVE = []
|
1364
1147
|
include Aws::Structure
|
1365
1148
|
end
|
@@ -1376,22 +1159,6 @@ module Aws::Personalize
|
|
1376
1159
|
include Aws::Structure
|
1377
1160
|
end
|
1378
1161
|
|
1379
|
-
# @note When making an API call, you may pass CreateDatasetRequest
|
1380
|
-
# data as a hash:
|
1381
|
-
#
|
1382
|
-
# {
|
1383
|
-
# name: "Name", # required
|
1384
|
-
# schema_arn: "Arn", # required
|
1385
|
-
# dataset_group_arn: "Arn", # required
|
1386
|
-
# dataset_type: "DatasetType", # required
|
1387
|
-
# tags: [
|
1388
|
-
# {
|
1389
|
-
# tag_key: "TagKey", # required
|
1390
|
-
# tag_value: "TagValue", # required
|
1391
|
-
# },
|
1392
|
-
# ],
|
1393
|
-
# }
|
1394
|
-
#
|
1395
1162
|
# @!attribute [rw] name
|
1396
1163
|
# The name for the dataset.
|
1397
1164
|
# @return [String]
|
@@ -1450,20 +1217,6 @@ module Aws::Personalize
|
|
1450
1217
|
include Aws::Structure
|
1451
1218
|
end
|
1452
1219
|
|
1453
|
-
# @note When making an API call, you may pass CreateEventTrackerRequest
|
1454
|
-
# data as a hash:
|
1455
|
-
#
|
1456
|
-
# {
|
1457
|
-
# name: "Name", # required
|
1458
|
-
# dataset_group_arn: "Arn", # required
|
1459
|
-
# tags: [
|
1460
|
-
# {
|
1461
|
-
# tag_key: "TagKey", # required
|
1462
|
-
# tag_value: "TagValue", # required
|
1463
|
-
# },
|
1464
|
-
# ],
|
1465
|
-
# }
|
1466
|
-
#
|
1467
1220
|
# @!attribute [rw] name
|
1468
1221
|
# The name for the event tracker.
|
1469
1222
|
# @return [String]
|
@@ -1513,21 +1266,6 @@ module Aws::Personalize
|
|
1513
1266
|
include Aws::Structure
|
1514
1267
|
end
|
1515
1268
|
|
1516
|
-
# @note When making an API call, you may pass CreateFilterRequest
|
1517
|
-
# data as a hash:
|
1518
|
-
#
|
1519
|
-
# {
|
1520
|
-
# name: "Name", # required
|
1521
|
-
# dataset_group_arn: "Arn", # required
|
1522
|
-
# filter_expression: "FilterExpression", # required
|
1523
|
-
# tags: [
|
1524
|
-
# {
|
1525
|
-
# tag_key: "TagKey", # required
|
1526
|
-
# tag_value: "TagValue", # required
|
1527
|
-
# },
|
1528
|
-
# ],
|
1529
|
-
# }
|
1530
|
-
#
|
1531
1269
|
# @!attribute [rw] name
|
1532
1270
|
# The name of the filter to create.
|
1533
1271
|
# @return [String]
|
@@ -1578,27 +1316,50 @@ module Aws::Personalize
|
|
1578
1316
|
include Aws::Structure
|
1579
1317
|
end
|
1580
1318
|
|
1581
|
-
#
|
1582
|
-
#
|
1319
|
+
# @!attribute [rw] name
|
1320
|
+
# A name for the metric attribution.
|
1321
|
+
# @return [String]
|
1583
1322
|
#
|
1584
|
-
#
|
1585
|
-
#
|
1586
|
-
#
|
1587
|
-
#
|
1588
|
-
# recommender_config: {
|
1589
|
-
# item_exploration_config: {
|
1590
|
-
# "ParameterName" => "ParameterValue",
|
1591
|
-
# },
|
1592
|
-
# min_recommendation_requests_per_second: 1,
|
1593
|
-
# },
|
1594
|
-
# tags: [
|
1595
|
-
# {
|
1596
|
-
# tag_key: "TagKey", # required
|
1597
|
-
# tag_value: "TagValue", # required
|
1598
|
-
# },
|
1599
|
-
# ],
|
1600
|
-
# }
|
1323
|
+
# @!attribute [rw] dataset_group_arn
|
1324
|
+
# The Amazon Resource Name (ARN) of the destination dataset group for
|
1325
|
+
# the metric attribution.
|
1326
|
+
# @return [String]
|
1601
1327
|
#
|
1328
|
+
# @!attribute [rw] metrics
|
1329
|
+
# A list of metric attributes for the metric attribution. Each metric
|
1330
|
+
# attribute specifies an event type to track and a function. Available
|
1331
|
+
# functions are `SUM()` or `SAMPLECOUNT()`. For SUM() functions,
|
1332
|
+
# provide the dataset type (either Interactions or Items) and column
|
1333
|
+
# to sum as a parameter. For example SUM(Items.PRICE).
|
1334
|
+
# @return [Array<Types::MetricAttribute>]
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] metrics_output_config
|
1337
|
+
# The output configuration details for the metric attribution.
|
1338
|
+
# @return [Types::MetricAttributionOutput]
|
1339
|
+
#
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateMetricAttributionRequest AWS API Documentation
|
1341
|
+
#
|
1342
|
+
class CreateMetricAttributionRequest < Struct.new(
|
1343
|
+
:name,
|
1344
|
+
:dataset_group_arn,
|
1345
|
+
:metrics,
|
1346
|
+
:metrics_output_config)
|
1347
|
+
SENSITIVE = []
|
1348
|
+
include Aws::Structure
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
# @!attribute [rw] metric_attribution_arn
|
1352
|
+
# The Amazon Resource Name (ARN) for the new metric attribution.
|
1353
|
+
# @return [String]
|
1354
|
+
#
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateMetricAttributionResponse AWS API Documentation
|
1356
|
+
#
|
1357
|
+
class CreateMetricAttributionResponse < Struct.new(
|
1358
|
+
:metric_attribution_arn)
|
1359
|
+
SENSITIVE = []
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1602
1363
|
# @!attribute [rw] name
|
1603
1364
|
# The name of the recommender.
|
1604
1365
|
# @return [String]
|
@@ -1656,15 +1417,6 @@ module Aws::Personalize
|
|
1656
1417
|
include Aws::Structure
|
1657
1418
|
end
|
1658
1419
|
|
1659
|
-
# @note When making an API call, you may pass CreateSchemaRequest
|
1660
|
-
# data as a hash:
|
1661
|
-
#
|
1662
|
-
# {
|
1663
|
-
# name: "Name", # required
|
1664
|
-
# schema: "AvroSchema", # required
|
1665
|
-
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
1666
|
-
# }
|
1667
|
-
#
|
1668
1420
|
# @!attribute [rw] name
|
1669
1421
|
# The name for the schema.
|
1670
1422
|
# @return [String]
|
@@ -1701,74 +1453,6 @@ module Aws::Personalize
|
|
1701
1453
|
include Aws::Structure
|
1702
1454
|
end
|
1703
1455
|
|
1704
|
-
# @note When making an API call, you may pass CreateSolutionRequest
|
1705
|
-
# data as a hash:
|
1706
|
-
#
|
1707
|
-
# {
|
1708
|
-
# name: "Name", # required
|
1709
|
-
# perform_hpo: false,
|
1710
|
-
# perform_auto_ml: false,
|
1711
|
-
# recipe_arn: "Arn",
|
1712
|
-
# dataset_group_arn: "Arn", # required
|
1713
|
-
# event_type: "EventType",
|
1714
|
-
# solution_config: {
|
1715
|
-
# event_value_threshold: "EventValueThreshold",
|
1716
|
-
# hpo_config: {
|
1717
|
-
# hpo_objective: {
|
1718
|
-
# type: "HPOObjectiveType",
|
1719
|
-
# metric_name: "MetricName",
|
1720
|
-
# metric_regex: "MetricRegex",
|
1721
|
-
# },
|
1722
|
-
# hpo_resource_config: {
|
1723
|
-
# max_number_of_training_jobs: "HPOResource",
|
1724
|
-
# max_parallel_training_jobs: "HPOResource",
|
1725
|
-
# },
|
1726
|
-
# algorithm_hyper_parameter_ranges: {
|
1727
|
-
# integer_hyper_parameter_ranges: [
|
1728
|
-
# {
|
1729
|
-
# name: "ParameterName",
|
1730
|
-
# min_value: 1,
|
1731
|
-
# max_value: 1,
|
1732
|
-
# },
|
1733
|
-
# ],
|
1734
|
-
# continuous_hyper_parameter_ranges: [
|
1735
|
-
# {
|
1736
|
-
# name: "ParameterName",
|
1737
|
-
# min_value: 1.0,
|
1738
|
-
# max_value: 1.0,
|
1739
|
-
# },
|
1740
|
-
# ],
|
1741
|
-
# categorical_hyper_parameter_ranges: [
|
1742
|
-
# {
|
1743
|
-
# name: "ParameterName",
|
1744
|
-
# values: ["CategoricalValue"],
|
1745
|
-
# },
|
1746
|
-
# ],
|
1747
|
-
# },
|
1748
|
-
# },
|
1749
|
-
# algorithm_hyper_parameters: {
|
1750
|
-
# "ParameterName" => "ParameterValue",
|
1751
|
-
# },
|
1752
|
-
# feature_transformation_parameters: {
|
1753
|
-
# "ParameterName" => "ParameterValue",
|
1754
|
-
# },
|
1755
|
-
# auto_ml_config: {
|
1756
|
-
# metric_name: "MetricName",
|
1757
|
-
# recipe_list: ["Arn"],
|
1758
|
-
# },
|
1759
|
-
# optimization_objective: {
|
1760
|
-
# item_attribute: "ItemAttribute",
|
1761
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
1762
|
-
# },
|
1763
|
-
# },
|
1764
|
-
# tags: [
|
1765
|
-
# {
|
1766
|
-
# tag_key: "TagKey", # required
|
1767
|
-
# tag_value: "TagValue", # required
|
1768
|
-
# },
|
1769
|
-
# ],
|
1770
|
-
# }
|
1771
|
-
#
|
1772
1456
|
# @!attribute [rw] name
|
1773
1457
|
# The name for the solution.
|
1774
1458
|
# @return [String]
|
@@ -1858,19 +1542,9 @@ module Aws::Personalize
|
|
1858
1542
|
include Aws::Structure
|
1859
1543
|
end
|
1860
1544
|
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
# {
|
1865
|
-
# solution_arn: "Arn", # required
|
1866
|
-
# training_mode: "FULL", # accepts FULL, UPDATE
|
1867
|
-
# tags: [
|
1868
|
-
# {
|
1869
|
-
# tag_key: "TagKey", # required
|
1870
|
-
# tag_value: "TagValue", # required
|
1871
|
-
# },
|
1872
|
-
# ],
|
1873
|
-
# }
|
1545
|
+
# @!attribute [rw] name
|
1546
|
+
# The name of the solution version.
|
1547
|
+
# @return [String]
|
1874
1548
|
#
|
1875
1549
|
# @!attribute [rw] solution_arn
|
1876
1550
|
# The Amazon Resource Name (ARN) of the solution containing the
|
@@ -1908,6 +1582,7 @@ module Aws::Personalize
|
|
1908
1582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
|
1909
1583
|
#
|
1910
1584
|
class CreateSolutionVersionRequest < Struct.new(
|
1585
|
+
:name,
|
1911
1586
|
:solution_arn,
|
1912
1587
|
:training_mode,
|
1913
1588
|
:tags)
|
@@ -1930,13 +1605,6 @@ module Aws::Personalize
|
|
1930
1605
|
# Describes the data source that contains the data to upload to a
|
1931
1606
|
# dataset.
|
1932
1607
|
#
|
1933
|
-
# @note When making an API call, you may pass DataSource
|
1934
|
-
# data as a hash:
|
1935
|
-
#
|
1936
|
-
# {
|
1937
|
-
# data_location: "S3Location",
|
1938
|
-
# }
|
1939
|
-
#
|
1940
1608
|
# @!attribute [rw] data_location
|
1941
1609
|
# The path to the Amazon S3 bucket where the data that you want to
|
1942
1610
|
# upload to your dataset is stored. For example:
|
@@ -2104,16 +1772,6 @@ module Aws::Personalize
|
|
2104
1772
|
|
2105
1773
|
# The output configuration parameters of a dataset export job.
|
2106
1774
|
#
|
2107
|
-
# @note When making an API call, you may pass DatasetExportJobOutput
|
2108
|
-
# data as a hash:
|
2109
|
-
#
|
2110
|
-
# {
|
2111
|
-
# s3_data_destination: { # required
|
2112
|
-
# path: "S3Location", # required
|
2113
|
-
# kms_key_arn: "KmsKeyArn",
|
2114
|
-
# },
|
2115
|
-
# }
|
2116
|
-
#
|
2117
1775
|
# @!attribute [rw] s3_data_destination
|
2118
1776
|
# The configuration details of an Amazon S3 input or output bucket.
|
2119
1777
|
# @return [Types::S3DataConfig]
|
@@ -2378,6 +2036,11 @@ module Aws::Personalize
|
|
2378
2036
|
# records.
|
2379
2037
|
# @return [String]
|
2380
2038
|
#
|
2039
|
+
# @!attribute [rw] publish_attribution_metrics_to_s3
|
2040
|
+
# Whether the job publishes metrics to Amazon S3 for a metric
|
2041
|
+
# attribution.
|
2042
|
+
# @return [Boolean]
|
2043
|
+
#
|
2381
2044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetImportJob AWS API Documentation
|
2382
2045
|
#
|
2383
2046
|
class DatasetImportJob < Struct.new(
|
@@ -2390,7 +2053,8 @@ module Aws::Personalize
|
|
2390
2053
|
:creation_date_time,
|
2391
2054
|
:last_updated_date_time,
|
2392
2055
|
:failure_reason,
|
2393
|
-
:import_mode
|
2056
|
+
:import_mode,
|
2057
|
+
:publish_attribution_metrics_to_s3)
|
2394
2058
|
SENSITIVE = []
|
2395
2059
|
include Aws::Structure
|
2396
2060
|
end
|
@@ -2718,13 +2382,6 @@ module Aws::Personalize
|
|
2718
2382
|
include Aws::Structure
|
2719
2383
|
end
|
2720
2384
|
|
2721
|
-
# @note When making an API call, you may pass DeleteCampaignRequest
|
2722
|
-
# data as a hash:
|
2723
|
-
#
|
2724
|
-
# {
|
2725
|
-
# campaign_arn: "Arn", # required
|
2726
|
-
# }
|
2727
|
-
#
|
2728
2385
|
# @!attribute [rw] campaign_arn
|
2729
2386
|
# The Amazon Resource Name (ARN) of the campaign to delete.
|
2730
2387
|
# @return [String]
|
@@ -2737,13 +2394,6 @@ module Aws::Personalize
|
|
2737
2394
|
include Aws::Structure
|
2738
2395
|
end
|
2739
2396
|
|
2740
|
-
# @note When making an API call, you may pass DeleteDatasetGroupRequest
|
2741
|
-
# data as a hash:
|
2742
|
-
#
|
2743
|
-
# {
|
2744
|
-
# dataset_group_arn: "Arn", # required
|
2745
|
-
# }
|
2746
|
-
#
|
2747
2397
|
# @!attribute [rw] dataset_group_arn
|
2748
2398
|
# The ARN of the dataset group to delete.
|
2749
2399
|
# @return [String]
|
@@ -2756,13 +2406,6 @@ module Aws::Personalize
|
|
2756
2406
|
include Aws::Structure
|
2757
2407
|
end
|
2758
2408
|
|
2759
|
-
# @note When making an API call, you may pass DeleteDatasetRequest
|
2760
|
-
# data as a hash:
|
2761
|
-
#
|
2762
|
-
# {
|
2763
|
-
# dataset_arn: "Arn", # required
|
2764
|
-
# }
|
2765
|
-
#
|
2766
2409
|
# @!attribute [rw] dataset_arn
|
2767
2410
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
2768
2411
|
# @return [String]
|
@@ -2775,13 +2418,6 @@ module Aws::Personalize
|
|
2775
2418
|
include Aws::Structure
|
2776
2419
|
end
|
2777
2420
|
|
2778
|
-
# @note When making an API call, you may pass DeleteEventTrackerRequest
|
2779
|
-
# data as a hash:
|
2780
|
-
#
|
2781
|
-
# {
|
2782
|
-
# event_tracker_arn: "Arn", # required
|
2783
|
-
# }
|
2784
|
-
#
|
2785
2421
|
# @!attribute [rw] event_tracker_arn
|
2786
2422
|
# The Amazon Resource Name (ARN) of the event tracker to delete.
|
2787
2423
|
# @return [String]
|
@@ -2794,13 +2430,6 @@ module Aws::Personalize
|
|
2794
2430
|
include Aws::Structure
|
2795
2431
|
end
|
2796
2432
|
|
2797
|
-
# @note When making an API call, you may pass DeleteFilterRequest
|
2798
|
-
# data as a hash:
|
2799
|
-
#
|
2800
|
-
# {
|
2801
|
-
# filter_arn: "Arn", # required
|
2802
|
-
# }
|
2803
|
-
#
|
2804
2433
|
# @!attribute [rw] filter_arn
|
2805
2434
|
# The ARN of the filter to delete.
|
2806
2435
|
# @return [String]
|
@@ -2813,13 +2442,18 @@ module Aws::Personalize
|
|
2813
2442
|
include Aws::Structure
|
2814
2443
|
end
|
2815
2444
|
|
2816
|
-
#
|
2817
|
-
#
|
2445
|
+
# @!attribute [rw] metric_attribution_arn
|
2446
|
+
# The metric attribution's Amazon Resource Name (ARN).
|
2447
|
+
# @return [String]
|
2818
2448
|
#
|
2819
|
-
#
|
2820
|
-
# recommender_arn: "Arn", # required
|
2821
|
-
# }
|
2449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteMetricAttributionRequest AWS API Documentation
|
2822
2450
|
#
|
2451
|
+
class DeleteMetricAttributionRequest < Struct.new(
|
2452
|
+
:metric_attribution_arn)
|
2453
|
+
SENSITIVE = []
|
2454
|
+
include Aws::Structure
|
2455
|
+
end
|
2456
|
+
|
2823
2457
|
# @!attribute [rw] recommender_arn
|
2824
2458
|
# The Amazon Resource Name (ARN) of the recommender to delete.
|
2825
2459
|
# @return [String]
|
@@ -2832,13 +2466,6 @@ module Aws::Personalize
|
|
2832
2466
|
include Aws::Structure
|
2833
2467
|
end
|
2834
2468
|
|
2835
|
-
# @note When making an API call, you may pass DeleteSchemaRequest
|
2836
|
-
# data as a hash:
|
2837
|
-
#
|
2838
|
-
# {
|
2839
|
-
# schema_arn: "Arn", # required
|
2840
|
-
# }
|
2841
|
-
#
|
2842
2469
|
# @!attribute [rw] schema_arn
|
2843
2470
|
# The Amazon Resource Name (ARN) of the schema to delete.
|
2844
2471
|
# @return [String]
|
@@ -2851,13 +2478,6 @@ module Aws::Personalize
|
|
2851
2478
|
include Aws::Structure
|
2852
2479
|
end
|
2853
2480
|
|
2854
|
-
# @note When making an API call, you may pass DeleteSolutionRequest
|
2855
|
-
# data as a hash:
|
2856
|
-
#
|
2857
|
-
# {
|
2858
|
-
# solution_arn: "Arn", # required
|
2859
|
-
# }
|
2860
|
-
#
|
2861
2481
|
# @!attribute [rw] solution_arn
|
2862
2482
|
# The ARN of the solution to delete.
|
2863
2483
|
# @return [String]
|
@@ -2870,13 +2490,6 @@ module Aws::Personalize
|
|
2870
2490
|
include Aws::Structure
|
2871
2491
|
end
|
2872
2492
|
|
2873
|
-
# @note When making an API call, you may pass DescribeAlgorithmRequest
|
2874
|
-
# data as a hash:
|
2875
|
-
#
|
2876
|
-
# {
|
2877
|
-
# algorithm_arn: "Arn", # required
|
2878
|
-
# }
|
2879
|
-
#
|
2880
2493
|
# @!attribute [rw] algorithm_arn
|
2881
2494
|
# The Amazon Resource Name (ARN) of the algorithm to describe.
|
2882
2495
|
# @return [String]
|
@@ -2901,13 +2514,6 @@ module Aws::Personalize
|
|
2901
2514
|
include Aws::Structure
|
2902
2515
|
end
|
2903
2516
|
|
2904
|
-
# @note When making an API call, you may pass DescribeBatchInferenceJobRequest
|
2905
|
-
# data as a hash:
|
2906
|
-
#
|
2907
|
-
# {
|
2908
|
-
# batch_inference_job_arn: "Arn", # required
|
2909
|
-
# }
|
2910
|
-
#
|
2911
2517
|
# @!attribute [rw] batch_inference_job_arn
|
2912
2518
|
# The ARN of the batch inference job to describe.
|
2913
2519
|
# @return [String]
|
@@ -2932,13 +2538,6 @@ module Aws::Personalize
|
|
2932
2538
|
include Aws::Structure
|
2933
2539
|
end
|
2934
2540
|
|
2935
|
-
# @note When making an API call, you may pass DescribeBatchSegmentJobRequest
|
2936
|
-
# data as a hash:
|
2937
|
-
#
|
2938
|
-
# {
|
2939
|
-
# batch_segment_job_arn: "Arn", # required
|
2940
|
-
# }
|
2941
|
-
#
|
2942
2541
|
# @!attribute [rw] batch_segment_job_arn
|
2943
2542
|
# The ARN of the batch segment job to describe.
|
2944
2543
|
# @return [String]
|
@@ -2963,13 +2562,6 @@ module Aws::Personalize
|
|
2963
2562
|
include Aws::Structure
|
2964
2563
|
end
|
2965
2564
|
|
2966
|
-
# @note When making an API call, you may pass DescribeCampaignRequest
|
2967
|
-
# data as a hash:
|
2968
|
-
#
|
2969
|
-
# {
|
2970
|
-
# campaign_arn: "Arn", # required
|
2971
|
-
# }
|
2972
|
-
#
|
2973
2565
|
# @!attribute [rw] campaign_arn
|
2974
2566
|
# The Amazon Resource Name (ARN) of the campaign.
|
2975
2567
|
# @return [String]
|
@@ -2994,13 +2586,6 @@ module Aws::Personalize
|
|
2994
2586
|
include Aws::Structure
|
2995
2587
|
end
|
2996
2588
|
|
2997
|
-
# @note When making an API call, you may pass DescribeDatasetExportJobRequest
|
2998
|
-
# data as a hash:
|
2999
|
-
#
|
3000
|
-
# {
|
3001
|
-
# dataset_export_job_arn: "Arn", # required
|
3002
|
-
# }
|
3003
|
-
#
|
3004
2589
|
# @!attribute [rw] dataset_export_job_arn
|
3005
2590
|
# The Amazon Resource Name (ARN) of the dataset export job to
|
3006
2591
|
# describe.
|
@@ -3036,13 +2621,6 @@ module Aws::Personalize
|
|
3036
2621
|
include Aws::Structure
|
3037
2622
|
end
|
3038
2623
|
|
3039
|
-
# @note When making an API call, you may pass DescribeDatasetGroupRequest
|
3040
|
-
# data as a hash:
|
3041
|
-
#
|
3042
|
-
# {
|
3043
|
-
# dataset_group_arn: "Arn", # required
|
3044
|
-
# }
|
3045
|
-
#
|
3046
2624
|
# @!attribute [rw] dataset_group_arn
|
3047
2625
|
# The Amazon Resource Name (ARN) of the dataset group to describe.
|
3048
2626
|
# @return [String]
|
@@ -3067,13 +2645,6 @@ module Aws::Personalize
|
|
3067
2645
|
include Aws::Structure
|
3068
2646
|
end
|
3069
2647
|
|
3070
|
-
# @note When making an API call, you may pass DescribeDatasetImportJobRequest
|
3071
|
-
# data as a hash:
|
3072
|
-
#
|
3073
|
-
# {
|
3074
|
-
# dataset_import_job_arn: "Arn", # required
|
3075
|
-
# }
|
3076
|
-
#
|
3077
2648
|
# @!attribute [rw] dataset_import_job_arn
|
3078
2649
|
# The Amazon Resource Name (ARN) of the dataset import job to
|
3079
2650
|
# describe.
|
@@ -3109,13 +2680,6 @@ module Aws::Personalize
|
|
3109
2680
|
include Aws::Structure
|
3110
2681
|
end
|
3111
2682
|
|
3112
|
-
# @note When making an API call, you may pass DescribeDatasetRequest
|
3113
|
-
# data as a hash:
|
3114
|
-
#
|
3115
|
-
# {
|
3116
|
-
# dataset_arn: "Arn", # required
|
3117
|
-
# }
|
3118
|
-
#
|
3119
2683
|
# @!attribute [rw] dataset_arn
|
3120
2684
|
# The Amazon Resource Name (ARN) of the dataset to describe.
|
3121
2685
|
# @return [String]
|
@@ -3140,13 +2704,6 @@ module Aws::Personalize
|
|
3140
2704
|
include Aws::Structure
|
3141
2705
|
end
|
3142
2706
|
|
3143
|
-
# @note When making an API call, you may pass DescribeEventTrackerRequest
|
3144
|
-
# data as a hash:
|
3145
|
-
#
|
3146
|
-
# {
|
3147
|
-
# event_tracker_arn: "Arn", # required
|
3148
|
-
# }
|
3149
|
-
#
|
3150
2707
|
# @!attribute [rw] event_tracker_arn
|
3151
2708
|
# The Amazon Resource Name (ARN) of the event tracker to describe.
|
3152
2709
|
# @return [String]
|
@@ -3171,13 +2728,6 @@ module Aws::Personalize
|
|
3171
2728
|
include Aws::Structure
|
3172
2729
|
end
|
3173
2730
|
|
3174
|
-
# @note When making an API call, you may pass DescribeFeatureTransformationRequest
|
3175
|
-
# data as a hash:
|
3176
|
-
#
|
3177
|
-
# {
|
3178
|
-
# feature_transformation_arn: "Arn", # required
|
3179
|
-
# }
|
3180
|
-
#
|
3181
2731
|
# @!attribute [rw] feature_transformation_arn
|
3182
2732
|
# The Amazon Resource Name (ARN) of the feature transformation to
|
3183
2733
|
# describe.
|
@@ -3203,13 +2753,6 @@ module Aws::Personalize
|
|
3203
2753
|
include Aws::Structure
|
3204
2754
|
end
|
3205
2755
|
|
3206
|
-
# @note When making an API call, you may pass DescribeFilterRequest
|
3207
|
-
# data as a hash:
|
3208
|
-
#
|
3209
|
-
# {
|
3210
|
-
# filter_arn: "Arn", # required
|
3211
|
-
# }
|
3212
|
-
#
|
3213
2756
|
# @!attribute [rw] filter_arn
|
3214
2757
|
# The ARN of the filter to describe.
|
3215
2758
|
# @return [String]
|
@@ -3234,13 +2777,30 @@ module Aws::Personalize
|
|
3234
2777
|
include Aws::Structure
|
3235
2778
|
end
|
3236
2779
|
|
3237
|
-
#
|
3238
|
-
#
|
2780
|
+
# @!attribute [rw] metric_attribution_arn
|
2781
|
+
# The metric attribution's Amazon Resource Name (ARN).
|
2782
|
+
# @return [String]
|
3239
2783
|
#
|
3240
|
-
#
|
3241
|
-
# recipe_arn: "Arn", # required
|
3242
|
-
# }
|
2784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeMetricAttributionRequest AWS API Documentation
|
3243
2785
|
#
|
2786
|
+
class DescribeMetricAttributionRequest < Struct.new(
|
2787
|
+
:metric_attribution_arn)
|
2788
|
+
SENSITIVE = []
|
2789
|
+
include Aws::Structure
|
2790
|
+
end
|
2791
|
+
|
2792
|
+
# @!attribute [rw] metric_attribution
|
2793
|
+
# The details of the metric attribution.
|
2794
|
+
# @return [Types::MetricAttribution]
|
2795
|
+
#
|
2796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeMetricAttributionResponse AWS API Documentation
|
2797
|
+
#
|
2798
|
+
class DescribeMetricAttributionResponse < Struct.new(
|
2799
|
+
:metric_attribution)
|
2800
|
+
SENSITIVE = []
|
2801
|
+
include Aws::Structure
|
2802
|
+
end
|
2803
|
+
|
3244
2804
|
# @!attribute [rw] recipe_arn
|
3245
2805
|
# The Amazon Resource Name (ARN) of the recipe to describe.
|
3246
2806
|
# @return [String]
|
@@ -3265,13 +2825,6 @@ module Aws::Personalize
|
|
3265
2825
|
include Aws::Structure
|
3266
2826
|
end
|
3267
2827
|
|
3268
|
-
# @note When making an API call, you may pass DescribeRecommenderRequest
|
3269
|
-
# data as a hash:
|
3270
|
-
#
|
3271
|
-
# {
|
3272
|
-
# recommender_arn: "Arn", # required
|
3273
|
-
# }
|
3274
|
-
#
|
3275
2828
|
# @!attribute [rw] recommender_arn
|
3276
2829
|
# The Amazon Resource Name (ARN) of the recommender to describe.
|
3277
2830
|
# @return [String]
|
@@ -3296,13 +2849,6 @@ module Aws::Personalize
|
|
3296
2849
|
include Aws::Structure
|
3297
2850
|
end
|
3298
2851
|
|
3299
|
-
# @note When making an API call, you may pass DescribeSchemaRequest
|
3300
|
-
# data as a hash:
|
3301
|
-
#
|
3302
|
-
# {
|
3303
|
-
# schema_arn: "Arn", # required
|
3304
|
-
# }
|
3305
|
-
#
|
3306
2852
|
# @!attribute [rw] schema_arn
|
3307
2853
|
# The Amazon Resource Name (ARN) of the schema to retrieve.
|
3308
2854
|
# @return [String]
|
@@ -3327,13 +2873,6 @@ module Aws::Personalize
|
|
3327
2873
|
include Aws::Structure
|
3328
2874
|
end
|
3329
2875
|
|
3330
|
-
# @note When making an API call, you may pass DescribeSolutionRequest
|
3331
|
-
# data as a hash:
|
3332
|
-
#
|
3333
|
-
# {
|
3334
|
-
# solution_arn: "Arn", # required
|
3335
|
-
# }
|
3336
|
-
#
|
3337
2876
|
# @!attribute [rw] solution_arn
|
3338
2877
|
# The Amazon Resource Name (ARN) of the solution to describe.
|
3339
2878
|
# @return [String]
|
@@ -3358,13 +2897,6 @@ module Aws::Personalize
|
|
3358
2897
|
include Aws::Structure
|
3359
2898
|
end
|
3360
2899
|
|
3361
|
-
# @note When making an API call, you may pass DescribeSolutionVersionRequest
|
3362
|
-
# data as a hash:
|
3363
|
-
#
|
3364
|
-
# {
|
3365
|
-
# solution_version_arn: "Arn", # required
|
3366
|
-
# }
|
3367
|
-
#
|
3368
2900
|
# @!attribute [rw] solution_version_arn
|
3369
2901
|
# The Amazon Resource Name (ARN) of the solution version.
|
3370
2902
|
# @return [String]
|
@@ -3651,13 +3183,6 @@ module Aws::Personalize
|
|
3651
3183
|
include Aws::Structure
|
3652
3184
|
end
|
3653
3185
|
|
3654
|
-
# @note When making an API call, you may pass GetSolutionMetricsRequest
|
3655
|
-
# data as a hash:
|
3656
|
-
#
|
3657
|
-
# {
|
3658
|
-
# solution_version_arn: "Arn", # required
|
3659
|
-
# }
|
3660
|
-
#
|
3661
3186
|
# @!attribute [rw] solution_version_arn
|
3662
3187
|
# The Amazon Resource Name (ARN) of the solution version for which to
|
3663
3188
|
# get metrics.
|
@@ -3695,43 +3220,6 @@ module Aws::Personalize
|
|
3695
3220
|
|
3696
3221
|
# Describes the properties for hyperparameter optimization (HPO).
|
3697
3222
|
#
|
3698
|
-
# @note When making an API call, you may pass HPOConfig
|
3699
|
-
# data as a hash:
|
3700
|
-
#
|
3701
|
-
# {
|
3702
|
-
# hpo_objective: {
|
3703
|
-
# type: "HPOObjectiveType",
|
3704
|
-
# metric_name: "MetricName",
|
3705
|
-
# metric_regex: "MetricRegex",
|
3706
|
-
# },
|
3707
|
-
# hpo_resource_config: {
|
3708
|
-
# max_number_of_training_jobs: "HPOResource",
|
3709
|
-
# max_parallel_training_jobs: "HPOResource",
|
3710
|
-
# },
|
3711
|
-
# algorithm_hyper_parameter_ranges: {
|
3712
|
-
# integer_hyper_parameter_ranges: [
|
3713
|
-
# {
|
3714
|
-
# name: "ParameterName",
|
3715
|
-
# min_value: 1,
|
3716
|
-
# max_value: 1,
|
3717
|
-
# },
|
3718
|
-
# ],
|
3719
|
-
# continuous_hyper_parameter_ranges: [
|
3720
|
-
# {
|
3721
|
-
# name: "ParameterName",
|
3722
|
-
# min_value: 1.0,
|
3723
|
-
# max_value: 1.0,
|
3724
|
-
# },
|
3725
|
-
# ],
|
3726
|
-
# categorical_hyper_parameter_ranges: [
|
3727
|
-
# {
|
3728
|
-
# name: "ParameterName",
|
3729
|
-
# values: ["CategoricalValue"],
|
3730
|
-
# },
|
3731
|
-
# ],
|
3732
|
-
# },
|
3733
|
-
# }
|
3734
|
-
#
|
3735
3223
|
# @!attribute [rw] hpo_objective
|
3736
3224
|
# The metric to optimize during HPO.
|
3737
3225
|
#
|
@@ -3766,15 +3254,6 @@ module Aws::Personalize
|
|
3766
3254
|
#
|
3767
3255
|
# </note>
|
3768
3256
|
#
|
3769
|
-
# @note When making an API call, you may pass HPOObjective
|
3770
|
-
# data as a hash:
|
3771
|
-
#
|
3772
|
-
# {
|
3773
|
-
# type: "HPOObjectiveType",
|
3774
|
-
# metric_name: "MetricName",
|
3775
|
-
# metric_regex: "MetricRegex",
|
3776
|
-
# }
|
3777
|
-
#
|
3778
3257
|
# @!attribute [rw] type
|
3779
3258
|
# The type of the metric. Valid values are `Maximize` and `Minimize`.
|
3780
3259
|
# @return [String]
|
@@ -3801,14 +3280,6 @@ module Aws::Personalize
|
|
3801
3280
|
# Describes the resource configuration for hyperparameter optimization
|
3802
3281
|
# (HPO).
|
3803
3282
|
#
|
3804
|
-
# @note When making an API call, you may pass HPOResourceConfig
|
3805
|
-
# data as a hash:
|
3806
|
-
#
|
3807
|
-
# {
|
3808
|
-
# max_number_of_training_jobs: "HPOResource",
|
3809
|
-
# max_parallel_training_jobs: "HPOResource",
|
3810
|
-
# }
|
3811
|
-
#
|
3812
3283
|
# @!attribute [rw] max_number_of_training_jobs
|
3813
3284
|
# The maximum number of training jobs when you create a solution
|
3814
3285
|
# version. The maximum value for `maxNumberOfTrainingJobs` is `40`.
|
@@ -3832,32 +3303,6 @@ module Aws::Personalize
|
|
3832
3303
|
# Specifies the hyperparameters and their ranges. Hyperparameters can be
|
3833
3304
|
# categorical, continuous, or integer-valued.
|
3834
3305
|
#
|
3835
|
-
# @note When making an API call, you may pass HyperParameterRanges
|
3836
|
-
# data as a hash:
|
3837
|
-
#
|
3838
|
-
# {
|
3839
|
-
# integer_hyper_parameter_ranges: [
|
3840
|
-
# {
|
3841
|
-
# name: "ParameterName",
|
3842
|
-
# min_value: 1,
|
3843
|
-
# max_value: 1,
|
3844
|
-
# },
|
3845
|
-
# ],
|
3846
|
-
# continuous_hyper_parameter_ranges: [
|
3847
|
-
# {
|
3848
|
-
# name: "ParameterName",
|
3849
|
-
# min_value: 1.0,
|
3850
|
-
# max_value: 1.0,
|
3851
|
-
# },
|
3852
|
-
# ],
|
3853
|
-
# categorical_hyper_parameter_ranges: [
|
3854
|
-
# {
|
3855
|
-
# name: "ParameterName",
|
3856
|
-
# values: ["CategoricalValue"],
|
3857
|
-
# },
|
3858
|
-
# ],
|
3859
|
-
# }
|
3860
|
-
#
|
3861
3306
|
# @!attribute [rw] integer_hyper_parameter_ranges
|
3862
3307
|
# The integer-valued hyperparameters and their ranges.
|
3863
3308
|
# @return [Array<Types::IntegerHyperParameterRange>]
|
@@ -3882,15 +3327,6 @@ module Aws::Personalize
|
|
3882
3327
|
|
3883
3328
|
# Provides the name and range of an integer-valued hyperparameter.
|
3884
3329
|
#
|
3885
|
-
# @note When making an API call, you may pass IntegerHyperParameterRange
|
3886
|
-
# data as a hash:
|
3887
|
-
#
|
3888
|
-
# {
|
3889
|
-
# name: "ParameterName",
|
3890
|
-
# min_value: 1,
|
3891
|
-
# max_value: 1,
|
3892
|
-
# }
|
3893
|
-
#
|
3894
3330
|
# @!attribute [rw] name
|
3895
3331
|
# The name of the hyperparameter.
|
3896
3332
|
# @return [String]
|
@@ -3952,15 +3388,6 @@ module Aws::Personalize
|
|
3952
3388
|
include Aws::Structure
|
3953
3389
|
end
|
3954
3390
|
|
3955
|
-
# @note When making an API call, you may pass ListBatchInferenceJobsRequest
|
3956
|
-
# data as a hash:
|
3957
|
-
#
|
3958
|
-
# {
|
3959
|
-
# solution_version_arn: "Arn",
|
3960
|
-
# next_token: "NextToken",
|
3961
|
-
# max_results: 1,
|
3962
|
-
# }
|
3963
|
-
#
|
3964
3391
|
# @!attribute [rw] solution_version_arn
|
3965
3392
|
# The Amazon Resource Name (ARN) of the solution version from which
|
3966
3393
|
# the batch inference jobs were created.
|
@@ -4003,15 +3430,6 @@ module Aws::Personalize
|
|
4003
3430
|
include Aws::Structure
|
4004
3431
|
end
|
4005
3432
|
|
4006
|
-
# @note When making an API call, you may pass ListBatchSegmentJobsRequest
|
4007
|
-
# data as a hash:
|
4008
|
-
#
|
4009
|
-
# {
|
4010
|
-
# solution_version_arn: "Arn",
|
4011
|
-
# next_token: "NextToken",
|
4012
|
-
# max_results: 1,
|
4013
|
-
# }
|
4014
|
-
#
|
4015
3433
|
# @!attribute [rw] solution_version_arn
|
4016
3434
|
# The Amazon Resource Name (ARN) of the solution version that the
|
4017
3435
|
# batch segment jobs used to generate batch segments.
|
@@ -4054,15 +3472,6 @@ module Aws::Personalize
|
|
4054
3472
|
include Aws::Structure
|
4055
3473
|
end
|
4056
3474
|
|
4057
|
-
# @note When making an API call, you may pass ListCampaignsRequest
|
4058
|
-
# data as a hash:
|
4059
|
-
#
|
4060
|
-
# {
|
4061
|
-
# solution_arn: "Arn",
|
4062
|
-
# next_token: "NextToken",
|
4063
|
-
# max_results: 1,
|
4064
|
-
# }
|
4065
|
-
#
|
4066
3475
|
# @!attribute [rw] solution_arn
|
4067
3476
|
# The Amazon Resource Name (ARN) of the solution to list the campaigns
|
4068
3477
|
# for. When a solution is not specified, all the campaigns associated
|
@@ -4109,15 +3518,6 @@ module Aws::Personalize
|
|
4109
3518
|
include Aws::Structure
|
4110
3519
|
end
|
4111
3520
|
|
4112
|
-
# @note When making an API call, you may pass ListDatasetExportJobsRequest
|
4113
|
-
# data as a hash:
|
4114
|
-
#
|
4115
|
-
# {
|
4116
|
-
# dataset_arn: "Arn",
|
4117
|
-
# next_token: "NextToken",
|
4118
|
-
# max_results: 1,
|
4119
|
-
# }
|
4120
|
-
#
|
4121
3521
|
# @!attribute [rw] dataset_arn
|
4122
3522
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
4123
3523
|
# export jobs for.
|
@@ -4160,14 +3560,6 @@ module Aws::Personalize
|
|
4160
3560
|
include Aws::Structure
|
4161
3561
|
end
|
4162
3562
|
|
4163
|
-
# @note When making an API call, you may pass ListDatasetGroupsRequest
|
4164
|
-
# data as a hash:
|
4165
|
-
#
|
4166
|
-
# {
|
4167
|
-
# next_token: "NextToken",
|
4168
|
-
# max_results: 1,
|
4169
|
-
# }
|
4170
|
-
#
|
4171
3563
|
# @!attribute [rw] next_token
|
4172
3564
|
# A token returned from the previous call to `ListDatasetGroups` for
|
4173
3565
|
# getting the next set of dataset groups (if they exist).
|
@@ -4203,15 +3595,6 @@ module Aws::Personalize
|
|
4203
3595
|
include Aws::Structure
|
4204
3596
|
end
|
4205
3597
|
|
4206
|
-
# @note When making an API call, you may pass ListDatasetImportJobsRequest
|
4207
|
-
# data as a hash:
|
4208
|
-
#
|
4209
|
-
# {
|
4210
|
-
# dataset_arn: "Arn",
|
4211
|
-
# next_token: "NextToken",
|
4212
|
-
# max_results: 1,
|
4213
|
-
# }
|
4214
|
-
#
|
4215
3598
|
# @!attribute [rw] dataset_arn
|
4216
3599
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
4217
3600
|
# import jobs for.
|
@@ -4254,15 +3637,6 @@ module Aws::Personalize
|
|
4254
3637
|
include Aws::Structure
|
4255
3638
|
end
|
4256
3639
|
|
4257
|
-
# @note When making an API call, you may pass ListDatasetsRequest
|
4258
|
-
# data as a hash:
|
4259
|
-
#
|
4260
|
-
# {
|
4261
|
-
# dataset_group_arn: "Arn",
|
4262
|
-
# next_token: "NextToken",
|
4263
|
-
# max_results: 1,
|
4264
|
-
# }
|
4265
|
-
#
|
4266
3640
|
# @!attribute [rw] dataset_group_arn
|
4267
3641
|
# The Amazon Resource Name (ARN) of the dataset group that contains
|
4268
3642
|
# the datasets to list.
|
@@ -4305,15 +3679,6 @@ module Aws::Personalize
|
|
4305
3679
|
include Aws::Structure
|
4306
3680
|
end
|
4307
3681
|
|
4308
|
-
# @note When making an API call, you may pass ListEventTrackersRequest
|
4309
|
-
# data as a hash:
|
4310
|
-
#
|
4311
|
-
# {
|
4312
|
-
# dataset_group_arn: "Arn",
|
4313
|
-
# next_token: "NextToken",
|
4314
|
-
# max_results: 1,
|
4315
|
-
# }
|
4316
|
-
#
|
4317
3682
|
# @!attribute [rw] dataset_group_arn
|
4318
3683
|
# The ARN of a dataset group used to filter the response.
|
4319
3684
|
# @return [String]
|
@@ -4354,15 +3719,6 @@ module Aws::Personalize
|
|
4354
3719
|
include Aws::Structure
|
4355
3720
|
end
|
4356
3721
|
|
4357
|
-
# @note When making an API call, you may pass ListFiltersRequest
|
4358
|
-
# data as a hash:
|
4359
|
-
#
|
4360
|
-
# {
|
4361
|
-
# dataset_group_arn: "Arn",
|
4362
|
-
# next_token: "NextToken",
|
4363
|
-
# max_results: 1,
|
4364
|
-
# }
|
4365
|
-
#
|
4366
3722
|
# @!attribute [rw] dataset_group_arn
|
4367
3723
|
# The ARN of the dataset group that contains the filters.
|
4368
3724
|
# @return [String]
|
@@ -4403,16 +3759,91 @@ module Aws::Personalize
|
|
4403
3759
|
include Aws::Structure
|
4404
3760
|
end
|
4405
3761
|
|
4406
|
-
#
|
4407
|
-
#
|
3762
|
+
# @!attribute [rw] metric_attribution_arn
|
3763
|
+
# The Amazon Resource Name (ARN) of the metric attribution to retrieve
|
3764
|
+
# attributes for.
|
3765
|
+
# @return [String]
|
3766
|
+
#
|
3767
|
+
# @!attribute [rw] next_token
|
3768
|
+
# Specify the pagination token from a previous request to retrieve the
|
3769
|
+
# next page of results.
|
3770
|
+
# @return [String]
|
3771
|
+
#
|
3772
|
+
# @!attribute [rw] max_results
|
3773
|
+
# The maximum number of metrics to return in one page of results.
|
3774
|
+
# @return [Integer]
|
3775
|
+
#
|
3776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionMetricsRequest AWS API Documentation
|
3777
|
+
#
|
3778
|
+
class ListMetricAttributionMetricsRequest < Struct.new(
|
3779
|
+
:metric_attribution_arn,
|
3780
|
+
:next_token,
|
3781
|
+
:max_results)
|
3782
|
+
SENSITIVE = []
|
3783
|
+
include Aws::Structure
|
3784
|
+
end
|
3785
|
+
|
3786
|
+
# @!attribute [rw] metrics
|
3787
|
+
# The metrics for the specified metric attribution.
|
3788
|
+
# @return [Array<Types::MetricAttribute>]
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] next_token
|
3791
|
+
# Specify the pagination token from a previous
|
3792
|
+
# `ListMetricAttributionMetricsResponse` request to retrieve the next
|
3793
|
+
# page of results.
|
3794
|
+
# @return [String]
|
3795
|
+
#
|
3796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionMetricsResponse AWS API Documentation
|
3797
|
+
#
|
3798
|
+
class ListMetricAttributionMetricsResponse < Struct.new(
|
3799
|
+
:metrics,
|
3800
|
+
:next_token)
|
3801
|
+
SENSITIVE = []
|
3802
|
+
include Aws::Structure
|
3803
|
+
end
|
3804
|
+
|
3805
|
+
# @!attribute [rw] dataset_group_arn
|
3806
|
+
# The metric attributions' dataset group Amazon Resource Name (ARN).
|
3807
|
+
# @return [String]
|
3808
|
+
#
|
3809
|
+
# @!attribute [rw] next_token
|
3810
|
+
# Specify the pagination token from a previous request to retrieve the
|
3811
|
+
# next page of results.
|
3812
|
+
# @return [String]
|
3813
|
+
#
|
3814
|
+
# @!attribute [rw] max_results
|
3815
|
+
# The maximum number of metric attributions to return in one page of
|
3816
|
+
# results.
|
3817
|
+
# @return [Integer]
|
3818
|
+
#
|
3819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionsRequest AWS API Documentation
|
3820
|
+
#
|
3821
|
+
class ListMetricAttributionsRequest < Struct.new(
|
3822
|
+
:dataset_group_arn,
|
3823
|
+
:next_token,
|
3824
|
+
:max_results)
|
3825
|
+
SENSITIVE = []
|
3826
|
+
include Aws::Structure
|
3827
|
+
end
|
3828
|
+
|
3829
|
+
# @!attribute [rw] metric_attributions
|
3830
|
+
# The list of metric attributions.
|
3831
|
+
# @return [Array<Types::MetricAttributionSummary>]
|
3832
|
+
#
|
3833
|
+
# @!attribute [rw] next_token
|
3834
|
+
# Specify the pagination token from a previous request to retrieve the
|
3835
|
+
# next page of results.
|
3836
|
+
# @return [String]
|
4408
3837
|
#
|
4409
|
-
#
|
4410
|
-
# recipe_provider: "SERVICE", # accepts SERVICE
|
4411
|
-
# next_token: "NextToken",
|
4412
|
-
# max_results: 1,
|
4413
|
-
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
4414
|
-
# }
|
3838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionsResponse AWS API Documentation
|
4415
3839
|
#
|
3840
|
+
class ListMetricAttributionsResponse < Struct.new(
|
3841
|
+
:metric_attributions,
|
3842
|
+
:next_token)
|
3843
|
+
SENSITIVE = []
|
3844
|
+
include Aws::Structure
|
3845
|
+
end
|
3846
|
+
|
4416
3847
|
# @!attribute [rw] recipe_provider
|
4417
3848
|
# The default is `SERVICE`.
|
4418
3849
|
# @return [String]
|
@@ -4461,15 +3892,6 @@ module Aws::Personalize
|
|
4461
3892
|
include Aws::Structure
|
4462
3893
|
end
|
4463
3894
|
|
4464
|
-
# @note When making an API call, you may pass ListRecommendersRequest
|
4465
|
-
# data as a hash:
|
4466
|
-
#
|
4467
|
-
# {
|
4468
|
-
# dataset_group_arn: "Arn",
|
4469
|
-
# next_token: "NextToken",
|
4470
|
-
# max_results: 1,
|
4471
|
-
# }
|
4472
|
-
#
|
4473
3895
|
# @!attribute [rw] dataset_group_arn
|
4474
3896
|
# The Amazon Resource Name (ARN) of the Domain dataset group to list
|
4475
3897
|
# the recommenders for. When a Domain dataset group is not specified,
|
@@ -4512,14 +3934,6 @@ module Aws::Personalize
|
|
4512
3934
|
include Aws::Structure
|
4513
3935
|
end
|
4514
3936
|
|
4515
|
-
# @note When making an API call, you may pass ListSchemasRequest
|
4516
|
-
# data as a hash:
|
4517
|
-
#
|
4518
|
-
# {
|
4519
|
-
# next_token: "NextToken",
|
4520
|
-
# max_results: 1,
|
4521
|
-
# }
|
4522
|
-
#
|
4523
3937
|
# @!attribute [rw] next_token
|
4524
3938
|
# A token returned from the previous call to `ListSchemas` for getting
|
4525
3939
|
# the next set of schemas (if they exist).
|
@@ -4555,15 +3969,6 @@ module Aws::Personalize
|
|
4555
3969
|
include Aws::Structure
|
4556
3970
|
end
|
4557
3971
|
|
4558
|
-
# @note When making an API call, you may pass ListSolutionVersionsRequest
|
4559
|
-
# data as a hash:
|
4560
|
-
#
|
4561
|
-
# {
|
4562
|
-
# solution_arn: "Arn",
|
4563
|
-
# next_token: "NextToken",
|
4564
|
-
# max_results: 1,
|
4565
|
-
# }
|
4566
|
-
#
|
4567
3972
|
# @!attribute [rw] solution_arn
|
4568
3973
|
# The Amazon Resource Name (ARN) of the solution.
|
4569
3974
|
# @return [String]
|
@@ -4605,15 +4010,6 @@ module Aws::Personalize
|
|
4605
4010
|
include Aws::Structure
|
4606
4011
|
end
|
4607
4012
|
|
4608
|
-
# @note When making an API call, you may pass ListSolutionsRequest
|
4609
|
-
# data as a hash:
|
4610
|
-
#
|
4611
|
-
# {
|
4612
|
-
# dataset_group_arn: "Arn",
|
4613
|
-
# next_token: "NextToken",
|
4614
|
-
# max_results: 1,
|
4615
|
-
# }
|
4616
|
-
#
|
4617
4013
|
# @!attribute [rw] dataset_group_arn
|
4618
4014
|
# The Amazon Resource Name (ARN) of the dataset group.
|
4619
4015
|
# @return [String]
|
@@ -4654,13 +4050,6 @@ module Aws::Personalize
|
|
4654
4050
|
include Aws::Structure
|
4655
4051
|
end
|
4656
4052
|
|
4657
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4658
|
-
# data as a hash:
|
4659
|
-
#
|
4660
|
-
# {
|
4661
|
-
# resource_arn: "Arn", # required
|
4662
|
-
# }
|
4663
|
-
#
|
4664
4053
|
# @!attribute [rw] resource_arn
|
4665
4054
|
# The resource's Amazon Resource Name.
|
4666
4055
|
# @return [String]
|
@@ -4685,6 +4074,166 @@ module Aws::Personalize
|
|
4685
4074
|
include Aws::Structure
|
4686
4075
|
end
|
4687
4076
|
|
4077
|
+
# Contains information on a metric that a metric attribution reports on.
|
4078
|
+
# For more information, see [Measuring impact of recommendations][1].
|
4079
|
+
#
|
4080
|
+
#
|
4081
|
+
#
|
4082
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
4083
|
+
#
|
4084
|
+
# @!attribute [rw] event_type
|
4085
|
+
# The metric's event type.
|
4086
|
+
# @return [String]
|
4087
|
+
#
|
4088
|
+
# @!attribute [rw] metric_name
|
4089
|
+
# The metric's name. The name helps you identify the metric in Amazon
|
4090
|
+
# CloudWatch or Amazon S3.
|
4091
|
+
# @return [String]
|
4092
|
+
#
|
4093
|
+
# @!attribute [rw] expression
|
4094
|
+
# The attribute's expression. Available functions are `SUM()` or
|
4095
|
+
# `SAMPLECOUNT()`. For SUM() functions, provide the dataset type
|
4096
|
+
# (either Interactions or Items) and column to sum as a parameter. For
|
4097
|
+
# example SUM(Items.PRICE).
|
4098
|
+
# @return [String]
|
4099
|
+
#
|
4100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/MetricAttribute AWS API Documentation
|
4101
|
+
#
|
4102
|
+
class MetricAttribute < Struct.new(
|
4103
|
+
:event_type,
|
4104
|
+
:metric_name,
|
4105
|
+
:expression)
|
4106
|
+
SENSITIVE = []
|
4107
|
+
include Aws::Structure
|
4108
|
+
end
|
4109
|
+
|
4110
|
+
# Contains information on a metric attribution. A metric attribution
|
4111
|
+
# creates reports on the data that you import into Amazon Personalize.
|
4112
|
+
# Depending on how you import the data, you can view reports in Amazon
|
4113
|
+
# CloudWatch or Amazon S3. For more information, see [Measuring impact
|
4114
|
+
# of recommendations][1].
|
4115
|
+
#
|
4116
|
+
#
|
4117
|
+
#
|
4118
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
4119
|
+
#
|
4120
|
+
# @!attribute [rw] name
|
4121
|
+
# The metric attribution's name.
|
4122
|
+
# @return [String]
|
4123
|
+
#
|
4124
|
+
# @!attribute [rw] metric_attribution_arn
|
4125
|
+
# The metric attribution's Amazon Resource Name (ARN).
|
4126
|
+
# @return [String]
|
4127
|
+
#
|
4128
|
+
# @!attribute [rw] dataset_group_arn
|
4129
|
+
# The metric attribution's dataset group Amazon Resource Name (ARN).
|
4130
|
+
# @return [String]
|
4131
|
+
#
|
4132
|
+
# @!attribute [rw] metrics_output_config
|
4133
|
+
# The metric attribution's output configuration.
|
4134
|
+
# @return [Types::MetricAttributionOutput]
|
4135
|
+
#
|
4136
|
+
# @!attribute [rw] status
|
4137
|
+
# The metric attribution's status.
|
4138
|
+
# @return [String]
|
4139
|
+
#
|
4140
|
+
# @!attribute [rw] creation_date_time
|
4141
|
+
# The metric attribution's creation date time.
|
4142
|
+
# @return [Time]
|
4143
|
+
#
|
4144
|
+
# @!attribute [rw] last_updated_date_time
|
4145
|
+
# The metric attribution's last updated date time.
|
4146
|
+
# @return [Time]
|
4147
|
+
#
|
4148
|
+
# @!attribute [rw] failure_reason
|
4149
|
+
# The metric attribution's failure reason.
|
4150
|
+
# @return [String]
|
4151
|
+
#
|
4152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/MetricAttribution AWS API Documentation
|
4153
|
+
#
|
4154
|
+
class MetricAttribution < Struct.new(
|
4155
|
+
:name,
|
4156
|
+
:metric_attribution_arn,
|
4157
|
+
:dataset_group_arn,
|
4158
|
+
:metrics_output_config,
|
4159
|
+
:status,
|
4160
|
+
:creation_date_time,
|
4161
|
+
:last_updated_date_time,
|
4162
|
+
:failure_reason)
|
4163
|
+
SENSITIVE = []
|
4164
|
+
include Aws::Structure
|
4165
|
+
end
|
4166
|
+
|
4167
|
+
# The output configuration details for a metric attribution.
|
4168
|
+
#
|
4169
|
+
# @!attribute [rw] s3_data_destination
|
4170
|
+
# The configuration details of an Amazon S3 input or output bucket.
|
4171
|
+
# @return [Types::S3DataConfig]
|
4172
|
+
#
|
4173
|
+
# @!attribute [rw] role_arn
|
4174
|
+
# The Amazon Resource Name (ARN) of the IAM service role that has
|
4175
|
+
# permissions to add data to your output Amazon S3 bucket and add
|
4176
|
+
# metrics to Amazon CloudWatch. For more information, see [Measuring
|
4177
|
+
# impact of recommendations][1].
|
4178
|
+
#
|
4179
|
+
#
|
4180
|
+
#
|
4181
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
4182
|
+
# @return [String]
|
4183
|
+
#
|
4184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/MetricAttributionOutput AWS API Documentation
|
4185
|
+
#
|
4186
|
+
class MetricAttributionOutput < Struct.new(
|
4187
|
+
:s3_data_destination,
|
4188
|
+
:role_arn)
|
4189
|
+
SENSITIVE = []
|
4190
|
+
include Aws::Structure
|
4191
|
+
end
|
4192
|
+
|
4193
|
+
# Provides a summary of the properties of a metric attribution. For a
|
4194
|
+
# complete listing, call the [DescribeMetricAttribution][1].
|
4195
|
+
#
|
4196
|
+
#
|
4197
|
+
#
|
4198
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html
|
4199
|
+
#
|
4200
|
+
# @!attribute [rw] name
|
4201
|
+
# The name of the metric attribution.
|
4202
|
+
# @return [String]
|
4203
|
+
#
|
4204
|
+
# @!attribute [rw] metric_attribution_arn
|
4205
|
+
# The metric attribution's Amazon Resource Name (ARN).
|
4206
|
+
# @return [String]
|
4207
|
+
#
|
4208
|
+
# @!attribute [rw] status
|
4209
|
+
# The metric attribution's status.
|
4210
|
+
# @return [String]
|
4211
|
+
#
|
4212
|
+
# @!attribute [rw] creation_date_time
|
4213
|
+
# The metric attribution's creation date time.
|
4214
|
+
# @return [Time]
|
4215
|
+
#
|
4216
|
+
# @!attribute [rw] last_updated_date_time
|
4217
|
+
# The metric attribution's last updated date time.
|
4218
|
+
# @return [Time]
|
4219
|
+
#
|
4220
|
+
# @!attribute [rw] failure_reason
|
4221
|
+
# The metric attribution's failure reason.
|
4222
|
+
# @return [String]
|
4223
|
+
#
|
4224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/MetricAttributionSummary AWS API Documentation
|
4225
|
+
#
|
4226
|
+
class MetricAttributionSummary < Struct.new(
|
4227
|
+
:name,
|
4228
|
+
:metric_attribution_arn,
|
4229
|
+
:status,
|
4230
|
+
:creation_date_time,
|
4231
|
+
:last_updated_date_time,
|
4232
|
+
:failure_reason)
|
4233
|
+
SENSITIVE = []
|
4234
|
+
include Aws::Structure
|
4235
|
+
end
|
4236
|
+
|
4688
4237
|
# Describes the additional objective for the solution, such as
|
4689
4238
|
# maximizing streaming minutes or increasing revenue. For more
|
4690
4239
|
# information see [Optimizing a solution][1].
|
@@ -4693,14 +4242,6 @@ module Aws::Personalize
|
|
4693
4242
|
#
|
4694
4243
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html
|
4695
4244
|
#
|
4696
|
-
# @note When making an API call, you may pass OptimizationObjective
|
4697
|
-
# data as a hash:
|
4698
|
-
#
|
4699
|
-
# {
|
4700
|
-
# item_attribute: "ItemAttribute",
|
4701
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
4702
|
-
# }
|
4703
|
-
#
|
4704
4245
|
# @!attribute [rw] item_attribute
|
4705
4246
|
# The numerical metadata column in an Items dataset related to the
|
4706
4247
|
# optimization objective. For example, VIDEO\_LENGTH (to maximize
|
@@ -4925,16 +4466,6 @@ module Aws::Personalize
|
|
4925
4466
|
|
4926
4467
|
# The configuration details of the recommender.
|
4927
4468
|
#
|
4928
|
-
# @note When making an API call, you may pass RecommenderConfig
|
4929
|
-
# data as a hash:
|
4930
|
-
#
|
4931
|
-
# {
|
4932
|
-
# item_exploration_config: {
|
4933
|
-
# "ParameterName" => "ParameterValue",
|
4934
|
-
# },
|
4935
|
-
# min_recommendation_requests_per_second: 1,
|
4936
|
-
# }
|
4937
|
-
#
|
4938
4469
|
# @!attribute [rw] item_exploration_config
|
4939
4470
|
# Specifies the exploration configuration hyperparameters, including
|
4940
4471
|
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
@@ -5111,14 +4642,6 @@ module Aws::Personalize
|
|
5111
4642
|
|
5112
4643
|
# The configuration details of an Amazon S3 input or output bucket.
|
5113
4644
|
#
|
5114
|
-
# @note When making an API call, you may pass S3DataConfig
|
5115
|
-
# data as a hash:
|
5116
|
-
#
|
5117
|
-
# {
|
5118
|
-
# path: "S3Location", # required
|
5119
|
-
# kms_key_arn: "KmsKeyArn",
|
5120
|
-
# }
|
5121
|
-
#
|
5122
4645
|
# @!attribute [rw] path
|
5123
4646
|
# The file path of the Amazon S3 bucket.
|
5124
4647
|
# @return [String]
|
@@ -5231,60 +4754,6 @@ module Aws::Personalize
|
|
5231
4754
|
|
5232
4755
|
# Describes the configuration properties for the solution.
|
5233
4756
|
#
|
5234
|
-
# @note When making an API call, you may pass SolutionConfig
|
5235
|
-
# data as a hash:
|
5236
|
-
#
|
5237
|
-
# {
|
5238
|
-
# event_value_threshold: "EventValueThreshold",
|
5239
|
-
# hpo_config: {
|
5240
|
-
# hpo_objective: {
|
5241
|
-
# type: "HPOObjectiveType",
|
5242
|
-
# metric_name: "MetricName",
|
5243
|
-
# metric_regex: "MetricRegex",
|
5244
|
-
# },
|
5245
|
-
# hpo_resource_config: {
|
5246
|
-
# max_number_of_training_jobs: "HPOResource",
|
5247
|
-
# max_parallel_training_jobs: "HPOResource",
|
5248
|
-
# },
|
5249
|
-
# algorithm_hyper_parameter_ranges: {
|
5250
|
-
# integer_hyper_parameter_ranges: [
|
5251
|
-
# {
|
5252
|
-
# name: "ParameterName",
|
5253
|
-
# min_value: 1,
|
5254
|
-
# max_value: 1,
|
5255
|
-
# },
|
5256
|
-
# ],
|
5257
|
-
# continuous_hyper_parameter_ranges: [
|
5258
|
-
# {
|
5259
|
-
# name: "ParameterName",
|
5260
|
-
# min_value: 1.0,
|
5261
|
-
# max_value: 1.0,
|
5262
|
-
# },
|
5263
|
-
# ],
|
5264
|
-
# categorical_hyper_parameter_ranges: [
|
5265
|
-
# {
|
5266
|
-
# name: "ParameterName",
|
5267
|
-
# values: ["CategoricalValue"],
|
5268
|
-
# },
|
5269
|
-
# ],
|
5270
|
-
# },
|
5271
|
-
# },
|
5272
|
-
# algorithm_hyper_parameters: {
|
5273
|
-
# "ParameterName" => "ParameterValue",
|
5274
|
-
# },
|
5275
|
-
# feature_transformation_parameters: {
|
5276
|
-
# "ParameterName" => "ParameterValue",
|
5277
|
-
# },
|
5278
|
-
# auto_ml_config: {
|
5279
|
-
# metric_name: "MetricName",
|
5280
|
-
# recipe_list: ["Arn"],
|
5281
|
-
# },
|
5282
|
-
# optimization_objective: {
|
5283
|
-
# item_attribute: "ItemAttribute",
|
5284
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
5285
|
-
# },
|
5286
|
-
# }
|
5287
|
-
#
|
5288
4757
|
# @!attribute [rw] event_value_threshold
|
5289
4758
|
# Only events with a value greater than or equal to this threshold are
|
5290
4759
|
# used for training a model.
|
@@ -5368,6 +4837,10 @@ module Aws::Personalize
|
|
5368
4837
|
# The date and time (in Unix time) that the solution was last updated.
|
5369
4838
|
# @return [Time]
|
5370
4839
|
#
|
4840
|
+
# @!attribute [rw] recipe_arn
|
4841
|
+
# The Amazon Resource Name (ARN) of the recipe used by the solution.
|
4842
|
+
# @return [String]
|
4843
|
+
#
|
5371
4844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionSummary AWS API Documentation
|
5372
4845
|
#
|
5373
4846
|
class SolutionSummary < Struct.new(
|
@@ -5375,7 +4848,8 @@ module Aws::Personalize
|
|
5375
4848
|
:solution_arn,
|
5376
4849
|
:status,
|
5377
4850
|
:creation_date_time,
|
5378
|
-
:last_updated_date_time
|
4851
|
+
:last_updated_date_time,
|
4852
|
+
:recipe_arn)
|
5379
4853
|
SENSITIVE = []
|
5380
4854
|
include Aws::Structure
|
5381
4855
|
end
|
@@ -5387,6 +4861,10 @@ module Aws::Personalize
|
|
5387
4861
|
#
|
5388
4862
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html
|
5389
4863
|
#
|
4864
|
+
# @!attribute [rw] name
|
4865
|
+
# The name of the solution version.
|
4866
|
+
# @return [String]
|
4867
|
+
#
|
5390
4868
|
# @!attribute [rw] solution_version_arn
|
5391
4869
|
# The ARN of the solution version.
|
5392
4870
|
# @return [String]
|
@@ -5489,6 +4967,7 @@ module Aws::Personalize
|
|
5489
4967
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionVersion AWS API Documentation
|
5490
4968
|
#
|
5491
4969
|
class SolutionVersion < Struct.new(
|
4970
|
+
:name,
|
5492
4971
|
:solution_version_arn,
|
5493
4972
|
:solution_arn,
|
5494
4973
|
:perform_hpo,
|
@@ -5556,13 +5035,6 @@ module Aws::Personalize
|
|
5556
5035
|
include Aws::Structure
|
5557
5036
|
end
|
5558
5037
|
|
5559
|
-
# @note When making an API call, you may pass StartRecommenderRequest
|
5560
|
-
# data as a hash:
|
5561
|
-
#
|
5562
|
-
# {
|
5563
|
-
# recommender_arn: "Arn", # required
|
5564
|
-
# }
|
5565
|
-
#
|
5566
5038
|
# @!attribute [rw] recommender_arn
|
5567
5039
|
# The Amazon Resource Name (ARN) of the recommender to start.
|
5568
5040
|
# @return [String]
|
@@ -5587,13 +5059,6 @@ module Aws::Personalize
|
|
5587
5059
|
include Aws::Structure
|
5588
5060
|
end
|
5589
5061
|
|
5590
|
-
# @note When making an API call, you may pass StopRecommenderRequest
|
5591
|
-
# data as a hash:
|
5592
|
-
#
|
5593
|
-
# {
|
5594
|
-
# recommender_arn: "Arn", # required
|
5595
|
-
# }
|
5596
|
-
#
|
5597
5062
|
# @!attribute [rw] recommender_arn
|
5598
5063
|
# The Amazon Resource Name (ARN) of the recommender to stop.
|
5599
5064
|
# @return [String]
|
@@ -5618,13 +5083,6 @@ module Aws::Personalize
|
|
5618
5083
|
include Aws::Structure
|
5619
5084
|
end
|
5620
5085
|
|
5621
|
-
# @note When making an API call, you may pass StopSolutionVersionCreationRequest
|
5622
|
-
# data as a hash:
|
5623
|
-
#
|
5624
|
-
# {
|
5625
|
-
# solution_version_arn: "Arn", # required
|
5626
|
-
# }
|
5627
|
-
#
|
5628
5086
|
# @!attribute [rw] solution_version_arn
|
5629
5087
|
# The Amazon Resource Name (ARN) of the solution version you want to
|
5630
5088
|
# stop creating.
|
@@ -5647,14 +5105,6 @@ module Aws::Personalize
|
|
5647
5105
|
#
|
5648
5106
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
5649
5107
|
#
|
5650
|
-
# @note When making an API call, you may pass Tag
|
5651
|
-
# data as a hash:
|
5652
|
-
#
|
5653
|
-
# {
|
5654
|
-
# tag_key: "TagKey", # required
|
5655
|
-
# tag_value: "TagValue", # required
|
5656
|
-
# }
|
5657
|
-
#
|
5658
5108
|
# @!attribute [rw] tag_key
|
5659
5109
|
# One part of a key-value pair that makes up a tag. A key is a general
|
5660
5110
|
# label that acts like a category for more specific tag values.
|
@@ -5674,19 +5124,6 @@ module Aws::Personalize
|
|
5674
5124
|
include Aws::Structure
|
5675
5125
|
end
|
5676
5126
|
|
5677
|
-
# @note When making an API call, you may pass TagResourceRequest
|
5678
|
-
# data as a hash:
|
5679
|
-
#
|
5680
|
-
# {
|
5681
|
-
# resource_arn: "Arn", # required
|
5682
|
-
# tags: [ # required
|
5683
|
-
# {
|
5684
|
-
# tag_key: "TagKey", # required
|
5685
|
-
# tag_value: "TagValue", # required
|
5686
|
-
# },
|
5687
|
-
# ],
|
5688
|
-
# }
|
5689
|
-
#
|
5690
5127
|
# @!attribute [rw] resource_arn
|
5691
5128
|
# The resource's Amazon Resource Name (ARN).
|
5692
5129
|
# @return [String]
|
@@ -5756,14 +5193,6 @@ module Aws::Personalize
|
|
5756
5193
|
include Aws::Structure
|
5757
5194
|
end
|
5758
5195
|
|
5759
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
5760
|
-
# data as a hash:
|
5761
|
-
#
|
5762
|
-
# {
|
5763
|
-
# resource_arn: "Arn", # required
|
5764
|
-
# tag_keys: ["TagKey"], # required
|
5765
|
-
# }
|
5766
|
-
#
|
5767
5196
|
# @!attribute [rw] resource_arn
|
5768
5197
|
# The resource's Amazon Resource Name (ARN).
|
5769
5198
|
# @return [String]
|
@@ -5785,20 +5214,6 @@ module Aws::Personalize
|
|
5785
5214
|
#
|
5786
5215
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
5787
5216
|
|
5788
|
-
# @note When making an API call, you may pass UpdateCampaignRequest
|
5789
|
-
# data as a hash:
|
5790
|
-
#
|
5791
|
-
# {
|
5792
|
-
# campaign_arn: "Arn", # required
|
5793
|
-
# solution_version_arn: "Arn",
|
5794
|
-
# min_provisioned_tps: 1,
|
5795
|
-
# campaign_config: {
|
5796
|
-
# item_exploration_config: {
|
5797
|
-
# "ParameterName" => "ParameterValue",
|
5798
|
-
# },
|
5799
|
-
# },
|
5800
|
-
# }
|
5801
|
-
#
|
5802
5217
|
# @!attribute [rw] campaign_arn
|
5803
5218
|
# The Amazon Resource Name (ARN) of the campaign.
|
5804
5219
|
# @return [String]
|
@@ -5839,19 +5254,46 @@ module Aws::Personalize
|
|
5839
5254
|
include Aws::Structure
|
5840
5255
|
end
|
5841
5256
|
|
5842
|
-
#
|
5843
|
-
#
|
5257
|
+
# @!attribute [rw] add_metrics
|
5258
|
+
# Add new metric attributes to the metric attribution.
|
5259
|
+
# @return [Array<Types::MetricAttribute>]
|
5844
5260
|
#
|
5845
|
-
#
|
5846
|
-
#
|
5847
|
-
#
|
5848
|
-
#
|
5849
|
-
#
|
5850
|
-
#
|
5851
|
-
#
|
5852
|
-
#
|
5853
|
-
#
|
5261
|
+
# @!attribute [rw] remove_metrics
|
5262
|
+
# Remove metric attributes from the metric attribution.
|
5263
|
+
# @return [Array<String>]
|
5264
|
+
#
|
5265
|
+
# @!attribute [rw] metrics_output_config
|
5266
|
+
# An output config for the metric attribution.
|
5267
|
+
# @return [Types::MetricAttributionOutput]
|
5268
|
+
#
|
5269
|
+
# @!attribute [rw] metric_attribution_arn
|
5270
|
+
# The Amazon Resource Name (ARN) for the metric attribution to update.
|
5271
|
+
# @return [String]
|
5272
|
+
#
|
5273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateMetricAttributionRequest AWS API Documentation
|
5854
5274
|
#
|
5275
|
+
class UpdateMetricAttributionRequest < Struct.new(
|
5276
|
+
:add_metrics,
|
5277
|
+
:remove_metrics,
|
5278
|
+
:metrics_output_config,
|
5279
|
+
:metric_attribution_arn)
|
5280
|
+
SENSITIVE = []
|
5281
|
+
include Aws::Structure
|
5282
|
+
end
|
5283
|
+
|
5284
|
+
# @!attribute [rw] metric_attribution_arn
|
5285
|
+
# The Amazon Resource Name (ARN) for the metric attribution that you
|
5286
|
+
# updated.
|
5287
|
+
# @return [String]
|
5288
|
+
#
|
5289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateMetricAttributionResponse AWS API Documentation
|
5290
|
+
#
|
5291
|
+
class UpdateMetricAttributionResponse < Struct.new(
|
5292
|
+
:metric_attribution_arn)
|
5293
|
+
SENSITIVE = []
|
5294
|
+
include Aws::Structure
|
5295
|
+
end
|
5296
|
+
|
5855
5297
|
# @!attribute [rw] recommender_arn
|
5856
5298
|
# The Amazon Resource Name (ARN) of the recommender to modify.
|
5857
5299
|
# @return [String]
|