aws-sdk-personalize 1.45.0 → 1.47.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 +94 -28
- data/lib/aws-sdk-personalize/client_api.rb +14 -0
- data/lib/aws-sdk-personalize/endpoint_provider.rb +38 -96
- data/lib/aws-sdk-personalize/types.rb +91 -1072
- 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.
|
@@ -403,7 +366,8 @@ module Aws::Personalize
|
|
403
366
|
#
|
404
367
|
# @!attribute [rw] num_results
|
405
368
|
# The number of predicted users generated by the batch segment job for
|
406
|
-
# each line of input data.
|
369
|
+
# each line of input data. The maximum number of users per segment is
|
370
|
+
# 5 million.
|
407
371
|
# @return [Integer]
|
408
372
|
#
|
409
373
|
# @!attribute [rw] job_input
|
@@ -463,16 +427,6 @@ module Aws::Personalize
|
|
463
427
|
|
464
428
|
# The input configuration of a batch segment job.
|
465
429
|
#
|
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
430
|
# @!attribute [rw] s3_data_source
|
477
431
|
# The configuration details of an Amazon S3 input or output bucket.
|
478
432
|
# @return [Types::S3DataConfig]
|
@@ -487,16 +441,6 @@ module Aws::Personalize
|
|
487
441
|
|
488
442
|
# The output configuration parameters of a batch segment job.
|
489
443
|
#
|
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
444
|
# @!attribute [rw] s3_data_destination
|
501
445
|
# The configuration details of an Amazon S3 input or output bucket.
|
502
446
|
# @return [Types::S3DataConfig]
|
@@ -592,7 +536,11 @@ module Aws::Personalize
|
|
592
536
|
#
|
593
537
|
# @!attribute [rw] min_provisioned_tps
|
594
538
|
# Specifies the requested minimum provisioned transactions
|
595
|
-
# (recommendations) per second.
|
539
|
+
# (recommendations) per second. A high `minProvisionedTPS` will
|
540
|
+
# increase your bill. We recommend starting with 1 for
|
541
|
+
# `minProvisionedTPS` (the default). Track your usage using Amazon
|
542
|
+
# CloudWatch metrics, and increase the `minProvisionedTPS` as
|
543
|
+
# necessary.
|
596
544
|
# @return [Integer]
|
597
545
|
#
|
598
546
|
# @!attribute [rw] campaign_config
|
@@ -651,15 +599,6 @@ module Aws::Personalize
|
|
651
599
|
|
652
600
|
# The configuration details of a campaign.
|
653
601
|
#
|
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
602
|
# @!attribute [rw] item_exploration_config
|
664
603
|
# Specifies the exploration configuration hyperparameters, including
|
665
604
|
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
@@ -792,14 +731,6 @@ module Aws::Personalize
|
|
792
731
|
|
793
732
|
# Provides the name and range of a categorical hyperparameter.
|
794
733
|
#
|
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
734
|
# @!attribute [rw] name
|
804
735
|
# The name of the hyperparameter.
|
805
736
|
# @return [String]
|
@@ -819,15 +750,6 @@ module Aws::Personalize
|
|
819
750
|
|
820
751
|
# Provides the name and range of a continuous hyperparameter.
|
821
752
|
#
|
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
753
|
# @!attribute [rw] name
|
832
754
|
# The name of the hyperparameter.
|
833
755
|
# @return [String]
|
@@ -850,40 +772,6 @@ module Aws::Personalize
|
|
850
772
|
include Aws::Structure
|
851
773
|
end
|
852
774
|
|
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
775
|
# @!attribute [rw] job_name
|
888
776
|
# The name of the batch inference job to create.
|
889
777
|
# @return [String]
|
@@ -932,7 +820,7 @@ module Aws::Personalize
|
|
932
820
|
#
|
933
821
|
#
|
934
822
|
#
|
935
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
823
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
936
824
|
# @return [Array<Types::Tag>]
|
937
825
|
#
|
938
826
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
|
@@ -963,35 +851,6 @@ module Aws::Personalize
|
|
963
851
|
include Aws::Structure
|
964
852
|
end
|
965
853
|
|
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
854
|
# @!attribute [rw] job_name
|
996
855
|
# The name of the batch segment job to create.
|
997
856
|
# @return [String]
|
@@ -1013,7 +872,8 @@ module Aws::Personalize
|
|
1013
872
|
#
|
1014
873
|
# @!attribute [rw] num_results
|
1015
874
|
# The number of predicted users generated by the batch segment job for
|
1016
|
-
# each line of input data.
|
875
|
+
# each line of input data. The maximum number of users per segment is
|
876
|
+
# 5 million.
|
1017
877
|
# @return [Integer]
|
1018
878
|
#
|
1019
879
|
# @!attribute [rw] job_input
|
@@ -1037,7 +897,7 @@ module Aws::Personalize
|
|
1037
897
|
#
|
1038
898
|
#
|
1039
899
|
#
|
1040
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
900
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1041
901
|
# @return [Array<Types::Tag>]
|
1042
902
|
#
|
1043
903
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobRequest AWS API Documentation
|
@@ -1067,26 +927,6 @@ module Aws::Personalize
|
|
1067
927
|
include Aws::Structure
|
1068
928
|
end
|
1069
929
|
|
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
930
|
# @!attribute [rw] name
|
1091
931
|
# A name for the new campaign. The campaign name must be unique within
|
1092
932
|
# your account.
|
@@ -1098,7 +938,11 @@ module Aws::Personalize
|
|
1098
938
|
#
|
1099
939
|
# @!attribute [rw] min_provisioned_tps
|
1100
940
|
# Specifies the requested minimum provisioned transactions
|
1101
|
-
# (recommendations) per second that Amazon Personalize will support.
|
941
|
+
# (recommendations) per second that Amazon Personalize will support. A
|
942
|
+
# high `minProvisionedTPS` will increase your bill. We recommend
|
943
|
+
# starting with 1 for `minProvisionedTPS` (the default). Track your
|
944
|
+
# usage using Amazon CloudWatch metrics, and increase the
|
945
|
+
# `minProvisionedTPS` as necessary.
|
1102
946
|
# @return [Integer]
|
1103
947
|
#
|
1104
948
|
# @!attribute [rw] campaign_config
|
@@ -1110,7 +954,7 @@ module Aws::Personalize
|
|
1110
954
|
#
|
1111
955
|
#
|
1112
956
|
#
|
1113
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
957
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1114
958
|
# @return [Array<Types::Tag>]
|
1115
959
|
#
|
1116
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaignRequest AWS API Documentation
|
@@ -1137,28 +981,6 @@ module Aws::Personalize
|
|
1137
981
|
include Aws::Structure
|
1138
982
|
end
|
1139
983
|
|
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
984
|
# @!attribute [rw] job_name
|
1163
985
|
# The name for the dataset export job.
|
1164
986
|
# @return [String]
|
@@ -1190,7 +1012,7 @@ module Aws::Personalize
|
|
1190
1012
|
#
|
1191
1013
|
#
|
1192
1014
|
#
|
1193
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1015
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1194
1016
|
# @return [Array<Types::Tag>]
|
1195
1017
|
#
|
1196
1018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobRequest AWS API Documentation
|
@@ -1218,22 +1040,6 @@ module Aws::Personalize
|
|
1218
1040
|
include Aws::Structure
|
1219
1041
|
end
|
1220
1042
|
|
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
1043
|
# @!attribute [rw] name
|
1238
1044
|
# The name for the new dataset group.
|
1239
1045
|
# @return [String]
|
@@ -1262,7 +1068,7 @@ module Aws::Personalize
|
|
1262
1068
|
#
|
1263
1069
|
#
|
1264
1070
|
#
|
1265
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1071
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1266
1072
|
# @return [Array<Types::Tag>]
|
1267
1073
|
#
|
1268
1074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupRequest AWS API Documentation
|
@@ -1294,26 +1100,6 @@ module Aws::Personalize
|
|
1294
1100
|
include Aws::Structure
|
1295
1101
|
end
|
1296
1102
|
|
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
|
-
# publish_attribution_metrics_to_s3: false,
|
1315
|
-
# }
|
1316
|
-
#
|
1317
1103
|
# @!attribute [rw] job_name
|
1318
1104
|
# The name for the dataset import job.
|
1319
1105
|
# @return [String]
|
@@ -1336,7 +1122,7 @@ module Aws::Personalize
|
|
1336
1122
|
#
|
1337
1123
|
#
|
1338
1124
|
#
|
1339
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1125
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1340
1126
|
# @return [Array<Types::Tag>]
|
1341
1127
|
#
|
1342
1128
|
# @!attribute [rw] import_mode
|
@@ -1383,22 +1169,6 @@ module Aws::Personalize
|
|
1383
1169
|
include Aws::Structure
|
1384
1170
|
end
|
1385
1171
|
|
1386
|
-
# @note When making an API call, you may pass CreateDatasetRequest
|
1387
|
-
# data as a hash:
|
1388
|
-
#
|
1389
|
-
# {
|
1390
|
-
# name: "Name", # required
|
1391
|
-
# schema_arn: "Arn", # required
|
1392
|
-
# dataset_group_arn: "Arn", # required
|
1393
|
-
# dataset_type: "DatasetType", # required
|
1394
|
-
# tags: [
|
1395
|
-
# {
|
1396
|
-
# tag_key: "TagKey", # required
|
1397
|
-
# tag_value: "TagValue", # required
|
1398
|
-
# },
|
1399
|
-
# ],
|
1400
|
-
# }
|
1401
|
-
#
|
1402
1172
|
# @!attribute [rw] name
|
1403
1173
|
# The name for the dataset.
|
1404
1174
|
# @return [String]
|
@@ -1430,7 +1200,7 @@ module Aws::Personalize
|
|
1430
1200
|
#
|
1431
1201
|
#
|
1432
1202
|
#
|
1433
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1203
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1434
1204
|
# @return [Array<Types::Tag>]
|
1435
1205
|
#
|
1436
1206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetRequest AWS API Documentation
|
@@ -1457,20 +1227,6 @@ module Aws::Personalize
|
|
1457
1227
|
include Aws::Structure
|
1458
1228
|
end
|
1459
1229
|
|
1460
|
-
# @note When making an API call, you may pass CreateEventTrackerRequest
|
1461
|
-
# data as a hash:
|
1462
|
-
#
|
1463
|
-
# {
|
1464
|
-
# name: "Name", # required
|
1465
|
-
# dataset_group_arn: "Arn", # required
|
1466
|
-
# tags: [
|
1467
|
-
# {
|
1468
|
-
# tag_key: "TagKey", # required
|
1469
|
-
# tag_value: "TagValue", # required
|
1470
|
-
# },
|
1471
|
-
# ],
|
1472
|
-
# }
|
1473
|
-
#
|
1474
1230
|
# @!attribute [rw] name
|
1475
1231
|
# The name for the event tracker.
|
1476
1232
|
# @return [String]
|
@@ -1485,7 +1241,7 @@ module Aws::Personalize
|
|
1485
1241
|
#
|
1486
1242
|
#
|
1487
1243
|
#
|
1488
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1244
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1489
1245
|
# @return [Array<Types::Tag>]
|
1490
1246
|
#
|
1491
1247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTrackerRequest AWS API Documentation
|
@@ -1520,21 +1276,6 @@ module Aws::Personalize
|
|
1520
1276
|
include Aws::Structure
|
1521
1277
|
end
|
1522
1278
|
|
1523
|
-
# @note When making an API call, you may pass CreateFilterRequest
|
1524
|
-
# data as a hash:
|
1525
|
-
#
|
1526
|
-
# {
|
1527
|
-
# name: "Name", # required
|
1528
|
-
# dataset_group_arn: "Arn", # required
|
1529
|
-
# filter_expression: "FilterExpression", # required
|
1530
|
-
# tags: [
|
1531
|
-
# {
|
1532
|
-
# tag_key: "TagKey", # required
|
1533
|
-
# tag_value: "TagValue", # required
|
1534
|
-
# },
|
1535
|
-
# ],
|
1536
|
-
# }
|
1537
|
-
#
|
1538
1279
|
# @!attribute [rw] name
|
1539
1280
|
# The name of the filter to create.
|
1540
1281
|
# @return [String]
|
@@ -1559,7 +1300,7 @@ module Aws::Personalize
|
|
1559
1300
|
#
|
1560
1301
|
#
|
1561
1302
|
#
|
1562
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1303
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1563
1304
|
# @return [Array<Types::Tag>]
|
1564
1305
|
#
|
1565
1306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
|
@@ -1585,28 +1326,6 @@ module Aws::Personalize
|
|
1585
1326
|
include Aws::Structure
|
1586
1327
|
end
|
1587
1328
|
|
1588
|
-
# @note When making an API call, you may pass CreateMetricAttributionRequest
|
1589
|
-
# data as a hash:
|
1590
|
-
#
|
1591
|
-
# {
|
1592
|
-
# name: "Name", # required
|
1593
|
-
# dataset_group_arn: "Arn", # required
|
1594
|
-
# metrics: [ # required
|
1595
|
-
# {
|
1596
|
-
# event_type: "EventType", # required
|
1597
|
-
# metric_name: "MetricName", # required
|
1598
|
-
# expression: "MetricExpression", # required
|
1599
|
-
# },
|
1600
|
-
# ],
|
1601
|
-
# metrics_output_config: { # required
|
1602
|
-
# s3_data_destination: {
|
1603
|
-
# path: "S3Location", # required
|
1604
|
-
# kms_key_arn: "KmsKeyArn",
|
1605
|
-
# },
|
1606
|
-
# role_arn: "RoleArn", # required
|
1607
|
-
# },
|
1608
|
-
# }
|
1609
|
-
#
|
1610
1329
|
# @!attribute [rw] name
|
1611
1330
|
# A name for the metric attribution.
|
1612
1331
|
# @return [String]
|
@@ -1651,27 +1370,6 @@ module Aws::Personalize
|
|
1651
1370
|
include Aws::Structure
|
1652
1371
|
end
|
1653
1372
|
|
1654
|
-
# @note When making an API call, you may pass CreateRecommenderRequest
|
1655
|
-
# data as a hash:
|
1656
|
-
#
|
1657
|
-
# {
|
1658
|
-
# name: "Name", # required
|
1659
|
-
# dataset_group_arn: "Arn", # required
|
1660
|
-
# recipe_arn: "Arn", # required
|
1661
|
-
# recommender_config: {
|
1662
|
-
# item_exploration_config: {
|
1663
|
-
# "ParameterName" => "ParameterValue",
|
1664
|
-
# },
|
1665
|
-
# min_recommendation_requests_per_second: 1,
|
1666
|
-
# },
|
1667
|
-
# tags: [
|
1668
|
-
# {
|
1669
|
-
# tag_key: "TagKey", # required
|
1670
|
-
# tag_value: "TagValue", # required
|
1671
|
-
# },
|
1672
|
-
# ],
|
1673
|
-
# }
|
1674
|
-
#
|
1675
1373
|
# @!attribute [rw] name
|
1676
1374
|
# The name of the recommender.
|
1677
1375
|
# @return [String]
|
@@ -1702,7 +1400,7 @@ module Aws::Personalize
|
|
1702
1400
|
#
|
1703
1401
|
#
|
1704
1402
|
#
|
1705
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1403
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1706
1404
|
# @return [Array<Types::Tag>]
|
1707
1405
|
#
|
1708
1406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderRequest AWS API Documentation
|
@@ -1729,15 +1427,6 @@ module Aws::Personalize
|
|
1729
1427
|
include Aws::Structure
|
1730
1428
|
end
|
1731
1429
|
|
1732
|
-
# @note When making an API call, you may pass CreateSchemaRequest
|
1733
|
-
# data as a hash:
|
1734
|
-
#
|
1735
|
-
# {
|
1736
|
-
# name: "Name", # required
|
1737
|
-
# schema: "AvroSchema", # required
|
1738
|
-
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
1739
|
-
# }
|
1740
|
-
#
|
1741
1430
|
# @!attribute [rw] name
|
1742
1431
|
# The name for the schema.
|
1743
1432
|
# @return [String]
|
@@ -1774,74 +1463,6 @@ module Aws::Personalize
|
|
1774
1463
|
include Aws::Structure
|
1775
1464
|
end
|
1776
1465
|
|
1777
|
-
# @note When making an API call, you may pass CreateSolutionRequest
|
1778
|
-
# data as a hash:
|
1779
|
-
#
|
1780
|
-
# {
|
1781
|
-
# name: "Name", # required
|
1782
|
-
# perform_hpo: false,
|
1783
|
-
# perform_auto_ml: false,
|
1784
|
-
# recipe_arn: "Arn",
|
1785
|
-
# dataset_group_arn: "Arn", # required
|
1786
|
-
# event_type: "EventType",
|
1787
|
-
# solution_config: {
|
1788
|
-
# event_value_threshold: "EventValueThreshold",
|
1789
|
-
# hpo_config: {
|
1790
|
-
# hpo_objective: {
|
1791
|
-
# type: "HPOObjectiveType",
|
1792
|
-
# metric_name: "MetricName",
|
1793
|
-
# metric_regex: "MetricRegex",
|
1794
|
-
# },
|
1795
|
-
# hpo_resource_config: {
|
1796
|
-
# max_number_of_training_jobs: "HPOResource",
|
1797
|
-
# max_parallel_training_jobs: "HPOResource",
|
1798
|
-
# },
|
1799
|
-
# algorithm_hyper_parameter_ranges: {
|
1800
|
-
# integer_hyper_parameter_ranges: [
|
1801
|
-
# {
|
1802
|
-
# name: "ParameterName",
|
1803
|
-
# min_value: 1,
|
1804
|
-
# max_value: 1,
|
1805
|
-
# },
|
1806
|
-
# ],
|
1807
|
-
# continuous_hyper_parameter_ranges: [
|
1808
|
-
# {
|
1809
|
-
# name: "ParameterName",
|
1810
|
-
# min_value: 1.0,
|
1811
|
-
# max_value: 1.0,
|
1812
|
-
# },
|
1813
|
-
# ],
|
1814
|
-
# categorical_hyper_parameter_ranges: [
|
1815
|
-
# {
|
1816
|
-
# name: "ParameterName",
|
1817
|
-
# values: ["CategoricalValue"],
|
1818
|
-
# },
|
1819
|
-
# ],
|
1820
|
-
# },
|
1821
|
-
# },
|
1822
|
-
# algorithm_hyper_parameters: {
|
1823
|
-
# "ParameterName" => "ParameterValue",
|
1824
|
-
# },
|
1825
|
-
# feature_transformation_parameters: {
|
1826
|
-
# "ParameterName" => "ParameterValue",
|
1827
|
-
# },
|
1828
|
-
# auto_ml_config: {
|
1829
|
-
# metric_name: "MetricName",
|
1830
|
-
# recipe_list: ["Arn"],
|
1831
|
-
# },
|
1832
|
-
# optimization_objective: {
|
1833
|
-
# item_attribute: "ItemAttribute",
|
1834
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
1835
|
-
# },
|
1836
|
-
# },
|
1837
|
-
# tags: [
|
1838
|
-
# {
|
1839
|
-
# tag_key: "TagKey", # required
|
1840
|
-
# tag_value: "TagValue", # required
|
1841
|
-
# },
|
1842
|
-
# ],
|
1843
|
-
# }
|
1844
|
-
#
|
1845
1466
|
# @!attribute [rw] name
|
1846
1467
|
# The name for the solution.
|
1847
1468
|
# @return [String]
|
@@ -1855,6 +1476,10 @@ module Aws::Personalize
|
|
1855
1476
|
# @return [Boolean]
|
1856
1477
|
#
|
1857
1478
|
# @!attribute [rw] perform_auto_ml
|
1479
|
+
# We don't recommend enabling automated machine learning. Instead,
|
1480
|
+
# match your use case to the available Amazon Personalize recipes. For
|
1481
|
+
# more information, see [Determining your use case.][1]
|
1482
|
+
#
|
1858
1483
|
# Whether to perform automated machine learning (AutoML). The default
|
1859
1484
|
# is `false`. For this case, you must specify `recipeArn`.
|
1860
1485
|
#
|
@@ -1864,6 +1489,10 @@ module Aws::Personalize
|
|
1864
1489
|
# Personalize determines the optimal recipe by running tests with
|
1865
1490
|
# different values for the hyperparameters. AutoML lengthens the
|
1866
1491
|
# training process as compared to selecting a specific recipe.
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
#
|
1495
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html
|
1867
1496
|
# @return [Boolean]
|
1868
1497
|
#
|
1869
1498
|
# @!attribute [rw] recipe_arn
|
@@ -1901,7 +1530,7 @@ module Aws::Personalize
|
|
1901
1530
|
#
|
1902
1531
|
#
|
1903
1532
|
#
|
1904
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1533
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1905
1534
|
# @return [Array<Types::Tag>]
|
1906
1535
|
#
|
1907
1536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
|
@@ -1931,21 +1560,6 @@ module Aws::Personalize
|
|
1931
1560
|
include Aws::Structure
|
1932
1561
|
end
|
1933
1562
|
|
1934
|
-
# @note When making an API call, you may pass CreateSolutionVersionRequest
|
1935
|
-
# data as a hash:
|
1936
|
-
#
|
1937
|
-
# {
|
1938
|
-
# name: "Name",
|
1939
|
-
# solution_arn: "Arn", # required
|
1940
|
-
# training_mode: "FULL", # accepts FULL, UPDATE
|
1941
|
-
# tags: [
|
1942
|
-
# {
|
1943
|
-
# tag_key: "TagKey", # required
|
1944
|
-
# tag_value: "TagValue", # required
|
1945
|
-
# },
|
1946
|
-
# ],
|
1947
|
-
# }
|
1948
|
-
#
|
1949
1563
|
# @!attribute [rw] name
|
1950
1564
|
# The name of the solution version.
|
1951
1565
|
# @return [String]
|
@@ -1980,7 +1594,7 @@ module Aws::Personalize
|
|
1980
1594
|
#
|
1981
1595
|
#
|
1982
1596
|
#
|
1983
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
1597
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
1984
1598
|
# @return [Array<Types::Tag>]
|
1985
1599
|
#
|
1986
1600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
|
@@ -2009,13 +1623,6 @@ module Aws::Personalize
|
|
2009
1623
|
# Describes the data source that contains the data to upload to a
|
2010
1624
|
# dataset.
|
2011
1625
|
#
|
2012
|
-
# @note When making an API call, you may pass DataSource
|
2013
|
-
# data as a hash:
|
2014
|
-
#
|
2015
|
-
# {
|
2016
|
-
# data_location: "S3Location",
|
2017
|
-
# }
|
2018
|
-
#
|
2019
1626
|
# @!attribute [rw] data_location
|
2020
1627
|
# The path to the Amazon S3 bucket where the data that you want to
|
2021
1628
|
# upload to your dataset is stored. For example:
|
@@ -2183,16 +1790,6 @@ module Aws::Personalize
|
|
2183
1790
|
|
2184
1791
|
# The output configuration parameters of a dataset export job.
|
2185
1792
|
#
|
2186
|
-
# @note When making an API call, you may pass DatasetExportJobOutput
|
2187
|
-
# data as a hash:
|
2188
|
-
#
|
2189
|
-
# {
|
2190
|
-
# s3_data_destination: { # required
|
2191
|
-
# path: "S3Location", # required
|
2192
|
-
# kms_key_arn: "KmsKeyArn",
|
2193
|
-
# },
|
2194
|
-
# }
|
2195
|
-
#
|
2196
1793
|
# @!attribute [rw] s3_data_destination
|
2197
1794
|
# The configuration details of an Amazon S3 input or output bucket.
|
2198
1795
|
# @return [Types::S3DataConfig]
|
@@ -2803,13 +2400,6 @@ module Aws::Personalize
|
|
2803
2400
|
include Aws::Structure
|
2804
2401
|
end
|
2805
2402
|
|
2806
|
-
# @note When making an API call, you may pass DeleteCampaignRequest
|
2807
|
-
# data as a hash:
|
2808
|
-
#
|
2809
|
-
# {
|
2810
|
-
# campaign_arn: "Arn", # required
|
2811
|
-
# }
|
2812
|
-
#
|
2813
2403
|
# @!attribute [rw] campaign_arn
|
2814
2404
|
# The Amazon Resource Name (ARN) of the campaign to delete.
|
2815
2405
|
# @return [String]
|
@@ -2822,13 +2412,6 @@ module Aws::Personalize
|
|
2822
2412
|
include Aws::Structure
|
2823
2413
|
end
|
2824
2414
|
|
2825
|
-
# @note When making an API call, you may pass DeleteDatasetGroupRequest
|
2826
|
-
# data as a hash:
|
2827
|
-
#
|
2828
|
-
# {
|
2829
|
-
# dataset_group_arn: "Arn", # required
|
2830
|
-
# }
|
2831
|
-
#
|
2832
2415
|
# @!attribute [rw] dataset_group_arn
|
2833
2416
|
# The ARN of the dataset group to delete.
|
2834
2417
|
# @return [String]
|
@@ -2841,13 +2424,6 @@ module Aws::Personalize
|
|
2841
2424
|
include Aws::Structure
|
2842
2425
|
end
|
2843
2426
|
|
2844
|
-
# @note When making an API call, you may pass DeleteDatasetRequest
|
2845
|
-
# data as a hash:
|
2846
|
-
#
|
2847
|
-
# {
|
2848
|
-
# dataset_arn: "Arn", # required
|
2849
|
-
# }
|
2850
|
-
#
|
2851
2427
|
# @!attribute [rw] dataset_arn
|
2852
2428
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
2853
2429
|
# @return [String]
|
@@ -2860,13 +2436,6 @@ module Aws::Personalize
|
|
2860
2436
|
include Aws::Structure
|
2861
2437
|
end
|
2862
2438
|
|
2863
|
-
# @note When making an API call, you may pass DeleteEventTrackerRequest
|
2864
|
-
# data as a hash:
|
2865
|
-
#
|
2866
|
-
# {
|
2867
|
-
# event_tracker_arn: "Arn", # required
|
2868
|
-
# }
|
2869
|
-
#
|
2870
2439
|
# @!attribute [rw] event_tracker_arn
|
2871
2440
|
# The Amazon Resource Name (ARN) of the event tracker to delete.
|
2872
2441
|
# @return [String]
|
@@ -2879,13 +2448,6 @@ module Aws::Personalize
|
|
2879
2448
|
include Aws::Structure
|
2880
2449
|
end
|
2881
2450
|
|
2882
|
-
# @note When making an API call, you may pass DeleteFilterRequest
|
2883
|
-
# data as a hash:
|
2884
|
-
#
|
2885
|
-
# {
|
2886
|
-
# filter_arn: "Arn", # required
|
2887
|
-
# }
|
2888
|
-
#
|
2889
2451
|
# @!attribute [rw] filter_arn
|
2890
2452
|
# The ARN of the filter to delete.
|
2891
2453
|
# @return [String]
|
@@ -2898,13 +2460,6 @@ module Aws::Personalize
|
|
2898
2460
|
include Aws::Structure
|
2899
2461
|
end
|
2900
2462
|
|
2901
|
-
# @note When making an API call, you may pass DeleteMetricAttributionRequest
|
2902
|
-
# data as a hash:
|
2903
|
-
#
|
2904
|
-
# {
|
2905
|
-
# metric_attribution_arn: "Arn", # required
|
2906
|
-
# }
|
2907
|
-
#
|
2908
2463
|
# @!attribute [rw] metric_attribution_arn
|
2909
2464
|
# The metric attribution's Amazon Resource Name (ARN).
|
2910
2465
|
# @return [String]
|
@@ -2917,13 +2472,6 @@ module Aws::Personalize
|
|
2917
2472
|
include Aws::Structure
|
2918
2473
|
end
|
2919
2474
|
|
2920
|
-
# @note When making an API call, you may pass DeleteRecommenderRequest
|
2921
|
-
# data as a hash:
|
2922
|
-
#
|
2923
|
-
# {
|
2924
|
-
# recommender_arn: "Arn", # required
|
2925
|
-
# }
|
2926
|
-
#
|
2927
2475
|
# @!attribute [rw] recommender_arn
|
2928
2476
|
# The Amazon Resource Name (ARN) of the recommender to delete.
|
2929
2477
|
# @return [String]
|
@@ -2936,13 +2484,6 @@ module Aws::Personalize
|
|
2936
2484
|
include Aws::Structure
|
2937
2485
|
end
|
2938
2486
|
|
2939
|
-
# @note When making an API call, you may pass DeleteSchemaRequest
|
2940
|
-
# data as a hash:
|
2941
|
-
#
|
2942
|
-
# {
|
2943
|
-
# schema_arn: "Arn", # required
|
2944
|
-
# }
|
2945
|
-
#
|
2946
2487
|
# @!attribute [rw] schema_arn
|
2947
2488
|
# The Amazon Resource Name (ARN) of the schema to delete.
|
2948
2489
|
# @return [String]
|
@@ -2955,13 +2496,6 @@ module Aws::Personalize
|
|
2955
2496
|
include Aws::Structure
|
2956
2497
|
end
|
2957
2498
|
|
2958
|
-
# @note When making an API call, you may pass DeleteSolutionRequest
|
2959
|
-
# data as a hash:
|
2960
|
-
#
|
2961
|
-
# {
|
2962
|
-
# solution_arn: "Arn", # required
|
2963
|
-
# }
|
2964
|
-
#
|
2965
2499
|
# @!attribute [rw] solution_arn
|
2966
2500
|
# The ARN of the solution to delete.
|
2967
2501
|
# @return [String]
|
@@ -2974,13 +2508,6 @@ module Aws::Personalize
|
|
2974
2508
|
include Aws::Structure
|
2975
2509
|
end
|
2976
2510
|
|
2977
|
-
# @note When making an API call, you may pass DescribeAlgorithmRequest
|
2978
|
-
# data as a hash:
|
2979
|
-
#
|
2980
|
-
# {
|
2981
|
-
# algorithm_arn: "Arn", # required
|
2982
|
-
# }
|
2983
|
-
#
|
2984
2511
|
# @!attribute [rw] algorithm_arn
|
2985
2512
|
# The Amazon Resource Name (ARN) of the algorithm to describe.
|
2986
2513
|
# @return [String]
|
@@ -3005,13 +2532,6 @@ module Aws::Personalize
|
|
3005
2532
|
include Aws::Structure
|
3006
2533
|
end
|
3007
2534
|
|
3008
|
-
# @note When making an API call, you may pass DescribeBatchInferenceJobRequest
|
3009
|
-
# data as a hash:
|
3010
|
-
#
|
3011
|
-
# {
|
3012
|
-
# batch_inference_job_arn: "Arn", # required
|
3013
|
-
# }
|
3014
|
-
#
|
3015
2535
|
# @!attribute [rw] batch_inference_job_arn
|
3016
2536
|
# The ARN of the batch inference job to describe.
|
3017
2537
|
# @return [String]
|
@@ -3036,13 +2556,6 @@ module Aws::Personalize
|
|
3036
2556
|
include Aws::Structure
|
3037
2557
|
end
|
3038
2558
|
|
3039
|
-
# @note When making an API call, you may pass DescribeBatchSegmentJobRequest
|
3040
|
-
# data as a hash:
|
3041
|
-
#
|
3042
|
-
# {
|
3043
|
-
# batch_segment_job_arn: "Arn", # required
|
3044
|
-
# }
|
3045
|
-
#
|
3046
2559
|
# @!attribute [rw] batch_segment_job_arn
|
3047
2560
|
# The ARN of the batch segment job to describe.
|
3048
2561
|
# @return [String]
|
@@ -3067,13 +2580,6 @@ module Aws::Personalize
|
|
3067
2580
|
include Aws::Structure
|
3068
2581
|
end
|
3069
2582
|
|
3070
|
-
# @note When making an API call, you may pass DescribeCampaignRequest
|
3071
|
-
# data as a hash:
|
3072
|
-
#
|
3073
|
-
# {
|
3074
|
-
# campaign_arn: "Arn", # required
|
3075
|
-
# }
|
3076
|
-
#
|
3077
2583
|
# @!attribute [rw] campaign_arn
|
3078
2584
|
# The Amazon Resource Name (ARN) of the campaign.
|
3079
2585
|
# @return [String]
|
@@ -3098,13 +2604,6 @@ module Aws::Personalize
|
|
3098
2604
|
include Aws::Structure
|
3099
2605
|
end
|
3100
2606
|
|
3101
|
-
# @note When making an API call, you may pass DescribeDatasetExportJobRequest
|
3102
|
-
# data as a hash:
|
3103
|
-
#
|
3104
|
-
# {
|
3105
|
-
# dataset_export_job_arn: "Arn", # required
|
3106
|
-
# }
|
3107
|
-
#
|
3108
2607
|
# @!attribute [rw] dataset_export_job_arn
|
3109
2608
|
# The Amazon Resource Name (ARN) of the dataset export job to
|
3110
2609
|
# describe.
|
@@ -3140,13 +2639,6 @@ module Aws::Personalize
|
|
3140
2639
|
include Aws::Structure
|
3141
2640
|
end
|
3142
2641
|
|
3143
|
-
# @note When making an API call, you may pass DescribeDatasetGroupRequest
|
3144
|
-
# data as a hash:
|
3145
|
-
#
|
3146
|
-
# {
|
3147
|
-
# dataset_group_arn: "Arn", # required
|
3148
|
-
# }
|
3149
|
-
#
|
3150
2642
|
# @!attribute [rw] dataset_group_arn
|
3151
2643
|
# The Amazon Resource Name (ARN) of the dataset group to describe.
|
3152
2644
|
# @return [String]
|
@@ -3171,13 +2663,6 @@ module Aws::Personalize
|
|
3171
2663
|
include Aws::Structure
|
3172
2664
|
end
|
3173
2665
|
|
3174
|
-
# @note When making an API call, you may pass DescribeDatasetImportJobRequest
|
3175
|
-
# data as a hash:
|
3176
|
-
#
|
3177
|
-
# {
|
3178
|
-
# dataset_import_job_arn: "Arn", # required
|
3179
|
-
# }
|
3180
|
-
#
|
3181
2666
|
# @!attribute [rw] dataset_import_job_arn
|
3182
2667
|
# The Amazon Resource Name (ARN) of the dataset import job to
|
3183
2668
|
# describe.
|
@@ -3213,13 +2698,6 @@ module Aws::Personalize
|
|
3213
2698
|
include Aws::Structure
|
3214
2699
|
end
|
3215
2700
|
|
3216
|
-
# @note When making an API call, you may pass DescribeDatasetRequest
|
3217
|
-
# data as a hash:
|
3218
|
-
#
|
3219
|
-
# {
|
3220
|
-
# dataset_arn: "Arn", # required
|
3221
|
-
# }
|
3222
|
-
#
|
3223
2701
|
# @!attribute [rw] dataset_arn
|
3224
2702
|
# The Amazon Resource Name (ARN) of the dataset to describe.
|
3225
2703
|
# @return [String]
|
@@ -3244,13 +2722,6 @@ module Aws::Personalize
|
|
3244
2722
|
include Aws::Structure
|
3245
2723
|
end
|
3246
2724
|
|
3247
|
-
# @note When making an API call, you may pass DescribeEventTrackerRequest
|
3248
|
-
# data as a hash:
|
3249
|
-
#
|
3250
|
-
# {
|
3251
|
-
# event_tracker_arn: "Arn", # required
|
3252
|
-
# }
|
3253
|
-
#
|
3254
2725
|
# @!attribute [rw] event_tracker_arn
|
3255
2726
|
# The Amazon Resource Name (ARN) of the event tracker to describe.
|
3256
2727
|
# @return [String]
|
@@ -3275,13 +2746,6 @@ module Aws::Personalize
|
|
3275
2746
|
include Aws::Structure
|
3276
2747
|
end
|
3277
2748
|
|
3278
|
-
# @note When making an API call, you may pass DescribeFeatureTransformationRequest
|
3279
|
-
# data as a hash:
|
3280
|
-
#
|
3281
|
-
# {
|
3282
|
-
# feature_transformation_arn: "Arn", # required
|
3283
|
-
# }
|
3284
|
-
#
|
3285
2749
|
# @!attribute [rw] feature_transformation_arn
|
3286
2750
|
# The Amazon Resource Name (ARN) of the feature transformation to
|
3287
2751
|
# describe.
|
@@ -3307,13 +2771,6 @@ module Aws::Personalize
|
|
3307
2771
|
include Aws::Structure
|
3308
2772
|
end
|
3309
2773
|
|
3310
|
-
# @note When making an API call, you may pass DescribeFilterRequest
|
3311
|
-
# data as a hash:
|
3312
|
-
#
|
3313
|
-
# {
|
3314
|
-
# filter_arn: "Arn", # required
|
3315
|
-
# }
|
3316
|
-
#
|
3317
2774
|
# @!attribute [rw] filter_arn
|
3318
2775
|
# The ARN of the filter to describe.
|
3319
2776
|
# @return [String]
|
@@ -3338,13 +2795,6 @@ module Aws::Personalize
|
|
3338
2795
|
include Aws::Structure
|
3339
2796
|
end
|
3340
2797
|
|
3341
|
-
# @note When making an API call, you may pass DescribeMetricAttributionRequest
|
3342
|
-
# data as a hash:
|
3343
|
-
#
|
3344
|
-
# {
|
3345
|
-
# metric_attribution_arn: "Arn", # required
|
3346
|
-
# }
|
3347
|
-
#
|
3348
2798
|
# @!attribute [rw] metric_attribution_arn
|
3349
2799
|
# The metric attribution's Amazon Resource Name (ARN).
|
3350
2800
|
# @return [String]
|
@@ -3369,13 +2819,6 @@ module Aws::Personalize
|
|
3369
2819
|
include Aws::Structure
|
3370
2820
|
end
|
3371
2821
|
|
3372
|
-
# @note When making an API call, you may pass DescribeRecipeRequest
|
3373
|
-
# data as a hash:
|
3374
|
-
#
|
3375
|
-
# {
|
3376
|
-
# recipe_arn: "Arn", # required
|
3377
|
-
# }
|
3378
|
-
#
|
3379
2822
|
# @!attribute [rw] recipe_arn
|
3380
2823
|
# The Amazon Resource Name (ARN) of the recipe to describe.
|
3381
2824
|
# @return [String]
|
@@ -3400,13 +2843,6 @@ module Aws::Personalize
|
|
3400
2843
|
include Aws::Structure
|
3401
2844
|
end
|
3402
2845
|
|
3403
|
-
# @note When making an API call, you may pass DescribeRecommenderRequest
|
3404
|
-
# data as a hash:
|
3405
|
-
#
|
3406
|
-
# {
|
3407
|
-
# recommender_arn: "Arn", # required
|
3408
|
-
# }
|
3409
|
-
#
|
3410
2846
|
# @!attribute [rw] recommender_arn
|
3411
2847
|
# The Amazon Resource Name (ARN) of the recommender to describe.
|
3412
2848
|
# @return [String]
|
@@ -3431,13 +2867,6 @@ module Aws::Personalize
|
|
3431
2867
|
include Aws::Structure
|
3432
2868
|
end
|
3433
2869
|
|
3434
|
-
# @note When making an API call, you may pass DescribeSchemaRequest
|
3435
|
-
# data as a hash:
|
3436
|
-
#
|
3437
|
-
# {
|
3438
|
-
# schema_arn: "Arn", # required
|
3439
|
-
# }
|
3440
|
-
#
|
3441
2870
|
# @!attribute [rw] schema_arn
|
3442
2871
|
# The Amazon Resource Name (ARN) of the schema to retrieve.
|
3443
2872
|
# @return [String]
|
@@ -3462,13 +2891,6 @@ module Aws::Personalize
|
|
3462
2891
|
include Aws::Structure
|
3463
2892
|
end
|
3464
2893
|
|
3465
|
-
# @note When making an API call, you may pass DescribeSolutionRequest
|
3466
|
-
# data as a hash:
|
3467
|
-
#
|
3468
|
-
# {
|
3469
|
-
# solution_arn: "Arn", # required
|
3470
|
-
# }
|
3471
|
-
#
|
3472
2894
|
# @!attribute [rw] solution_arn
|
3473
2895
|
# The Amazon Resource Name (ARN) of the solution to describe.
|
3474
2896
|
# @return [String]
|
@@ -3493,13 +2915,6 @@ module Aws::Personalize
|
|
3493
2915
|
include Aws::Structure
|
3494
2916
|
end
|
3495
2917
|
|
3496
|
-
# @note When making an API call, you may pass DescribeSolutionVersionRequest
|
3497
|
-
# data as a hash:
|
3498
|
-
#
|
3499
|
-
# {
|
3500
|
-
# solution_version_arn: "Arn", # required
|
3501
|
-
# }
|
3502
|
-
#
|
3503
2918
|
# @!attribute [rw] solution_version_arn
|
3504
2919
|
# The Amazon Resource Name (ARN) of the solution version.
|
3505
2920
|
# @return [String]
|
@@ -3786,13 +3201,6 @@ module Aws::Personalize
|
|
3786
3201
|
include Aws::Structure
|
3787
3202
|
end
|
3788
3203
|
|
3789
|
-
# @note When making an API call, you may pass GetSolutionMetricsRequest
|
3790
|
-
# data as a hash:
|
3791
|
-
#
|
3792
|
-
# {
|
3793
|
-
# solution_version_arn: "Arn", # required
|
3794
|
-
# }
|
3795
|
-
#
|
3796
3204
|
# @!attribute [rw] solution_version_arn
|
3797
3205
|
# The Amazon Resource Name (ARN) of the solution version for which to
|
3798
3206
|
# get metrics.
|
@@ -3830,43 +3238,6 @@ module Aws::Personalize
|
|
3830
3238
|
|
3831
3239
|
# Describes the properties for hyperparameter optimization (HPO).
|
3832
3240
|
#
|
3833
|
-
# @note When making an API call, you may pass HPOConfig
|
3834
|
-
# data as a hash:
|
3835
|
-
#
|
3836
|
-
# {
|
3837
|
-
# hpo_objective: {
|
3838
|
-
# type: "HPOObjectiveType",
|
3839
|
-
# metric_name: "MetricName",
|
3840
|
-
# metric_regex: "MetricRegex",
|
3841
|
-
# },
|
3842
|
-
# hpo_resource_config: {
|
3843
|
-
# max_number_of_training_jobs: "HPOResource",
|
3844
|
-
# max_parallel_training_jobs: "HPOResource",
|
3845
|
-
# },
|
3846
|
-
# algorithm_hyper_parameter_ranges: {
|
3847
|
-
# integer_hyper_parameter_ranges: [
|
3848
|
-
# {
|
3849
|
-
# name: "ParameterName",
|
3850
|
-
# min_value: 1,
|
3851
|
-
# max_value: 1,
|
3852
|
-
# },
|
3853
|
-
# ],
|
3854
|
-
# continuous_hyper_parameter_ranges: [
|
3855
|
-
# {
|
3856
|
-
# name: "ParameterName",
|
3857
|
-
# min_value: 1.0,
|
3858
|
-
# max_value: 1.0,
|
3859
|
-
# },
|
3860
|
-
# ],
|
3861
|
-
# categorical_hyper_parameter_ranges: [
|
3862
|
-
# {
|
3863
|
-
# name: "ParameterName",
|
3864
|
-
# values: ["CategoricalValue"],
|
3865
|
-
# },
|
3866
|
-
# ],
|
3867
|
-
# },
|
3868
|
-
# }
|
3869
|
-
#
|
3870
3241
|
# @!attribute [rw] hpo_objective
|
3871
3242
|
# The metric to optimize during HPO.
|
3872
3243
|
#
|
@@ -3901,15 +3272,6 @@ module Aws::Personalize
|
|
3901
3272
|
#
|
3902
3273
|
# </note>
|
3903
3274
|
#
|
3904
|
-
# @note When making an API call, you may pass HPOObjective
|
3905
|
-
# data as a hash:
|
3906
|
-
#
|
3907
|
-
# {
|
3908
|
-
# type: "HPOObjectiveType",
|
3909
|
-
# metric_name: "MetricName",
|
3910
|
-
# metric_regex: "MetricRegex",
|
3911
|
-
# }
|
3912
|
-
#
|
3913
3275
|
# @!attribute [rw] type
|
3914
3276
|
# The type of the metric. Valid values are `Maximize` and `Minimize`.
|
3915
3277
|
# @return [String]
|
@@ -3936,14 +3298,6 @@ module Aws::Personalize
|
|
3936
3298
|
# Describes the resource configuration for hyperparameter optimization
|
3937
3299
|
# (HPO).
|
3938
3300
|
#
|
3939
|
-
# @note When making an API call, you may pass HPOResourceConfig
|
3940
|
-
# data as a hash:
|
3941
|
-
#
|
3942
|
-
# {
|
3943
|
-
# max_number_of_training_jobs: "HPOResource",
|
3944
|
-
# max_parallel_training_jobs: "HPOResource",
|
3945
|
-
# }
|
3946
|
-
#
|
3947
3301
|
# @!attribute [rw] max_number_of_training_jobs
|
3948
3302
|
# The maximum number of training jobs when you create a solution
|
3949
3303
|
# version. The maximum value for `maxNumberOfTrainingJobs` is `40`.
|
@@ -3967,32 +3321,6 @@ module Aws::Personalize
|
|
3967
3321
|
# Specifies the hyperparameters and their ranges. Hyperparameters can be
|
3968
3322
|
# categorical, continuous, or integer-valued.
|
3969
3323
|
#
|
3970
|
-
# @note When making an API call, you may pass HyperParameterRanges
|
3971
|
-
# data as a hash:
|
3972
|
-
#
|
3973
|
-
# {
|
3974
|
-
# integer_hyper_parameter_ranges: [
|
3975
|
-
# {
|
3976
|
-
# name: "ParameterName",
|
3977
|
-
# min_value: 1,
|
3978
|
-
# max_value: 1,
|
3979
|
-
# },
|
3980
|
-
# ],
|
3981
|
-
# continuous_hyper_parameter_ranges: [
|
3982
|
-
# {
|
3983
|
-
# name: "ParameterName",
|
3984
|
-
# min_value: 1.0,
|
3985
|
-
# max_value: 1.0,
|
3986
|
-
# },
|
3987
|
-
# ],
|
3988
|
-
# categorical_hyper_parameter_ranges: [
|
3989
|
-
# {
|
3990
|
-
# name: "ParameterName",
|
3991
|
-
# values: ["CategoricalValue"],
|
3992
|
-
# },
|
3993
|
-
# ],
|
3994
|
-
# }
|
3995
|
-
#
|
3996
3324
|
# @!attribute [rw] integer_hyper_parameter_ranges
|
3997
3325
|
# The integer-valued hyperparameters and their ranges.
|
3998
3326
|
# @return [Array<Types::IntegerHyperParameterRange>]
|
@@ -4017,15 +3345,6 @@ module Aws::Personalize
|
|
4017
3345
|
|
4018
3346
|
# Provides the name and range of an integer-valued hyperparameter.
|
4019
3347
|
#
|
4020
|
-
# @note When making an API call, you may pass IntegerHyperParameterRange
|
4021
|
-
# data as a hash:
|
4022
|
-
#
|
4023
|
-
# {
|
4024
|
-
# name: "ParameterName",
|
4025
|
-
# min_value: 1,
|
4026
|
-
# max_value: 1,
|
4027
|
-
# }
|
4028
|
-
#
|
4029
3348
|
# @!attribute [rw] name
|
4030
3349
|
# The name of the hyperparameter.
|
4031
3350
|
# @return [String]
|
@@ -4087,15 +3406,6 @@ module Aws::Personalize
|
|
4087
3406
|
include Aws::Structure
|
4088
3407
|
end
|
4089
3408
|
|
4090
|
-
# @note When making an API call, you may pass ListBatchInferenceJobsRequest
|
4091
|
-
# data as a hash:
|
4092
|
-
#
|
4093
|
-
# {
|
4094
|
-
# solution_version_arn: "Arn",
|
4095
|
-
# next_token: "NextToken",
|
4096
|
-
# max_results: 1,
|
4097
|
-
# }
|
4098
|
-
#
|
4099
3409
|
# @!attribute [rw] solution_version_arn
|
4100
3410
|
# The Amazon Resource Name (ARN) of the solution version from which
|
4101
3411
|
# the batch inference jobs were created.
|
@@ -4138,15 +3448,6 @@ module Aws::Personalize
|
|
4138
3448
|
include Aws::Structure
|
4139
3449
|
end
|
4140
3450
|
|
4141
|
-
# @note When making an API call, you may pass ListBatchSegmentJobsRequest
|
4142
|
-
# data as a hash:
|
4143
|
-
#
|
4144
|
-
# {
|
4145
|
-
# solution_version_arn: "Arn",
|
4146
|
-
# next_token: "NextToken",
|
4147
|
-
# max_results: 1,
|
4148
|
-
# }
|
4149
|
-
#
|
4150
3451
|
# @!attribute [rw] solution_version_arn
|
4151
3452
|
# The Amazon Resource Name (ARN) of the solution version that the
|
4152
3453
|
# batch segment jobs used to generate batch segments.
|
@@ -4189,15 +3490,6 @@ module Aws::Personalize
|
|
4189
3490
|
include Aws::Structure
|
4190
3491
|
end
|
4191
3492
|
|
4192
|
-
# @note When making an API call, you may pass ListCampaignsRequest
|
4193
|
-
# data as a hash:
|
4194
|
-
#
|
4195
|
-
# {
|
4196
|
-
# solution_arn: "Arn",
|
4197
|
-
# next_token: "NextToken",
|
4198
|
-
# max_results: 1,
|
4199
|
-
# }
|
4200
|
-
#
|
4201
3493
|
# @!attribute [rw] solution_arn
|
4202
3494
|
# The Amazon Resource Name (ARN) of the solution to list the campaigns
|
4203
3495
|
# for. When a solution is not specified, all the campaigns associated
|
@@ -4244,15 +3536,6 @@ module Aws::Personalize
|
|
4244
3536
|
include Aws::Structure
|
4245
3537
|
end
|
4246
3538
|
|
4247
|
-
# @note When making an API call, you may pass ListDatasetExportJobsRequest
|
4248
|
-
# data as a hash:
|
4249
|
-
#
|
4250
|
-
# {
|
4251
|
-
# dataset_arn: "Arn",
|
4252
|
-
# next_token: "NextToken",
|
4253
|
-
# max_results: 1,
|
4254
|
-
# }
|
4255
|
-
#
|
4256
3539
|
# @!attribute [rw] dataset_arn
|
4257
3540
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
4258
3541
|
# export jobs for.
|
@@ -4295,14 +3578,6 @@ module Aws::Personalize
|
|
4295
3578
|
include Aws::Structure
|
4296
3579
|
end
|
4297
3580
|
|
4298
|
-
# @note When making an API call, you may pass ListDatasetGroupsRequest
|
4299
|
-
# data as a hash:
|
4300
|
-
#
|
4301
|
-
# {
|
4302
|
-
# next_token: "NextToken",
|
4303
|
-
# max_results: 1,
|
4304
|
-
# }
|
4305
|
-
#
|
4306
3581
|
# @!attribute [rw] next_token
|
4307
3582
|
# A token returned from the previous call to `ListDatasetGroups` for
|
4308
3583
|
# getting the next set of dataset groups (if they exist).
|
@@ -4338,15 +3613,6 @@ module Aws::Personalize
|
|
4338
3613
|
include Aws::Structure
|
4339
3614
|
end
|
4340
3615
|
|
4341
|
-
# @note When making an API call, you may pass ListDatasetImportJobsRequest
|
4342
|
-
# data as a hash:
|
4343
|
-
#
|
4344
|
-
# {
|
4345
|
-
# dataset_arn: "Arn",
|
4346
|
-
# next_token: "NextToken",
|
4347
|
-
# max_results: 1,
|
4348
|
-
# }
|
4349
|
-
#
|
4350
3616
|
# @!attribute [rw] dataset_arn
|
4351
3617
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
4352
3618
|
# import jobs for.
|
@@ -4389,15 +3655,6 @@ module Aws::Personalize
|
|
4389
3655
|
include Aws::Structure
|
4390
3656
|
end
|
4391
3657
|
|
4392
|
-
# @note When making an API call, you may pass ListDatasetsRequest
|
4393
|
-
# data as a hash:
|
4394
|
-
#
|
4395
|
-
# {
|
4396
|
-
# dataset_group_arn: "Arn",
|
4397
|
-
# next_token: "NextToken",
|
4398
|
-
# max_results: 1,
|
4399
|
-
# }
|
4400
|
-
#
|
4401
3658
|
# @!attribute [rw] dataset_group_arn
|
4402
3659
|
# The Amazon Resource Name (ARN) of the dataset group that contains
|
4403
3660
|
# the datasets to list.
|
@@ -4440,15 +3697,6 @@ module Aws::Personalize
|
|
4440
3697
|
include Aws::Structure
|
4441
3698
|
end
|
4442
3699
|
|
4443
|
-
# @note When making an API call, you may pass ListEventTrackersRequest
|
4444
|
-
# data as a hash:
|
4445
|
-
#
|
4446
|
-
# {
|
4447
|
-
# dataset_group_arn: "Arn",
|
4448
|
-
# next_token: "NextToken",
|
4449
|
-
# max_results: 1,
|
4450
|
-
# }
|
4451
|
-
#
|
4452
3700
|
# @!attribute [rw] dataset_group_arn
|
4453
3701
|
# The ARN of a dataset group used to filter the response.
|
4454
3702
|
# @return [String]
|
@@ -4489,15 +3737,6 @@ module Aws::Personalize
|
|
4489
3737
|
include Aws::Structure
|
4490
3738
|
end
|
4491
3739
|
|
4492
|
-
# @note When making an API call, you may pass ListFiltersRequest
|
4493
|
-
# data as a hash:
|
4494
|
-
#
|
4495
|
-
# {
|
4496
|
-
# dataset_group_arn: "Arn",
|
4497
|
-
# next_token: "NextToken",
|
4498
|
-
# max_results: 1,
|
4499
|
-
# }
|
4500
|
-
#
|
4501
3740
|
# @!attribute [rw] dataset_group_arn
|
4502
3741
|
# The ARN of the dataset group that contains the filters.
|
4503
3742
|
# @return [String]
|
@@ -4538,15 +3777,6 @@ module Aws::Personalize
|
|
4538
3777
|
include Aws::Structure
|
4539
3778
|
end
|
4540
3779
|
|
4541
|
-
# @note When making an API call, you may pass ListMetricAttributionMetricsRequest
|
4542
|
-
# data as a hash:
|
4543
|
-
#
|
4544
|
-
# {
|
4545
|
-
# metric_attribution_arn: "Arn",
|
4546
|
-
# next_token: "NextToken",
|
4547
|
-
# max_results: 1,
|
4548
|
-
# }
|
4549
|
-
#
|
4550
3780
|
# @!attribute [rw] metric_attribution_arn
|
4551
3781
|
# The Amazon Resource Name (ARN) of the metric attribution to retrieve
|
4552
3782
|
# attributes for.
|
@@ -4590,15 +3820,6 @@ module Aws::Personalize
|
|
4590
3820
|
include Aws::Structure
|
4591
3821
|
end
|
4592
3822
|
|
4593
|
-
# @note When making an API call, you may pass ListMetricAttributionsRequest
|
4594
|
-
# data as a hash:
|
4595
|
-
#
|
4596
|
-
# {
|
4597
|
-
# dataset_group_arn: "Arn",
|
4598
|
-
# next_token: "NextToken",
|
4599
|
-
# max_results: 1,
|
4600
|
-
# }
|
4601
|
-
#
|
4602
3823
|
# @!attribute [rw] dataset_group_arn
|
4603
3824
|
# The metric attributions' dataset group Amazon Resource Name (ARN).
|
4604
3825
|
# @return [String]
|
@@ -4641,16 +3862,6 @@ module Aws::Personalize
|
|
4641
3862
|
include Aws::Structure
|
4642
3863
|
end
|
4643
3864
|
|
4644
|
-
# @note When making an API call, you may pass ListRecipesRequest
|
4645
|
-
# data as a hash:
|
4646
|
-
#
|
4647
|
-
# {
|
4648
|
-
# recipe_provider: "SERVICE", # accepts SERVICE
|
4649
|
-
# next_token: "NextToken",
|
4650
|
-
# max_results: 1,
|
4651
|
-
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
4652
|
-
# }
|
4653
|
-
#
|
4654
3865
|
# @!attribute [rw] recipe_provider
|
4655
3866
|
# The default is `SERVICE`.
|
4656
3867
|
# @return [String]
|
@@ -4699,15 +3910,6 @@ module Aws::Personalize
|
|
4699
3910
|
include Aws::Structure
|
4700
3911
|
end
|
4701
3912
|
|
4702
|
-
# @note When making an API call, you may pass ListRecommendersRequest
|
4703
|
-
# data as a hash:
|
4704
|
-
#
|
4705
|
-
# {
|
4706
|
-
# dataset_group_arn: "Arn",
|
4707
|
-
# next_token: "NextToken",
|
4708
|
-
# max_results: 1,
|
4709
|
-
# }
|
4710
|
-
#
|
4711
3913
|
# @!attribute [rw] dataset_group_arn
|
4712
3914
|
# The Amazon Resource Name (ARN) of the Domain dataset group to list
|
4713
3915
|
# the recommenders for. When a Domain dataset group is not specified,
|
@@ -4750,14 +3952,6 @@ module Aws::Personalize
|
|
4750
3952
|
include Aws::Structure
|
4751
3953
|
end
|
4752
3954
|
|
4753
|
-
# @note When making an API call, you may pass ListSchemasRequest
|
4754
|
-
# data as a hash:
|
4755
|
-
#
|
4756
|
-
# {
|
4757
|
-
# next_token: "NextToken",
|
4758
|
-
# max_results: 1,
|
4759
|
-
# }
|
4760
|
-
#
|
4761
3955
|
# @!attribute [rw] next_token
|
4762
3956
|
# A token returned from the previous call to `ListSchemas` for getting
|
4763
3957
|
# the next set of schemas (if they exist).
|
@@ -4793,15 +3987,6 @@ module Aws::Personalize
|
|
4793
3987
|
include Aws::Structure
|
4794
3988
|
end
|
4795
3989
|
|
4796
|
-
# @note When making an API call, you may pass ListSolutionVersionsRequest
|
4797
|
-
# data as a hash:
|
4798
|
-
#
|
4799
|
-
# {
|
4800
|
-
# solution_arn: "Arn",
|
4801
|
-
# next_token: "NextToken",
|
4802
|
-
# max_results: 1,
|
4803
|
-
# }
|
4804
|
-
#
|
4805
3990
|
# @!attribute [rw] solution_arn
|
4806
3991
|
# The Amazon Resource Name (ARN) of the solution.
|
4807
3992
|
# @return [String]
|
@@ -4843,15 +4028,6 @@ module Aws::Personalize
|
|
4843
4028
|
include Aws::Structure
|
4844
4029
|
end
|
4845
4030
|
|
4846
|
-
# @note When making an API call, you may pass ListSolutionsRequest
|
4847
|
-
# data as a hash:
|
4848
|
-
#
|
4849
|
-
# {
|
4850
|
-
# dataset_group_arn: "Arn",
|
4851
|
-
# next_token: "NextToken",
|
4852
|
-
# max_results: 1,
|
4853
|
-
# }
|
4854
|
-
#
|
4855
4031
|
# @!attribute [rw] dataset_group_arn
|
4856
4032
|
# The Amazon Resource Name (ARN) of the dataset group.
|
4857
4033
|
# @return [String]
|
@@ -4892,13 +4068,6 @@ module Aws::Personalize
|
|
4892
4068
|
include Aws::Structure
|
4893
4069
|
end
|
4894
4070
|
|
4895
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4896
|
-
# data as a hash:
|
4897
|
-
#
|
4898
|
-
# {
|
4899
|
-
# resource_arn: "Arn", # required
|
4900
|
-
# }
|
4901
|
-
#
|
4902
4071
|
# @!attribute [rw] resource_arn
|
4903
4072
|
# The resource's Amazon Resource Name.
|
4904
4073
|
# @return [String]
|
@@ -4930,15 +4099,6 @@ module Aws::Personalize
|
|
4930
4099
|
#
|
4931
4100
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
4932
4101
|
#
|
4933
|
-
# @note When making an API call, you may pass MetricAttribute
|
4934
|
-
# data as a hash:
|
4935
|
-
#
|
4936
|
-
# {
|
4937
|
-
# event_type: "EventType", # required
|
4938
|
-
# metric_name: "MetricName", # required
|
4939
|
-
# expression: "MetricExpression", # required
|
4940
|
-
# }
|
4941
|
-
#
|
4942
4102
|
# @!attribute [rw] event_type
|
4943
4103
|
# The metric's event type.
|
4944
4104
|
# @return [String]
|
@@ -5024,17 +4184,6 @@ module Aws::Personalize
|
|
5024
4184
|
|
5025
4185
|
# The output configuration details for a metric attribution.
|
5026
4186
|
#
|
5027
|
-
# @note When making an API call, you may pass MetricAttributionOutput
|
5028
|
-
# data as a hash:
|
5029
|
-
#
|
5030
|
-
# {
|
5031
|
-
# s3_data_destination: {
|
5032
|
-
# path: "S3Location", # required
|
5033
|
-
# kms_key_arn: "KmsKeyArn",
|
5034
|
-
# },
|
5035
|
-
# role_arn: "RoleArn", # required
|
5036
|
-
# }
|
5037
|
-
#
|
5038
4187
|
# @!attribute [rw] s3_data_destination
|
5039
4188
|
# The configuration details of an Amazon S3 input or output bucket.
|
5040
4189
|
# @return [Types::S3DataConfig]
|
@@ -5111,14 +4260,6 @@ module Aws::Personalize
|
|
5111
4260
|
#
|
5112
4261
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html
|
5113
4262
|
#
|
5114
|
-
# @note When making an API call, you may pass OptimizationObjective
|
5115
|
-
# data as a hash:
|
5116
|
-
#
|
5117
|
-
# {
|
5118
|
-
# item_attribute: "ItemAttribute",
|
5119
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
5120
|
-
# }
|
5121
|
-
#
|
5122
4263
|
# @!attribute [rw] item_attribute
|
5123
4264
|
# The numerical metadata column in an Items dataset related to the
|
5124
4265
|
# optimization objective. For example, VIDEO\_LENGTH (to maximize
|
@@ -5343,16 +4484,6 @@ module Aws::Personalize
|
|
5343
4484
|
|
5344
4485
|
# The configuration details of the recommender.
|
5345
4486
|
#
|
5346
|
-
# @note When making an API call, you may pass RecommenderConfig
|
5347
|
-
# data as a hash:
|
5348
|
-
#
|
5349
|
-
# {
|
5350
|
-
# item_exploration_config: {
|
5351
|
-
# "ParameterName" => "ParameterValue",
|
5352
|
-
# },
|
5353
|
-
# min_recommendation_requests_per_second: 1,
|
5354
|
-
# }
|
5355
|
-
#
|
5356
4487
|
# @!attribute [rw] item_exploration_config
|
5357
4488
|
# Specifies the exploration configuration hyperparameters, including
|
5358
4489
|
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
@@ -5364,14 +4495,24 @@ module Aws::Personalize
|
|
5364
4495
|
#
|
5365
4496
|
# @!attribute [rw] min_recommendation_requests_per_second
|
5366
4497
|
# Specifies the requested minimum provisioned recommendation requests
|
5367
|
-
# per second that Amazon Personalize will support.
|
4498
|
+
# per second that Amazon Personalize will support. A high
|
4499
|
+
# `minRecommendationRequestsPerSecond` will increase your bill. We
|
4500
|
+
# recommend starting with 1 for `minRecommendationRequestsPerSecond`
|
4501
|
+
# (the default). Track your usage using Amazon CloudWatch metrics, and
|
4502
|
+
# increase the `minRecommendationRequestsPerSecond` as necessary.
|
5368
4503
|
# @return [Integer]
|
5369
4504
|
#
|
4505
|
+
# @!attribute [rw] training_data_config
|
4506
|
+
# Specifies the training data configuration to use when creating a
|
4507
|
+
# domain recommender.
|
4508
|
+
# @return [Types::TrainingDataConfig]
|
4509
|
+
#
|
5370
4510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
|
5371
4511
|
#
|
5372
4512
|
class RecommenderConfig < Struct.new(
|
5373
4513
|
:item_exploration_config,
|
5374
|
-
:min_recommendation_requests_per_second
|
4514
|
+
:min_recommendation_requests_per_second,
|
4515
|
+
:training_data_config)
|
5375
4516
|
SENSITIVE = []
|
5376
4517
|
include Aws::Structure
|
5377
4518
|
end
|
@@ -5529,14 +4670,6 @@ module Aws::Personalize
|
|
5529
4670
|
|
5530
4671
|
# The configuration details of an Amazon S3 input or output bucket.
|
5531
4672
|
#
|
5532
|
-
# @note When making an API call, you may pass S3DataConfig
|
5533
|
-
# data as a hash:
|
5534
|
-
#
|
5535
|
-
# {
|
5536
|
-
# path: "S3Location", # required
|
5537
|
-
# kms_key_arn: "KmsKeyArn",
|
5538
|
-
# }
|
5539
|
-
#
|
5540
4673
|
# @!attribute [rw] path
|
5541
4674
|
# The file path of the Amazon S3 bucket.
|
5542
4675
|
# @return [String]
|
@@ -5573,10 +4706,18 @@ module Aws::Personalize
|
|
5573
4706
|
# @return [Boolean]
|
5574
4707
|
#
|
5575
4708
|
# @!attribute [rw] perform_auto_ml
|
4709
|
+
# We don't recommend enabling automated machine learning. Instead,
|
4710
|
+
# match your use case to the available Amazon Personalize recipes. For
|
4711
|
+
# more information, see [Determining your use case.][1]
|
4712
|
+
#
|
5576
4713
|
# When true, Amazon Personalize performs a search for the best
|
5577
4714
|
# USER\_PERSONALIZATION recipe from the list specified in the solution
|
5578
4715
|
# configuration (`recipeArn` must not be specified). When false (the
|
5579
4716
|
# default), Amazon Personalize uses `recipeArn` for training.
|
4717
|
+
#
|
4718
|
+
#
|
4719
|
+
#
|
4720
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html
|
5580
4721
|
# @return [Boolean]
|
5581
4722
|
#
|
5582
4723
|
# @!attribute [rw] recipe_arn
|
@@ -5649,60 +4790,6 @@ module Aws::Personalize
|
|
5649
4790
|
|
5650
4791
|
# Describes the configuration properties for the solution.
|
5651
4792
|
#
|
5652
|
-
# @note When making an API call, you may pass SolutionConfig
|
5653
|
-
# data as a hash:
|
5654
|
-
#
|
5655
|
-
# {
|
5656
|
-
# event_value_threshold: "EventValueThreshold",
|
5657
|
-
# hpo_config: {
|
5658
|
-
# hpo_objective: {
|
5659
|
-
# type: "HPOObjectiveType",
|
5660
|
-
# metric_name: "MetricName",
|
5661
|
-
# metric_regex: "MetricRegex",
|
5662
|
-
# },
|
5663
|
-
# hpo_resource_config: {
|
5664
|
-
# max_number_of_training_jobs: "HPOResource",
|
5665
|
-
# max_parallel_training_jobs: "HPOResource",
|
5666
|
-
# },
|
5667
|
-
# algorithm_hyper_parameter_ranges: {
|
5668
|
-
# integer_hyper_parameter_ranges: [
|
5669
|
-
# {
|
5670
|
-
# name: "ParameterName",
|
5671
|
-
# min_value: 1,
|
5672
|
-
# max_value: 1,
|
5673
|
-
# },
|
5674
|
-
# ],
|
5675
|
-
# continuous_hyper_parameter_ranges: [
|
5676
|
-
# {
|
5677
|
-
# name: "ParameterName",
|
5678
|
-
# min_value: 1.0,
|
5679
|
-
# max_value: 1.0,
|
5680
|
-
# },
|
5681
|
-
# ],
|
5682
|
-
# categorical_hyper_parameter_ranges: [
|
5683
|
-
# {
|
5684
|
-
# name: "ParameterName",
|
5685
|
-
# values: ["CategoricalValue"],
|
5686
|
-
# },
|
5687
|
-
# ],
|
5688
|
-
# },
|
5689
|
-
# },
|
5690
|
-
# algorithm_hyper_parameters: {
|
5691
|
-
# "ParameterName" => "ParameterValue",
|
5692
|
-
# },
|
5693
|
-
# feature_transformation_parameters: {
|
5694
|
-
# "ParameterName" => "ParameterValue",
|
5695
|
-
# },
|
5696
|
-
# auto_ml_config: {
|
5697
|
-
# metric_name: "MetricName",
|
5698
|
-
# recipe_list: ["Arn"],
|
5699
|
-
# },
|
5700
|
-
# optimization_objective: {
|
5701
|
-
# item_attribute: "ItemAttribute",
|
5702
|
-
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
5703
|
-
# },
|
5704
|
-
# }
|
5705
|
-
#
|
5706
4793
|
# @!attribute [rw] event_value_threshold
|
5707
4794
|
# Only events with a value greater than or equal to this threshold are
|
5708
4795
|
# used for training a model.
|
@@ -5739,6 +4826,11 @@ module Aws::Personalize
|
|
5739
4826
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html
|
5740
4827
|
# @return [Types::OptimizationObjective]
|
5741
4828
|
#
|
4829
|
+
# @!attribute [rw] training_data_config
|
4830
|
+
# Specifies the training data configuration to use when creating a
|
4831
|
+
# custom solution version (trained model).
|
4832
|
+
# @return [Types::TrainingDataConfig]
|
4833
|
+
#
|
5742
4834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionConfig AWS API Documentation
|
5743
4835
|
#
|
5744
4836
|
class SolutionConfig < Struct.new(
|
@@ -5747,7 +4839,8 @@ module Aws::Personalize
|
|
5747
4839
|
:algorithm_hyper_parameters,
|
5748
4840
|
:feature_transformation_parameters,
|
5749
4841
|
:auto_ml_config,
|
5750
|
-
:optimization_objective
|
4842
|
+
:optimization_objective,
|
4843
|
+
:training_data_config)
|
5751
4844
|
SENSITIVE = []
|
5752
4845
|
include Aws::Structure
|
5753
4846
|
end
|
@@ -5984,13 +5077,6 @@ module Aws::Personalize
|
|
5984
5077
|
include Aws::Structure
|
5985
5078
|
end
|
5986
5079
|
|
5987
|
-
# @note When making an API call, you may pass StartRecommenderRequest
|
5988
|
-
# data as a hash:
|
5989
|
-
#
|
5990
|
-
# {
|
5991
|
-
# recommender_arn: "Arn", # required
|
5992
|
-
# }
|
5993
|
-
#
|
5994
5080
|
# @!attribute [rw] recommender_arn
|
5995
5081
|
# The Amazon Resource Name (ARN) of the recommender to start.
|
5996
5082
|
# @return [String]
|
@@ -6015,13 +5101,6 @@ module Aws::Personalize
|
|
6015
5101
|
include Aws::Structure
|
6016
5102
|
end
|
6017
5103
|
|
6018
|
-
# @note When making an API call, you may pass StopRecommenderRequest
|
6019
|
-
# data as a hash:
|
6020
|
-
#
|
6021
|
-
# {
|
6022
|
-
# recommender_arn: "Arn", # required
|
6023
|
-
# }
|
6024
|
-
#
|
6025
5104
|
# @!attribute [rw] recommender_arn
|
6026
5105
|
# The Amazon Resource Name (ARN) of the recommender to stop.
|
6027
5106
|
# @return [String]
|
@@ -6046,13 +5125,6 @@ module Aws::Personalize
|
|
6046
5125
|
include Aws::Structure
|
6047
5126
|
end
|
6048
5127
|
|
6049
|
-
# @note When making an API call, you may pass StopSolutionVersionCreationRequest
|
6050
|
-
# data as a hash:
|
6051
|
-
#
|
6052
|
-
# {
|
6053
|
-
# solution_version_arn: "Arn", # required
|
6054
|
-
# }
|
6055
|
-
#
|
6056
5128
|
# @!attribute [rw] solution_version_arn
|
6057
5129
|
# The Amazon Resource Name (ARN) of the solution version you want to
|
6058
5130
|
# stop creating.
|
@@ -6069,19 +5141,11 @@ module Aws::Personalize
|
|
6069
5141
|
# The optional metadata that you apply to resources to help you
|
6070
5142
|
# categorize and organize them. Each tag consists of a key and an
|
6071
5143
|
# optional value, both of which you define. For more information see
|
6072
|
-
# [Tagging Personalize
|
5144
|
+
# [Tagging Amazon Personalize recources][1].
|
6073
5145
|
#
|
6074
5146
|
#
|
6075
5147
|
#
|
6076
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
6077
|
-
#
|
6078
|
-
# @note When making an API call, you may pass Tag
|
6079
|
-
# data as a hash:
|
6080
|
-
#
|
6081
|
-
# {
|
6082
|
-
# tag_key: "TagKey", # required
|
6083
|
-
# tag_value: "TagValue", # required
|
6084
|
-
# }
|
5148
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
6085
5149
|
#
|
6086
5150
|
# @!attribute [rw] tag_key
|
6087
5151
|
# One part of a key-value pair that makes up a tag. A key is a general
|
@@ -6102,30 +5166,17 @@ module Aws::Personalize
|
|
6102
5166
|
include Aws::Structure
|
6103
5167
|
end
|
6104
5168
|
|
6105
|
-
# @note When making an API call, you may pass TagResourceRequest
|
6106
|
-
# data as a hash:
|
6107
|
-
#
|
6108
|
-
# {
|
6109
|
-
# resource_arn: "Arn", # required
|
6110
|
-
# tags: [ # required
|
6111
|
-
# {
|
6112
|
-
# tag_key: "TagKey", # required
|
6113
|
-
# tag_value: "TagValue", # required
|
6114
|
-
# },
|
6115
|
-
# ],
|
6116
|
-
# }
|
6117
|
-
#
|
6118
5169
|
# @!attribute [rw] resource_arn
|
6119
5170
|
# The resource's Amazon Resource Name (ARN).
|
6120
5171
|
# @return [String]
|
6121
5172
|
#
|
6122
5173
|
# @!attribute [rw] tags
|
6123
5174
|
# Tags to apply to the resource. For more information see [Tagging
|
6124
|
-
# Personalize
|
5175
|
+
# Amazon Personalize recources][1].
|
6125
5176
|
#
|
6126
5177
|
#
|
6127
5178
|
#
|
6128
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/
|
5179
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
6129
5180
|
# @return [Array<Types::Tag>]
|
6130
5181
|
#
|
6131
5182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResourceRequest AWS API Documentation
|
@@ -6169,6 +5220,27 @@ module Aws::Personalize
|
|
6169
5220
|
include Aws::Structure
|
6170
5221
|
end
|
6171
5222
|
|
5223
|
+
# The training data configuration to use when creating a domain
|
5224
|
+
# recommender or custom solution version (trained model).
|
5225
|
+
#
|
5226
|
+
# @!attribute [rw] excluded_dataset_columns
|
5227
|
+
# Specifies the columns to exclude from training. Each key is a
|
5228
|
+
# dataset type, and each value is a list of columns. Exclude columns
|
5229
|
+
# to control what data Amazon Personalize uses to generate
|
5230
|
+
# recommendations. For example, you might have a column that you want
|
5231
|
+
# to use only to filter recommendations. You can exclude this column
|
5232
|
+
# from training and Amazon Personalize considers it only when
|
5233
|
+
# filtering.
|
5234
|
+
# @return [Hash<String,Array<String>>]
|
5235
|
+
#
|
5236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TrainingDataConfig AWS API Documentation
|
5237
|
+
#
|
5238
|
+
class TrainingDataConfig < Struct.new(
|
5239
|
+
:excluded_dataset_columns)
|
5240
|
+
SENSITIVE = []
|
5241
|
+
include Aws::Structure
|
5242
|
+
end
|
5243
|
+
|
6172
5244
|
# If hyperparameter optimization (HPO) was performed, contains the
|
6173
5245
|
# hyperparameter values of the best performing model.
|
6174
5246
|
#
|
@@ -6184,14 +5256,6 @@ module Aws::Personalize
|
|
6184
5256
|
include Aws::Structure
|
6185
5257
|
end
|
6186
5258
|
|
6187
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
6188
|
-
# data as a hash:
|
6189
|
-
#
|
6190
|
-
# {
|
6191
|
-
# resource_arn: "Arn", # required
|
6192
|
-
# tag_keys: ["TagKey"], # required
|
6193
|
-
# }
|
6194
|
-
#
|
6195
5259
|
# @!attribute [rw] resource_arn
|
6196
5260
|
# The resource's Amazon Resource Name (ARN).
|
6197
5261
|
# @return [String]
|
@@ -6213,20 +5277,6 @@ module Aws::Personalize
|
|
6213
5277
|
#
|
6214
5278
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
6215
5279
|
|
6216
|
-
# @note When making an API call, you may pass UpdateCampaignRequest
|
6217
|
-
# data as a hash:
|
6218
|
-
#
|
6219
|
-
# {
|
6220
|
-
# campaign_arn: "Arn", # required
|
6221
|
-
# solution_version_arn: "Arn",
|
6222
|
-
# min_provisioned_tps: 1,
|
6223
|
-
# campaign_config: {
|
6224
|
-
# item_exploration_config: {
|
6225
|
-
# "ParameterName" => "ParameterValue",
|
6226
|
-
# },
|
6227
|
-
# },
|
6228
|
-
# }
|
6229
|
-
#
|
6230
5280
|
# @!attribute [rw] campaign_arn
|
6231
5281
|
# The Amazon Resource Name (ARN) of the campaign.
|
6232
5282
|
# @return [String]
|
@@ -6237,7 +5287,11 @@ module Aws::Personalize
|
|
6237
5287
|
#
|
6238
5288
|
# @!attribute [rw] min_provisioned_tps
|
6239
5289
|
# Specifies the requested minimum provisioned transactions
|
6240
|
-
# (recommendations) per second that Amazon Personalize will support.
|
5290
|
+
# (recommendations) per second that Amazon Personalize will support. A
|
5291
|
+
# high `minProvisionedTPS` will increase your bill. We recommend
|
5292
|
+
# starting with 1 for `minProvisionedTPS` (the default). Track your
|
5293
|
+
# usage using Amazon CloudWatch metrics, and increase the
|
5294
|
+
# `minProvisionedTPS` as necessary.
|
6241
5295
|
# @return [Integer]
|
6242
5296
|
#
|
6243
5297
|
# @!attribute [rw] campaign_config
|
@@ -6267,28 +5321,6 @@ module Aws::Personalize
|
|
6267
5321
|
include Aws::Structure
|
6268
5322
|
end
|
6269
5323
|
|
6270
|
-
# @note When making an API call, you may pass UpdateMetricAttributionRequest
|
6271
|
-
# data as a hash:
|
6272
|
-
#
|
6273
|
-
# {
|
6274
|
-
# add_metrics: [
|
6275
|
-
# {
|
6276
|
-
# event_type: "EventType", # required
|
6277
|
-
# metric_name: "MetricName", # required
|
6278
|
-
# expression: "MetricExpression", # required
|
6279
|
-
# },
|
6280
|
-
# ],
|
6281
|
-
# remove_metrics: ["MetricName"],
|
6282
|
-
# metrics_output_config: {
|
6283
|
-
# s3_data_destination: {
|
6284
|
-
# path: "S3Location", # required
|
6285
|
-
# kms_key_arn: "KmsKeyArn",
|
6286
|
-
# },
|
6287
|
-
# role_arn: "RoleArn", # required
|
6288
|
-
# },
|
6289
|
-
# metric_attribution_arn: "Arn",
|
6290
|
-
# }
|
6291
|
-
#
|
6292
5324
|
# @!attribute [rw] add_metrics
|
6293
5325
|
# Add new metric attributes to the metric attribution.
|
6294
5326
|
# @return [Array<Types::MetricAttribute>]
|
@@ -6329,19 +5361,6 @@ module Aws::Personalize
|
|
6329
5361
|
include Aws::Structure
|
6330
5362
|
end
|
6331
5363
|
|
6332
|
-
# @note When making an API call, you may pass UpdateRecommenderRequest
|
6333
|
-
# data as a hash:
|
6334
|
-
#
|
6335
|
-
# {
|
6336
|
-
# recommender_arn: "Arn", # required
|
6337
|
-
# recommender_config: { # required
|
6338
|
-
# item_exploration_config: {
|
6339
|
-
# "ParameterName" => "ParameterValue",
|
6340
|
-
# },
|
6341
|
-
# min_recommendation_requests_per_second: 1,
|
6342
|
-
# },
|
6343
|
-
# }
|
6344
|
-
#
|
6345
5364
|
# @!attribute [rw] recommender_arn
|
6346
5365
|
# The Amazon Resource Name (ARN) of the recommender to modify.
|
6347
5366
|
# @return [String]
|