aws-sdk-personalize 1.32.0 → 1.36.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +501 -15
- data/lib/aws-sdk-personalize/client_api.rb +261 -0
- data/lib/aws-sdk-personalize/types.rb +855 -32
- data/lib/aws-sdk-personalize.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Personalize
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Personalize
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Personalize
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -285,6 +293,15 @@ module Aws::Personalize
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
294
|
# requests are made, and retries are disabled.
|
287
295
|
#
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
298
|
+
# will be used if available.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
303
|
+
# is set to `true`.
|
304
|
+
#
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
289
306
|
# When `true`, request parameters are validated before
|
290
307
|
# sending the request.
|
@@ -296,7 +313,7 @@ module Aws::Personalize
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
297
314
|
# `Timeout::Error`.
|
298
315
|
#
|
299
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
317
|
# number of seconds to wait for response data. This value can
|
301
318
|
# safely be set per-request on the session.
|
302
319
|
#
|
@@ -312,6 +329,9 @@ module Aws::Personalize
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
313
330
|
# request on the session.
|
314
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
317
337
|
#
|
@@ -420,7 +440,78 @@ module Aws::Personalize
|
|
420
440
|
req.send_request(options)
|
421
441
|
end
|
422
442
|
|
423
|
-
# Creates a
|
443
|
+
# Creates a batch segment job. The operation can handle up to 50 million
|
444
|
+
# records and the input file must be in JSON format. For more
|
445
|
+
# information, see recommendations-batch.
|
446
|
+
#
|
447
|
+
# @option params [required, String] :job_name
|
448
|
+
# The name of the batch segment job to create.
|
449
|
+
#
|
450
|
+
# @option params [required, String] :solution_version_arn
|
451
|
+
# The Amazon Resource Name (ARN) of the solution version you want the
|
452
|
+
# batch segment job to use to generate batch segments.
|
453
|
+
#
|
454
|
+
# @option params [String] :filter_arn
|
455
|
+
# The ARN of the filter to apply to the batch segment job. For more
|
456
|
+
# information on using filters, see filter-batch.
|
457
|
+
#
|
458
|
+
# @option params [Integer] :num_results
|
459
|
+
# The number of predicted users generated by the batch segment job for
|
460
|
+
# each line of input data.
|
461
|
+
#
|
462
|
+
# @option params [required, Types::BatchSegmentJobInput] :job_input
|
463
|
+
# The Amazon S3 path for the input data used to generate the batch
|
464
|
+
# segment job.
|
465
|
+
#
|
466
|
+
# @option params [required, Types::BatchSegmentJobOutput] :job_output
|
467
|
+
# The Amazon S3 path for the bucket where the job's output will be
|
468
|
+
# stored.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :role_arn
|
471
|
+
# The ARN of the Amazon Identity and Access Management role that has
|
472
|
+
# permissions to read and write to your input and output Amazon S3
|
473
|
+
# buckets respectively.
|
474
|
+
#
|
475
|
+
# @return [Types::CreateBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
476
|
+
#
|
477
|
+
# * {Types::CreateBatchSegmentJobResponse#batch_segment_job_arn #batch_segment_job_arn} => String
|
478
|
+
#
|
479
|
+
# @example Request syntax with placeholder values
|
480
|
+
#
|
481
|
+
# resp = client.create_batch_segment_job({
|
482
|
+
# job_name: "Name", # required
|
483
|
+
# solution_version_arn: "Arn", # required
|
484
|
+
# filter_arn: "Arn",
|
485
|
+
# num_results: 1,
|
486
|
+
# job_input: { # required
|
487
|
+
# s3_data_source: { # required
|
488
|
+
# path: "S3Location", # required
|
489
|
+
# kms_key_arn: "KmsKeyArn",
|
490
|
+
# },
|
491
|
+
# },
|
492
|
+
# job_output: { # required
|
493
|
+
# s3_data_destination: { # required
|
494
|
+
# path: "S3Location", # required
|
495
|
+
# kms_key_arn: "KmsKeyArn",
|
496
|
+
# },
|
497
|
+
# },
|
498
|
+
# role_arn: "RoleArn", # required
|
499
|
+
# })
|
500
|
+
#
|
501
|
+
# @example Response structure
|
502
|
+
#
|
503
|
+
# resp.batch_segment_job_arn #=> String
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJob AWS API Documentation
|
506
|
+
#
|
507
|
+
# @overload create_batch_segment_job(params = {})
|
508
|
+
# @param [Hash] params ({})
|
509
|
+
def create_batch_segment_job(params = {}, options = {})
|
510
|
+
req = build_request(:create_batch_segment_job, params)
|
511
|
+
req.send_request(options)
|
512
|
+
end
|
513
|
+
|
514
|
+
# Creates a campaign that deploys a solution version. When a client
|
424
515
|
# calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
|
425
516
|
# APIs, a campaign is specified in the request.
|
426
517
|
#
|
@@ -680,9 +771,9 @@ module Aws::Personalize
|
|
680
771
|
req.send_request(options)
|
681
772
|
end
|
682
773
|
|
683
|
-
# Creates an empty dataset group. A dataset group
|
684
|
-
#
|
685
|
-
#
|
774
|
+
# Creates an empty dataset group. A dataset group is a container for
|
775
|
+
# Amazon Personalize resources. A dataset group can contain at most
|
776
|
+
# three datasets, one for each type of dataset:
|
686
777
|
#
|
687
778
|
# * Interactions
|
688
779
|
#
|
@@ -690,9 +781,13 @@ module Aws::Personalize
|
|
690
781
|
#
|
691
782
|
# * Users
|
692
783
|
#
|
693
|
-
#
|
694
|
-
#
|
695
|
-
# dataset
|
784
|
+
# A dataset group can be a Domain dataset group, where you specify a
|
785
|
+
# domain and use pre-configured resources like recommenders, or a Custom
|
786
|
+
# dataset group, where you use custom resources, such as a solution with
|
787
|
+
# a solution version, that you deploy with a campaign. If you start with
|
788
|
+
# a Domain dataset group, you can still add custom resources such as
|
789
|
+
# solutions and solution versions trained with recipes for custom use
|
790
|
+
# cases and deployed with campaigns.
|
696
791
|
#
|
697
792
|
# A dataset group can be in one of the following states:
|
698
793
|
#
|
@@ -743,9 +838,17 @@ module Aws::Personalize
|
|
743
838
|
# The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
|
744
839
|
# used to encrypt the datasets.
|
745
840
|
#
|
841
|
+
# @option params [String] :domain
|
842
|
+
# The domain of the dataset group. Specify a domain to create a Domain
|
843
|
+
# dataset group. The domain you specify determines the default schemas
|
844
|
+
# for datasets and the use cases available for recommenders. If you
|
845
|
+
# don't specify a domain, you create a Custom dataset group with
|
846
|
+
# solution versions that you deploy with a campaign.
|
847
|
+
#
|
746
848
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
747
849
|
#
|
748
850
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
851
|
+
# * {Types::CreateDatasetGroupResponse#domain #domain} => String
|
749
852
|
#
|
750
853
|
# @example Request syntax with placeholder values
|
751
854
|
#
|
@@ -753,11 +856,13 @@ module Aws::Personalize
|
|
753
856
|
# name: "Name", # required
|
754
857
|
# role_arn: "RoleArn",
|
755
858
|
# kms_key_arn: "KmsKeyArn",
|
859
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
756
860
|
# })
|
757
861
|
#
|
758
862
|
# @example Response structure
|
759
863
|
#
|
760
864
|
# resp.dataset_group_arn #=> String
|
865
|
+
# resp.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
761
866
|
#
|
762
867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup AWS API Documentation
|
763
868
|
#
|
@@ -964,12 +1069,100 @@ module Aws::Personalize
|
|
964
1069
|
req.send_request(options)
|
965
1070
|
end
|
966
1071
|
|
1072
|
+
# Creates a recommender with the recipe (a Domain dataset group use
|
1073
|
+
# case) you specify. You create recommenders for a Domain dataset group
|
1074
|
+
# and specify the recommender's Amazon Resource Name (ARN) when you
|
1075
|
+
# make a [GetRecommendations][1] request.
|
1076
|
+
#
|
1077
|
+
# **Status**
|
1078
|
+
#
|
1079
|
+
# A recommender can be in one of the following states:
|
1080
|
+
#
|
1081
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
1082
|
+
# FAILED
|
1083
|
+
#
|
1084
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
1085
|
+
#
|
1086
|
+
# To get the recommender status, call DescribeRecommender.
|
1087
|
+
#
|
1088
|
+
# <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
|
1089
|
+
# the recommender for recommendations.
|
1090
|
+
#
|
1091
|
+
# </note>
|
1092
|
+
#
|
1093
|
+
# **Related APIs**
|
1094
|
+
#
|
1095
|
+
# * ListRecommenders
|
1096
|
+
#
|
1097
|
+
# * DescribeRecommender
|
1098
|
+
#
|
1099
|
+
# * UpdateRecommender
|
1100
|
+
#
|
1101
|
+
# * DeleteRecommender
|
1102
|
+
#
|
1103
|
+
#
|
1104
|
+
#
|
1105
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
1106
|
+
#
|
1107
|
+
# @option params [required, String] :name
|
1108
|
+
# The name of the recommender.
|
1109
|
+
#
|
1110
|
+
# @option params [required, String] :dataset_group_arn
|
1111
|
+
# The Amazon Resource Name (ARN) of the destination domain dataset group
|
1112
|
+
# for the recommender.
|
1113
|
+
#
|
1114
|
+
# @option params [required, String] :recipe_arn
|
1115
|
+
# The Amazon Resource Name (ARN) of the recipe that the recommender will
|
1116
|
+
# use. For a recommender, a recipe is a Domain dataset group use case.
|
1117
|
+
# Only Domain dataset group use cases can be used to create a
|
1118
|
+
# recommender. For information about use cases see [Choosing recommender
|
1119
|
+
# use cases][1].
|
1120
|
+
#
|
1121
|
+
#
|
1122
|
+
#
|
1123
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
|
1124
|
+
#
|
1125
|
+
# @option params [Types::RecommenderConfig] :recommender_config
|
1126
|
+
# The configuration details of the recommender.
|
1127
|
+
#
|
1128
|
+
# @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1129
|
+
#
|
1130
|
+
# * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
|
1131
|
+
#
|
1132
|
+
# @example Request syntax with placeholder values
|
1133
|
+
#
|
1134
|
+
# resp = client.create_recommender({
|
1135
|
+
# name: "Name", # required
|
1136
|
+
# dataset_group_arn: "Arn", # required
|
1137
|
+
# recipe_arn: "Arn", # required
|
1138
|
+
# recommender_config: {
|
1139
|
+
# item_exploration_config: {
|
1140
|
+
# "ParameterName" => "ParameterValue",
|
1141
|
+
# },
|
1142
|
+
# },
|
1143
|
+
# })
|
1144
|
+
#
|
1145
|
+
# @example Response structure
|
1146
|
+
#
|
1147
|
+
# resp.recommender_arn #=> String
|
1148
|
+
#
|
1149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommender AWS API Documentation
|
1150
|
+
#
|
1151
|
+
# @overload create_recommender(params = {})
|
1152
|
+
# @param [Hash] params ({})
|
1153
|
+
def create_recommender(params = {}, options = {})
|
1154
|
+
req = build_request(:create_recommender, params)
|
1155
|
+
req.send_request(options)
|
1156
|
+
end
|
1157
|
+
|
967
1158
|
# Creates an Amazon Personalize schema from the specified schema string.
|
968
1159
|
# The schema you create must be in Avro JSON format.
|
969
1160
|
#
|
970
1161
|
# Amazon Personalize recognizes three schema variants. Each schema is
|
971
1162
|
# associated with a dataset type and has a set of required field and
|
972
|
-
# keywords.
|
1163
|
+
# keywords. If you are creating a schema for a dataset in a Domain
|
1164
|
+
# dataset group, you provide the domain of the Domain dataset group. You
|
1165
|
+
# specify a schema when you call CreateDataset.
|
973
1166
|
#
|
974
1167
|
# **Related APIs**
|
975
1168
|
#
|
@@ -985,6 +1178,11 @@ module Aws::Personalize
|
|
985
1178
|
# @option params [required, String] :schema
|
986
1179
|
# A schema in Avro JSON format.
|
987
1180
|
#
|
1181
|
+
# @option params [String] :domain
|
1182
|
+
# The domain for the schema. If you are creating a schema for a dataset
|
1183
|
+
# in a Domain dataset group, specify the domain you chose when you
|
1184
|
+
# created the Domain dataset group.
|
1185
|
+
#
|
988
1186
|
# @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
989
1187
|
#
|
990
1188
|
# * {Types::CreateSchemaResponse#schema_arn #schema_arn} => String
|
@@ -994,6 +1192,7 @@ module Aws::Personalize
|
|
994
1192
|
# resp = client.create_schema({
|
995
1193
|
# name: "Name", # required
|
996
1194
|
# schema: "AvroSchema", # required
|
1195
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
997
1196
|
# })
|
998
1197
|
#
|
999
1198
|
# @example Response structure
|
@@ -1189,10 +1388,10 @@ module Aws::Personalize
|
|
1189
1388
|
req.send_request(options)
|
1190
1389
|
end
|
1191
1390
|
|
1192
|
-
# Trains or retrains an active solution
|
1193
|
-
# CreateSolution operation and must be in
|
1194
|
-
# calling `CreateSolutionVersion`. A new version
|
1195
|
-
# created every time you call this operation.
|
1391
|
+
# Trains or retrains an active solution in a Custom dataset group. A
|
1392
|
+
# solution is created using the CreateSolution operation and must be in
|
1393
|
+
# the ACTIVE state before calling `CreateSolutionVersion`. A new version
|
1394
|
+
# of the solution is created every time you call this operation.
|
1196
1395
|
#
|
1197
1396
|
# **Status**
|
1198
1397
|
#
|
@@ -1406,6 +1605,33 @@ module Aws::Personalize
|
|
1406
1605
|
req.send_request(options)
|
1407
1606
|
end
|
1408
1607
|
|
1608
|
+
# Deactivates and removes a recommender. A deleted recommender can no
|
1609
|
+
# longer be specified in a [GetRecommendations][1] request.
|
1610
|
+
#
|
1611
|
+
#
|
1612
|
+
#
|
1613
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
1614
|
+
#
|
1615
|
+
# @option params [required, String] :recommender_arn
|
1616
|
+
# The Amazon Resource Name (ARN) of the recommender to delete.
|
1617
|
+
#
|
1618
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1619
|
+
#
|
1620
|
+
# @example Request syntax with placeholder values
|
1621
|
+
#
|
1622
|
+
# resp = client.delete_recommender({
|
1623
|
+
# recommender_arn: "Arn", # required
|
1624
|
+
# })
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommender AWS API Documentation
|
1627
|
+
#
|
1628
|
+
# @overload delete_recommender(params = {})
|
1629
|
+
# @param [Hash] params ({})
|
1630
|
+
def delete_recommender(params = {}, options = {})
|
1631
|
+
req = build_request(:delete_recommender, params)
|
1632
|
+
req.send_request(options)
|
1633
|
+
end
|
1634
|
+
|
1409
1635
|
# Deletes a schema. Before deleting a schema, you must delete all
|
1410
1636
|
# datasets referencing the schema. For more information on schemas, see
|
1411
1637
|
# CreateSchema.
|
@@ -1557,6 +1783,49 @@ module Aws::Personalize
|
|
1557
1783
|
req.send_request(options)
|
1558
1784
|
end
|
1559
1785
|
|
1786
|
+
# Gets the properties of a batch segment job including name, Amazon
|
1787
|
+
# Resource Name (ARN), status, input and output configurations, and the
|
1788
|
+
# ARN of the solution version used to generate segments.
|
1789
|
+
#
|
1790
|
+
# @option params [required, String] :batch_segment_job_arn
|
1791
|
+
# The ARN of the batch segment job to describe.
|
1792
|
+
#
|
1793
|
+
# @return [Types::DescribeBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1794
|
+
#
|
1795
|
+
# * {Types::DescribeBatchSegmentJobResponse#batch_segment_job #batch_segment_job} => Types::BatchSegmentJob
|
1796
|
+
#
|
1797
|
+
# @example Request syntax with placeholder values
|
1798
|
+
#
|
1799
|
+
# resp = client.describe_batch_segment_job({
|
1800
|
+
# batch_segment_job_arn: "Arn", # required
|
1801
|
+
# })
|
1802
|
+
#
|
1803
|
+
# @example Response structure
|
1804
|
+
#
|
1805
|
+
# resp.batch_segment_job.job_name #=> String
|
1806
|
+
# resp.batch_segment_job.batch_segment_job_arn #=> String
|
1807
|
+
# resp.batch_segment_job.filter_arn #=> String
|
1808
|
+
# resp.batch_segment_job.failure_reason #=> String
|
1809
|
+
# resp.batch_segment_job.solution_version_arn #=> String
|
1810
|
+
# resp.batch_segment_job.num_results #=> Integer
|
1811
|
+
# resp.batch_segment_job.job_input.s3_data_source.path #=> String
|
1812
|
+
# resp.batch_segment_job.job_input.s3_data_source.kms_key_arn #=> String
|
1813
|
+
# resp.batch_segment_job.job_output.s3_data_destination.path #=> String
|
1814
|
+
# resp.batch_segment_job.job_output.s3_data_destination.kms_key_arn #=> String
|
1815
|
+
# resp.batch_segment_job.role_arn #=> String
|
1816
|
+
# resp.batch_segment_job.status #=> String
|
1817
|
+
# resp.batch_segment_job.creation_date_time #=> Time
|
1818
|
+
# resp.batch_segment_job.last_updated_date_time #=> Time
|
1819
|
+
#
|
1820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob AWS API Documentation
|
1821
|
+
#
|
1822
|
+
# @overload describe_batch_segment_job(params = {})
|
1823
|
+
# @param [Hash] params ({})
|
1824
|
+
def describe_batch_segment_job(params = {}, options = {})
|
1825
|
+
req = build_request(:describe_batch_segment_job, params)
|
1826
|
+
req.send_request(options)
|
1827
|
+
end
|
1828
|
+
|
1560
1829
|
# Describes the given campaign, including its status.
|
1561
1830
|
#
|
1562
1831
|
# A campaign can be in one of the following states:
|
@@ -1715,6 +1984,7 @@ module Aws::Personalize
|
|
1715
1984
|
# resp.dataset_group.creation_date_time #=> Time
|
1716
1985
|
# resp.dataset_group.last_updated_date_time #=> Time
|
1717
1986
|
# resp.dataset_group.failure_reason #=> String
|
1987
|
+
# resp.dataset_group.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
1718
1988
|
#
|
1719
1989
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup AWS API Documentation
|
1720
1990
|
#
|
@@ -1925,6 +2195,65 @@ module Aws::Personalize
|
|
1925
2195
|
req.send_request(options)
|
1926
2196
|
end
|
1927
2197
|
|
2198
|
+
# Describes the given recommender, including its status.
|
2199
|
+
#
|
2200
|
+
# A recommender can be in one of the following states:
|
2201
|
+
#
|
2202
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
2203
|
+
# FAILED
|
2204
|
+
#
|
2205
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
2206
|
+
#
|
2207
|
+
# When the `status` is `CREATE FAILED`, the response includes the
|
2208
|
+
# `failureReason` key, which describes why.
|
2209
|
+
#
|
2210
|
+
# For more information on recommenders, see [CreateRecommender][1].
|
2211
|
+
#
|
2212
|
+
#
|
2213
|
+
#
|
2214
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
|
2215
|
+
#
|
2216
|
+
# @option params [required, String] :recommender_arn
|
2217
|
+
# The Amazon Resource Name (ARN) of the recommender to describe.
|
2218
|
+
#
|
2219
|
+
# @return [Types::DescribeRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2220
|
+
#
|
2221
|
+
# * {Types::DescribeRecommenderResponse#recommender #recommender} => Types::Recommender
|
2222
|
+
#
|
2223
|
+
# @example Request syntax with placeholder values
|
2224
|
+
#
|
2225
|
+
# resp = client.describe_recommender({
|
2226
|
+
# recommender_arn: "Arn", # required
|
2227
|
+
# })
|
2228
|
+
#
|
2229
|
+
# @example Response structure
|
2230
|
+
#
|
2231
|
+
# resp.recommender.recommender_arn #=> String
|
2232
|
+
# resp.recommender.dataset_group_arn #=> String
|
2233
|
+
# resp.recommender.name #=> String
|
2234
|
+
# resp.recommender.recipe_arn #=> String
|
2235
|
+
# resp.recommender.recommender_config.item_exploration_config #=> Hash
|
2236
|
+
# resp.recommender.recommender_config.item_exploration_config["ParameterName"] #=> String
|
2237
|
+
# resp.recommender.creation_date_time #=> Time
|
2238
|
+
# resp.recommender.last_updated_date_time #=> Time
|
2239
|
+
# resp.recommender.status #=> String
|
2240
|
+
# resp.recommender.failure_reason #=> String
|
2241
|
+
# resp.recommender.latest_recommender_update.recommender_config.item_exploration_config #=> Hash
|
2242
|
+
# resp.recommender.latest_recommender_update.recommender_config.item_exploration_config["ParameterName"] #=> String
|
2243
|
+
# resp.recommender.latest_recommender_update.creation_date_time #=> Time
|
2244
|
+
# resp.recommender.latest_recommender_update.last_updated_date_time #=> Time
|
2245
|
+
# resp.recommender.latest_recommender_update.status #=> String
|
2246
|
+
# resp.recommender.latest_recommender_update.failure_reason #=> String
|
2247
|
+
#
|
2248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommender AWS API Documentation
|
2249
|
+
#
|
2250
|
+
# @overload describe_recommender(params = {})
|
2251
|
+
# @param [Hash] params ({})
|
2252
|
+
def describe_recommender(params = {}, options = {})
|
2253
|
+
req = build_request(:describe_recommender, params)
|
2254
|
+
req.send_request(options)
|
2255
|
+
end
|
2256
|
+
|
1928
2257
|
# Describes a schema. For more information on schemas, see CreateSchema.
|
1929
2258
|
#
|
1930
2259
|
# @option params [required, String] :schema_arn
|
@@ -1947,6 +2276,7 @@ module Aws::Personalize
|
|
1947
2276
|
# resp.schema.schema #=> String
|
1948
2277
|
# resp.schema.creation_date_time #=> Time
|
1949
2278
|
# resp.schema.last_updated_date_time #=> Time
|
2279
|
+
# resp.schema.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
1950
2280
|
#
|
1951
2281
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema AWS API Documentation
|
1952
2282
|
#
|
@@ -2180,6 +2510,56 @@ module Aws::Personalize
|
|
2180
2510
|
req.send_request(options)
|
2181
2511
|
end
|
2182
2512
|
|
2513
|
+
# Gets a list of the batch segment jobs that have been performed off of
|
2514
|
+
# a solution version that you specify.
|
2515
|
+
#
|
2516
|
+
# @option params [String] :solution_version_arn
|
2517
|
+
# The Amazon Resource Name (ARN) of the solution version that the batch
|
2518
|
+
# segment jobs used to generate batch segments.
|
2519
|
+
#
|
2520
|
+
# @option params [String] :next_token
|
2521
|
+
# The token to request the next page of results.
|
2522
|
+
#
|
2523
|
+
# @option params [Integer] :max_results
|
2524
|
+
# The maximum number of batch segment job results to return in each
|
2525
|
+
# page. The default value is 100.
|
2526
|
+
#
|
2527
|
+
# @return [Types::ListBatchSegmentJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2528
|
+
#
|
2529
|
+
# * {Types::ListBatchSegmentJobsResponse#batch_segment_jobs #batch_segment_jobs} => Array<Types::BatchSegmentJobSummary>
|
2530
|
+
# * {Types::ListBatchSegmentJobsResponse#next_token #next_token} => String
|
2531
|
+
#
|
2532
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2533
|
+
#
|
2534
|
+
# @example Request syntax with placeholder values
|
2535
|
+
#
|
2536
|
+
# resp = client.list_batch_segment_jobs({
|
2537
|
+
# solution_version_arn: "Arn",
|
2538
|
+
# next_token: "NextToken",
|
2539
|
+
# max_results: 1,
|
2540
|
+
# })
|
2541
|
+
#
|
2542
|
+
# @example Response structure
|
2543
|
+
#
|
2544
|
+
# resp.batch_segment_jobs #=> Array
|
2545
|
+
# resp.batch_segment_jobs[0].batch_segment_job_arn #=> String
|
2546
|
+
# resp.batch_segment_jobs[0].job_name #=> String
|
2547
|
+
# resp.batch_segment_jobs[0].status #=> String
|
2548
|
+
# resp.batch_segment_jobs[0].creation_date_time #=> Time
|
2549
|
+
# resp.batch_segment_jobs[0].last_updated_date_time #=> Time
|
2550
|
+
# resp.batch_segment_jobs[0].failure_reason #=> String
|
2551
|
+
# resp.batch_segment_jobs[0].solution_version_arn #=> String
|
2552
|
+
# resp.next_token #=> String
|
2553
|
+
#
|
2554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs AWS API Documentation
|
2555
|
+
#
|
2556
|
+
# @overload list_batch_segment_jobs(params = {})
|
2557
|
+
# @param [Hash] params ({})
|
2558
|
+
def list_batch_segment_jobs(params = {}, options = {})
|
2559
|
+
req = build_request(:list_batch_segment_jobs, params)
|
2560
|
+
req.send_request(options)
|
2561
|
+
end
|
2562
|
+
|
2183
2563
|
# Returns a list of campaigns that use the given solution. When a
|
2184
2564
|
# solution is not specified, all the campaigns associated with the
|
2185
2565
|
# account are listed. The response provides the properties for each
|
@@ -2320,6 +2700,7 @@ module Aws::Personalize
|
|
2320
2700
|
# resp.dataset_groups[0].creation_date_time #=> Time
|
2321
2701
|
# resp.dataset_groups[0].last_updated_date_time #=> Time
|
2322
2702
|
# resp.dataset_groups[0].failure_reason #=> String
|
2703
|
+
# resp.dataset_groups[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
2323
2704
|
# resp.next_token #=> String
|
2324
2705
|
#
|
2325
2706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups AWS API Documentation
|
@@ -2546,6 +2927,12 @@ module Aws::Personalize
|
|
2546
2927
|
# @option params [Integer] :max_results
|
2547
2928
|
# The maximum number of recipes to return.
|
2548
2929
|
#
|
2930
|
+
# @option params [String] :domain
|
2931
|
+
# Filters returned recipes by domain for a Domain dataset group. Only
|
2932
|
+
# recipes (Domain dataset group use cases) for this domain are included
|
2933
|
+
# in the response. If you don't specify a domain, only non-domain
|
2934
|
+
# recipes are returned.
|
2935
|
+
#
|
2549
2936
|
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2550
2937
|
#
|
2551
2938
|
# * {Types::ListRecipesResponse#recipes #recipes} => Array<Types::RecipeSummary>
|
@@ -2559,6 +2946,7 @@ module Aws::Personalize
|
|
2559
2946
|
# recipe_provider: "SERVICE", # accepts SERVICE
|
2560
2947
|
# next_token: "NextToken",
|
2561
2948
|
# max_results: 1,
|
2949
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
2562
2950
|
# })
|
2563
2951
|
#
|
2564
2952
|
# @example Response structure
|
@@ -2569,6 +2957,7 @@ module Aws::Personalize
|
|
2569
2957
|
# resp.recipes[0].status #=> String
|
2570
2958
|
# resp.recipes[0].creation_date_time #=> Time
|
2571
2959
|
# resp.recipes[0].last_updated_date_time #=> Time
|
2960
|
+
# resp.recipes[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
2572
2961
|
# resp.next_token #=> String
|
2573
2962
|
#
|
2574
2963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes AWS API Documentation
|
@@ -2580,6 +2969,66 @@ module Aws::Personalize
|
|
2580
2969
|
req.send_request(options)
|
2581
2970
|
end
|
2582
2971
|
|
2972
|
+
# Returns a list of recommenders in a given Domain dataset group. When a
|
2973
|
+
# Domain dataset group is not specified, all the recommenders associated
|
2974
|
+
# with the account are listed. The response provides the properties for
|
2975
|
+
# each recommender, including the Amazon Resource Name (ARN). For more
|
2976
|
+
# information on recommenders, see [CreateRecommender][1].
|
2977
|
+
#
|
2978
|
+
#
|
2979
|
+
#
|
2980
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
|
2981
|
+
#
|
2982
|
+
# @option params [String] :dataset_group_arn
|
2983
|
+
# The Amazon Resource Name (ARN) of the Domain dataset group to list the
|
2984
|
+
# recommenders for. When a Domain dataset group is not specified, all
|
2985
|
+
# the recommenders associated with the account are listed.
|
2986
|
+
#
|
2987
|
+
# @option params [String] :next_token
|
2988
|
+
# A token returned from the previous call to `ListRecommenders` for
|
2989
|
+
# getting the next set of recommenders (if they exist).
|
2990
|
+
#
|
2991
|
+
# @option params [Integer] :max_results
|
2992
|
+
# The maximum number of recommenders to return.
|
2993
|
+
#
|
2994
|
+
# @return [Types::ListRecommendersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2995
|
+
#
|
2996
|
+
# * {Types::ListRecommendersResponse#recommenders #recommenders} => Array<Types::RecommenderSummary>
|
2997
|
+
# * {Types::ListRecommendersResponse#next_token #next_token} => String
|
2998
|
+
#
|
2999
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3000
|
+
#
|
3001
|
+
# @example Request syntax with placeholder values
|
3002
|
+
#
|
3003
|
+
# resp = client.list_recommenders({
|
3004
|
+
# dataset_group_arn: "Arn",
|
3005
|
+
# next_token: "NextToken",
|
3006
|
+
# max_results: 1,
|
3007
|
+
# })
|
3008
|
+
#
|
3009
|
+
# @example Response structure
|
3010
|
+
#
|
3011
|
+
# resp.recommenders #=> Array
|
3012
|
+
# resp.recommenders[0].name #=> String
|
3013
|
+
# resp.recommenders[0].recommender_arn #=> String
|
3014
|
+
# resp.recommenders[0].dataset_group_arn #=> String
|
3015
|
+
# resp.recommenders[0].recipe_arn #=> String
|
3016
|
+
# resp.recommenders[0].recommender_config.item_exploration_config #=> Hash
|
3017
|
+
# resp.recommenders[0].recommender_config.item_exploration_config["ParameterName"] #=> String
|
3018
|
+
# resp.recommenders[0].status #=> String
|
3019
|
+
# resp.recommenders[0].creation_date_time #=> Time
|
3020
|
+
# resp.recommenders[0].last_updated_date_time #=> Time
|
3021
|
+
# resp.next_token #=> String
|
3022
|
+
#
|
3023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders AWS API Documentation
|
3024
|
+
#
|
3025
|
+
# @overload list_recommenders(params = {})
|
3026
|
+
# @param [Hash] params ({})
|
3027
|
+
def list_recommenders(params = {}, options = {})
|
3028
|
+
req = build_request(:list_recommenders, params)
|
3029
|
+
req.send_request(options)
|
3030
|
+
end
|
3031
|
+
|
2583
3032
|
# Returns the list of schemas associated with the account. The response
|
2584
3033
|
# provides the properties for each schema, including the Amazon Resource
|
2585
3034
|
# Name (ARN). For more information on schemas, see CreateSchema.
|
@@ -2612,6 +3061,7 @@ module Aws::Personalize
|
|
2612
3061
|
# resp.schemas[0].schema_arn #=> String
|
2613
3062
|
# resp.schemas[0].creation_date_time #=> Time
|
2614
3063
|
# resp.schemas[0].last_updated_date_time #=> Time
|
3064
|
+
# resp.schemas[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
2615
3065
|
# resp.next_token #=> String
|
2616
3066
|
#
|
2617
3067
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas AWS API Documentation
|
@@ -2816,6 +3266,42 @@ module Aws::Personalize
|
|
2816
3266
|
req.send_request(options)
|
2817
3267
|
end
|
2818
3268
|
|
3269
|
+
# Updates the recommender to modify the recommender configuration.
|
3270
|
+
#
|
3271
|
+
# @option params [required, String] :recommender_arn
|
3272
|
+
# The Amazon Resource Name (ARN) of the recommender to modify.
|
3273
|
+
#
|
3274
|
+
# @option params [required, Types::RecommenderConfig] :recommender_config
|
3275
|
+
# The configuration details of the recommender.
|
3276
|
+
#
|
3277
|
+
# @return [Types::UpdateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3278
|
+
#
|
3279
|
+
# * {Types::UpdateRecommenderResponse#recommender_arn #recommender_arn} => String
|
3280
|
+
#
|
3281
|
+
# @example Request syntax with placeholder values
|
3282
|
+
#
|
3283
|
+
# resp = client.update_recommender({
|
3284
|
+
# recommender_arn: "Arn", # required
|
3285
|
+
# recommender_config: { # required
|
3286
|
+
# item_exploration_config: {
|
3287
|
+
# "ParameterName" => "ParameterValue",
|
3288
|
+
# },
|
3289
|
+
# },
|
3290
|
+
# })
|
3291
|
+
#
|
3292
|
+
# @example Response structure
|
3293
|
+
#
|
3294
|
+
# resp.recommender_arn #=> String
|
3295
|
+
#
|
3296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommender AWS API Documentation
|
3297
|
+
#
|
3298
|
+
# @overload update_recommender(params = {})
|
3299
|
+
# @param [Hash] params ({})
|
3300
|
+
def update_recommender(params = {}, options = {})
|
3301
|
+
req = build_request(:update_recommender, params)
|
3302
|
+
req.send_request(options)
|
3303
|
+
end
|
3304
|
+
|
2819
3305
|
# @!endgroup
|
2820
3306
|
|
2821
3307
|
# @param params ({})
|
@@ -2829,7 +3315,7 @@ module Aws::Personalize
|
|
2829
3315
|
params: params,
|
2830
3316
|
config: config)
|
2831
3317
|
context[:gem_name] = 'aws-sdk-personalize'
|
2832
|
-
context[:gem_version] = '1.
|
3318
|
+
context[:gem_version] = '1.36.0'
|
2833
3319
|
Seahorse::Client::Request.new(handlers, context)
|
2834
3320
|
end
|
2835
3321
|
|