aws-sdk-personalize 1.31.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +491 -14
- 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
|
@@ -119,7 +119,9 @@ module Aws::Personalize
|
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
124
|
+
# to true.
|
|
123
125
|
#
|
|
124
126
|
# @option options [required, String] :region
|
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -285,6 +287,15 @@ module Aws::Personalize
|
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
286
288
|
# requests are made, and retries are disabled.
|
|
287
289
|
#
|
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
292
|
+
# will be used if available.
|
|
293
|
+
#
|
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
297
|
+
# is set to `true`.
|
|
298
|
+
#
|
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
|
289
300
|
# When `true`, request parameters are validated before
|
|
290
301
|
# sending the request.
|
|
@@ -420,7 +431,78 @@ module Aws::Personalize
|
|
|
420
431
|
req.send_request(options)
|
|
421
432
|
end
|
|
422
433
|
|
|
423
|
-
# Creates a
|
|
434
|
+
# Creates a batch segment job. The operation can handle up to 50 million
|
|
435
|
+
# records and the input file must be in JSON format. For more
|
|
436
|
+
# information, see recommendations-batch.
|
|
437
|
+
#
|
|
438
|
+
# @option params [required, String] :job_name
|
|
439
|
+
# The name of the batch segment job to create.
|
|
440
|
+
#
|
|
441
|
+
# @option params [required, String] :solution_version_arn
|
|
442
|
+
# The Amazon Resource Name (ARN) of the solution version you want the
|
|
443
|
+
# batch segment job to use to generate batch segments.
|
|
444
|
+
#
|
|
445
|
+
# @option params [String] :filter_arn
|
|
446
|
+
# The ARN of the filter to apply to the batch segment job. For more
|
|
447
|
+
# information on using filters, see filter-batch.
|
|
448
|
+
#
|
|
449
|
+
# @option params [Integer] :num_results
|
|
450
|
+
# The number of predicted users generated by the batch segment job for
|
|
451
|
+
# each line of input data.
|
|
452
|
+
#
|
|
453
|
+
# @option params [required, Types::BatchSegmentJobInput] :job_input
|
|
454
|
+
# The Amazon S3 path for the input data used to generate the batch
|
|
455
|
+
# segment job.
|
|
456
|
+
#
|
|
457
|
+
# @option params [required, Types::BatchSegmentJobOutput] :job_output
|
|
458
|
+
# The Amazon S3 path for the bucket where the job's output will be
|
|
459
|
+
# stored.
|
|
460
|
+
#
|
|
461
|
+
# @option params [required, String] :role_arn
|
|
462
|
+
# The ARN of the Amazon Identity and Access Management role that has
|
|
463
|
+
# permissions to read and write to your input and output Amazon S3
|
|
464
|
+
# buckets respectively.
|
|
465
|
+
#
|
|
466
|
+
# @return [Types::CreateBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
467
|
+
#
|
|
468
|
+
# * {Types::CreateBatchSegmentJobResponse#batch_segment_job_arn #batch_segment_job_arn} => String
|
|
469
|
+
#
|
|
470
|
+
# @example Request syntax with placeholder values
|
|
471
|
+
#
|
|
472
|
+
# resp = client.create_batch_segment_job({
|
|
473
|
+
# job_name: "Name", # required
|
|
474
|
+
# solution_version_arn: "Arn", # required
|
|
475
|
+
# filter_arn: "Arn",
|
|
476
|
+
# num_results: 1,
|
|
477
|
+
# job_input: { # required
|
|
478
|
+
# s3_data_source: { # required
|
|
479
|
+
# path: "S3Location", # required
|
|
480
|
+
# kms_key_arn: "KmsKeyArn",
|
|
481
|
+
# },
|
|
482
|
+
# },
|
|
483
|
+
# job_output: { # required
|
|
484
|
+
# s3_data_destination: { # required
|
|
485
|
+
# path: "S3Location", # required
|
|
486
|
+
# kms_key_arn: "KmsKeyArn",
|
|
487
|
+
# },
|
|
488
|
+
# },
|
|
489
|
+
# role_arn: "RoleArn", # required
|
|
490
|
+
# })
|
|
491
|
+
#
|
|
492
|
+
# @example Response structure
|
|
493
|
+
#
|
|
494
|
+
# resp.batch_segment_job_arn #=> String
|
|
495
|
+
#
|
|
496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJob AWS API Documentation
|
|
497
|
+
#
|
|
498
|
+
# @overload create_batch_segment_job(params = {})
|
|
499
|
+
# @param [Hash] params ({})
|
|
500
|
+
def create_batch_segment_job(params = {}, options = {})
|
|
501
|
+
req = build_request(:create_batch_segment_job, params)
|
|
502
|
+
req.send_request(options)
|
|
503
|
+
end
|
|
504
|
+
|
|
505
|
+
# Creates a campaign that deploys a solution version. When a client
|
|
424
506
|
# calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
|
|
425
507
|
# APIs, a campaign is specified in the request.
|
|
426
508
|
#
|
|
@@ -680,9 +762,9 @@ module Aws::Personalize
|
|
|
680
762
|
req.send_request(options)
|
|
681
763
|
end
|
|
682
764
|
|
|
683
|
-
# Creates an empty dataset group. A dataset group
|
|
684
|
-
#
|
|
685
|
-
#
|
|
765
|
+
# Creates an empty dataset group. A dataset group is a container for
|
|
766
|
+
# Amazon Personalize resources. A dataset group can contain at most
|
|
767
|
+
# three datasets, one for each type of dataset:
|
|
686
768
|
#
|
|
687
769
|
# * Interactions
|
|
688
770
|
#
|
|
@@ -690,9 +772,13 @@ module Aws::Personalize
|
|
|
690
772
|
#
|
|
691
773
|
# * Users
|
|
692
774
|
#
|
|
693
|
-
#
|
|
694
|
-
#
|
|
695
|
-
# dataset
|
|
775
|
+
# A dataset group can be a Domain dataset group, where you specify a
|
|
776
|
+
# domain and use pre-configured resources like recommenders, or a Custom
|
|
777
|
+
# dataset group, where you use custom resources, such as a solution with
|
|
778
|
+
# a solution version, that you deploy with a campaign. If you start with
|
|
779
|
+
# a Domain dataset group, you can still add custom resources such as
|
|
780
|
+
# solutions and solution versions trained with recipes for custom use
|
|
781
|
+
# cases and deployed with campaigns.
|
|
696
782
|
#
|
|
697
783
|
# A dataset group can be in one of the following states:
|
|
698
784
|
#
|
|
@@ -743,9 +829,17 @@ module Aws::Personalize
|
|
|
743
829
|
# The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
|
|
744
830
|
# used to encrypt the datasets.
|
|
745
831
|
#
|
|
832
|
+
# @option params [String] :domain
|
|
833
|
+
# The domain of the dataset group. Specify a domain to create a Domain
|
|
834
|
+
# dataset group. The domain you specify determines the default schemas
|
|
835
|
+
# for datasets and the use cases available for recommenders. If you
|
|
836
|
+
# don't specify a domain, you create a Custom dataset group with
|
|
837
|
+
# solution versions that you deploy with a campaign.
|
|
838
|
+
#
|
|
746
839
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
747
840
|
#
|
|
748
841
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
|
842
|
+
# * {Types::CreateDatasetGroupResponse#domain #domain} => String
|
|
749
843
|
#
|
|
750
844
|
# @example Request syntax with placeholder values
|
|
751
845
|
#
|
|
@@ -753,11 +847,13 @@ module Aws::Personalize
|
|
|
753
847
|
# name: "Name", # required
|
|
754
848
|
# role_arn: "RoleArn",
|
|
755
849
|
# kms_key_arn: "KmsKeyArn",
|
|
850
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
|
756
851
|
# })
|
|
757
852
|
#
|
|
758
853
|
# @example Response structure
|
|
759
854
|
#
|
|
760
855
|
# resp.dataset_group_arn #=> String
|
|
856
|
+
# resp.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
761
857
|
#
|
|
762
858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup AWS API Documentation
|
|
763
859
|
#
|
|
@@ -964,12 +1060,100 @@ module Aws::Personalize
|
|
|
964
1060
|
req.send_request(options)
|
|
965
1061
|
end
|
|
966
1062
|
|
|
1063
|
+
# Creates a recommender with the recipe (a Domain dataset group use
|
|
1064
|
+
# case) you specify. You create recommenders for a Domain dataset group
|
|
1065
|
+
# and specify the recommender's Amazon Resource Name (ARN) when you
|
|
1066
|
+
# make a [GetRecommendations][1] request.
|
|
1067
|
+
#
|
|
1068
|
+
# **Status**
|
|
1069
|
+
#
|
|
1070
|
+
# A recommender can be in one of the following states:
|
|
1071
|
+
#
|
|
1072
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
|
1073
|
+
# FAILED
|
|
1074
|
+
#
|
|
1075
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
1076
|
+
#
|
|
1077
|
+
# To get the recommender status, call DescribeRecommender.
|
|
1078
|
+
#
|
|
1079
|
+
# <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
|
|
1080
|
+
# the recommender for recommendations.
|
|
1081
|
+
#
|
|
1082
|
+
# </note>
|
|
1083
|
+
#
|
|
1084
|
+
# **Related APIs**
|
|
1085
|
+
#
|
|
1086
|
+
# * ListRecommenders
|
|
1087
|
+
#
|
|
1088
|
+
# * DescribeRecommender
|
|
1089
|
+
#
|
|
1090
|
+
# * UpdateRecommender
|
|
1091
|
+
#
|
|
1092
|
+
# * DeleteRecommender
|
|
1093
|
+
#
|
|
1094
|
+
#
|
|
1095
|
+
#
|
|
1096
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
|
1097
|
+
#
|
|
1098
|
+
# @option params [required, String] :name
|
|
1099
|
+
# The name of the recommender.
|
|
1100
|
+
#
|
|
1101
|
+
# @option params [required, String] :dataset_group_arn
|
|
1102
|
+
# The Amazon Resource Name (ARN) of the destination domain dataset group
|
|
1103
|
+
# for the recommender.
|
|
1104
|
+
#
|
|
1105
|
+
# @option params [required, String] :recipe_arn
|
|
1106
|
+
# The Amazon Resource Name (ARN) of the recipe that the recommender will
|
|
1107
|
+
# use. For a recommender, a recipe is a Domain dataset group use case.
|
|
1108
|
+
# Only Domain dataset group use cases can be used to create a
|
|
1109
|
+
# recommender. For information about use cases see [Choosing recommender
|
|
1110
|
+
# use cases][1].
|
|
1111
|
+
#
|
|
1112
|
+
#
|
|
1113
|
+
#
|
|
1114
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
|
|
1115
|
+
#
|
|
1116
|
+
# @option params [Types::RecommenderConfig] :recommender_config
|
|
1117
|
+
# The configuration details of the recommender.
|
|
1118
|
+
#
|
|
1119
|
+
# @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1120
|
+
#
|
|
1121
|
+
# * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
|
|
1122
|
+
#
|
|
1123
|
+
# @example Request syntax with placeholder values
|
|
1124
|
+
#
|
|
1125
|
+
# resp = client.create_recommender({
|
|
1126
|
+
# name: "Name", # required
|
|
1127
|
+
# dataset_group_arn: "Arn", # required
|
|
1128
|
+
# recipe_arn: "Arn", # required
|
|
1129
|
+
# recommender_config: {
|
|
1130
|
+
# item_exploration_config: {
|
|
1131
|
+
# "ParameterName" => "ParameterValue",
|
|
1132
|
+
# },
|
|
1133
|
+
# },
|
|
1134
|
+
# })
|
|
1135
|
+
#
|
|
1136
|
+
# @example Response structure
|
|
1137
|
+
#
|
|
1138
|
+
# resp.recommender_arn #=> String
|
|
1139
|
+
#
|
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommender AWS API Documentation
|
|
1141
|
+
#
|
|
1142
|
+
# @overload create_recommender(params = {})
|
|
1143
|
+
# @param [Hash] params ({})
|
|
1144
|
+
def create_recommender(params = {}, options = {})
|
|
1145
|
+
req = build_request(:create_recommender, params)
|
|
1146
|
+
req.send_request(options)
|
|
1147
|
+
end
|
|
1148
|
+
|
|
967
1149
|
# Creates an Amazon Personalize schema from the specified schema string.
|
|
968
1150
|
# The schema you create must be in Avro JSON format.
|
|
969
1151
|
#
|
|
970
1152
|
# Amazon Personalize recognizes three schema variants. Each schema is
|
|
971
1153
|
# associated with a dataset type and has a set of required field and
|
|
972
|
-
# keywords.
|
|
1154
|
+
# keywords. If you are creating a schema for a dataset in a Domain
|
|
1155
|
+
# dataset group, you provide the domain of the Domain dataset group. You
|
|
1156
|
+
# specify a schema when you call CreateDataset.
|
|
973
1157
|
#
|
|
974
1158
|
# **Related APIs**
|
|
975
1159
|
#
|
|
@@ -985,6 +1169,11 @@ module Aws::Personalize
|
|
|
985
1169
|
# @option params [required, String] :schema
|
|
986
1170
|
# A schema in Avro JSON format.
|
|
987
1171
|
#
|
|
1172
|
+
# @option params [String] :domain
|
|
1173
|
+
# The domain for the schema. If you are creating a schema for a dataset
|
|
1174
|
+
# in a Domain dataset group, specify the domain you chose when you
|
|
1175
|
+
# created the Domain dataset group.
|
|
1176
|
+
#
|
|
988
1177
|
# @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
989
1178
|
#
|
|
990
1179
|
# * {Types::CreateSchemaResponse#schema_arn #schema_arn} => String
|
|
@@ -994,6 +1183,7 @@ module Aws::Personalize
|
|
|
994
1183
|
# resp = client.create_schema({
|
|
995
1184
|
# name: "Name", # required
|
|
996
1185
|
# schema: "AvroSchema", # required
|
|
1186
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
|
997
1187
|
# })
|
|
998
1188
|
#
|
|
999
1189
|
# @example Response structure
|
|
@@ -1189,10 +1379,10 @@ module Aws::Personalize
|
|
|
1189
1379
|
req.send_request(options)
|
|
1190
1380
|
end
|
|
1191
1381
|
|
|
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.
|
|
1382
|
+
# Trains or retrains an active solution in a Custom dataset group. A
|
|
1383
|
+
# solution is created using the CreateSolution operation and must be in
|
|
1384
|
+
# the ACTIVE state before calling `CreateSolutionVersion`. A new version
|
|
1385
|
+
# of the solution is created every time you call this operation.
|
|
1196
1386
|
#
|
|
1197
1387
|
# **Status**
|
|
1198
1388
|
#
|
|
@@ -1406,6 +1596,33 @@ module Aws::Personalize
|
|
|
1406
1596
|
req.send_request(options)
|
|
1407
1597
|
end
|
|
1408
1598
|
|
|
1599
|
+
# Deactivates and removes a recommender. A deleted recommender can no
|
|
1600
|
+
# longer be specified in a [GetRecommendations][1] request.
|
|
1601
|
+
#
|
|
1602
|
+
#
|
|
1603
|
+
#
|
|
1604
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
|
1605
|
+
#
|
|
1606
|
+
# @option params [required, String] :recommender_arn
|
|
1607
|
+
# The Amazon Resource Name (ARN) of the recommender to delete.
|
|
1608
|
+
#
|
|
1609
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1610
|
+
#
|
|
1611
|
+
# @example Request syntax with placeholder values
|
|
1612
|
+
#
|
|
1613
|
+
# resp = client.delete_recommender({
|
|
1614
|
+
# recommender_arn: "Arn", # required
|
|
1615
|
+
# })
|
|
1616
|
+
#
|
|
1617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommender AWS API Documentation
|
|
1618
|
+
#
|
|
1619
|
+
# @overload delete_recommender(params = {})
|
|
1620
|
+
# @param [Hash] params ({})
|
|
1621
|
+
def delete_recommender(params = {}, options = {})
|
|
1622
|
+
req = build_request(:delete_recommender, params)
|
|
1623
|
+
req.send_request(options)
|
|
1624
|
+
end
|
|
1625
|
+
|
|
1409
1626
|
# Deletes a schema. Before deleting a schema, you must delete all
|
|
1410
1627
|
# datasets referencing the schema. For more information on schemas, see
|
|
1411
1628
|
# CreateSchema.
|
|
@@ -1557,6 +1774,49 @@ module Aws::Personalize
|
|
|
1557
1774
|
req.send_request(options)
|
|
1558
1775
|
end
|
|
1559
1776
|
|
|
1777
|
+
# Gets the properties of a batch segment job including name, Amazon
|
|
1778
|
+
# Resource Name (ARN), status, input and output configurations, and the
|
|
1779
|
+
# ARN of the solution version used to generate segments.
|
|
1780
|
+
#
|
|
1781
|
+
# @option params [required, String] :batch_segment_job_arn
|
|
1782
|
+
# The ARN of the batch segment job to describe.
|
|
1783
|
+
#
|
|
1784
|
+
# @return [Types::DescribeBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1785
|
+
#
|
|
1786
|
+
# * {Types::DescribeBatchSegmentJobResponse#batch_segment_job #batch_segment_job} => Types::BatchSegmentJob
|
|
1787
|
+
#
|
|
1788
|
+
# @example Request syntax with placeholder values
|
|
1789
|
+
#
|
|
1790
|
+
# resp = client.describe_batch_segment_job({
|
|
1791
|
+
# batch_segment_job_arn: "Arn", # required
|
|
1792
|
+
# })
|
|
1793
|
+
#
|
|
1794
|
+
# @example Response structure
|
|
1795
|
+
#
|
|
1796
|
+
# resp.batch_segment_job.job_name #=> String
|
|
1797
|
+
# resp.batch_segment_job.batch_segment_job_arn #=> String
|
|
1798
|
+
# resp.batch_segment_job.filter_arn #=> String
|
|
1799
|
+
# resp.batch_segment_job.failure_reason #=> String
|
|
1800
|
+
# resp.batch_segment_job.solution_version_arn #=> String
|
|
1801
|
+
# resp.batch_segment_job.num_results #=> Integer
|
|
1802
|
+
# resp.batch_segment_job.job_input.s3_data_source.path #=> String
|
|
1803
|
+
# resp.batch_segment_job.job_input.s3_data_source.kms_key_arn #=> String
|
|
1804
|
+
# resp.batch_segment_job.job_output.s3_data_destination.path #=> String
|
|
1805
|
+
# resp.batch_segment_job.job_output.s3_data_destination.kms_key_arn #=> String
|
|
1806
|
+
# resp.batch_segment_job.role_arn #=> String
|
|
1807
|
+
# resp.batch_segment_job.status #=> String
|
|
1808
|
+
# resp.batch_segment_job.creation_date_time #=> Time
|
|
1809
|
+
# resp.batch_segment_job.last_updated_date_time #=> Time
|
|
1810
|
+
#
|
|
1811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob AWS API Documentation
|
|
1812
|
+
#
|
|
1813
|
+
# @overload describe_batch_segment_job(params = {})
|
|
1814
|
+
# @param [Hash] params ({})
|
|
1815
|
+
def describe_batch_segment_job(params = {}, options = {})
|
|
1816
|
+
req = build_request(:describe_batch_segment_job, params)
|
|
1817
|
+
req.send_request(options)
|
|
1818
|
+
end
|
|
1819
|
+
|
|
1560
1820
|
# Describes the given campaign, including its status.
|
|
1561
1821
|
#
|
|
1562
1822
|
# A campaign can be in one of the following states:
|
|
@@ -1715,6 +1975,7 @@ module Aws::Personalize
|
|
|
1715
1975
|
# resp.dataset_group.creation_date_time #=> Time
|
|
1716
1976
|
# resp.dataset_group.last_updated_date_time #=> Time
|
|
1717
1977
|
# resp.dataset_group.failure_reason #=> String
|
|
1978
|
+
# resp.dataset_group.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
1718
1979
|
#
|
|
1719
1980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup AWS API Documentation
|
|
1720
1981
|
#
|
|
@@ -1925,6 +2186,65 @@ module Aws::Personalize
|
|
|
1925
2186
|
req.send_request(options)
|
|
1926
2187
|
end
|
|
1927
2188
|
|
|
2189
|
+
# Describes the given recommender, including its status.
|
|
2190
|
+
#
|
|
2191
|
+
# A recommender can be in one of the following states:
|
|
2192
|
+
#
|
|
2193
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
|
2194
|
+
# FAILED
|
|
2195
|
+
#
|
|
2196
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
2197
|
+
#
|
|
2198
|
+
# When the `status` is `CREATE FAILED`, the response includes the
|
|
2199
|
+
# `failureReason` key, which describes why.
|
|
2200
|
+
#
|
|
2201
|
+
# For more information on recommenders, see [CreateRecommender][1].
|
|
2202
|
+
#
|
|
2203
|
+
#
|
|
2204
|
+
#
|
|
2205
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
|
|
2206
|
+
#
|
|
2207
|
+
# @option params [required, String] :recommender_arn
|
|
2208
|
+
# The Amazon Resource Name (ARN) of the recommender to describe.
|
|
2209
|
+
#
|
|
2210
|
+
# @return [Types::DescribeRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2211
|
+
#
|
|
2212
|
+
# * {Types::DescribeRecommenderResponse#recommender #recommender} => Types::Recommender
|
|
2213
|
+
#
|
|
2214
|
+
# @example Request syntax with placeholder values
|
|
2215
|
+
#
|
|
2216
|
+
# resp = client.describe_recommender({
|
|
2217
|
+
# recommender_arn: "Arn", # required
|
|
2218
|
+
# })
|
|
2219
|
+
#
|
|
2220
|
+
# @example Response structure
|
|
2221
|
+
#
|
|
2222
|
+
# resp.recommender.recommender_arn #=> String
|
|
2223
|
+
# resp.recommender.dataset_group_arn #=> String
|
|
2224
|
+
# resp.recommender.name #=> String
|
|
2225
|
+
# resp.recommender.recipe_arn #=> String
|
|
2226
|
+
# resp.recommender.recommender_config.item_exploration_config #=> Hash
|
|
2227
|
+
# resp.recommender.recommender_config.item_exploration_config["ParameterName"] #=> String
|
|
2228
|
+
# resp.recommender.creation_date_time #=> Time
|
|
2229
|
+
# resp.recommender.last_updated_date_time #=> Time
|
|
2230
|
+
# resp.recommender.status #=> String
|
|
2231
|
+
# resp.recommender.failure_reason #=> String
|
|
2232
|
+
# resp.recommender.latest_recommender_update.recommender_config.item_exploration_config #=> Hash
|
|
2233
|
+
# resp.recommender.latest_recommender_update.recommender_config.item_exploration_config["ParameterName"] #=> String
|
|
2234
|
+
# resp.recommender.latest_recommender_update.creation_date_time #=> Time
|
|
2235
|
+
# resp.recommender.latest_recommender_update.last_updated_date_time #=> Time
|
|
2236
|
+
# resp.recommender.latest_recommender_update.status #=> String
|
|
2237
|
+
# resp.recommender.latest_recommender_update.failure_reason #=> String
|
|
2238
|
+
#
|
|
2239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommender AWS API Documentation
|
|
2240
|
+
#
|
|
2241
|
+
# @overload describe_recommender(params = {})
|
|
2242
|
+
# @param [Hash] params ({})
|
|
2243
|
+
def describe_recommender(params = {}, options = {})
|
|
2244
|
+
req = build_request(:describe_recommender, params)
|
|
2245
|
+
req.send_request(options)
|
|
2246
|
+
end
|
|
2247
|
+
|
|
1928
2248
|
# Describes a schema. For more information on schemas, see CreateSchema.
|
|
1929
2249
|
#
|
|
1930
2250
|
# @option params [required, String] :schema_arn
|
|
@@ -1947,6 +2267,7 @@ module Aws::Personalize
|
|
|
1947
2267
|
# resp.schema.schema #=> String
|
|
1948
2268
|
# resp.schema.creation_date_time #=> Time
|
|
1949
2269
|
# resp.schema.last_updated_date_time #=> Time
|
|
2270
|
+
# resp.schema.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
1950
2271
|
#
|
|
1951
2272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema AWS API Documentation
|
|
1952
2273
|
#
|
|
@@ -2180,6 +2501,56 @@ module Aws::Personalize
|
|
|
2180
2501
|
req.send_request(options)
|
|
2181
2502
|
end
|
|
2182
2503
|
|
|
2504
|
+
# Gets a list of the batch segment jobs that have been performed off of
|
|
2505
|
+
# a solution version that you specify.
|
|
2506
|
+
#
|
|
2507
|
+
# @option params [String] :solution_version_arn
|
|
2508
|
+
# The Amazon Resource Name (ARN) of the solution version that the batch
|
|
2509
|
+
# segment jobs used to generate batch segments.
|
|
2510
|
+
#
|
|
2511
|
+
# @option params [String] :next_token
|
|
2512
|
+
# The token to request the next page of results.
|
|
2513
|
+
#
|
|
2514
|
+
# @option params [Integer] :max_results
|
|
2515
|
+
# The maximum number of batch segment job results to return in each
|
|
2516
|
+
# page. The default value is 100.
|
|
2517
|
+
#
|
|
2518
|
+
# @return [Types::ListBatchSegmentJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2519
|
+
#
|
|
2520
|
+
# * {Types::ListBatchSegmentJobsResponse#batch_segment_jobs #batch_segment_jobs} => Array<Types::BatchSegmentJobSummary>
|
|
2521
|
+
# * {Types::ListBatchSegmentJobsResponse#next_token #next_token} => String
|
|
2522
|
+
#
|
|
2523
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2524
|
+
#
|
|
2525
|
+
# @example Request syntax with placeholder values
|
|
2526
|
+
#
|
|
2527
|
+
# resp = client.list_batch_segment_jobs({
|
|
2528
|
+
# solution_version_arn: "Arn",
|
|
2529
|
+
# next_token: "NextToken",
|
|
2530
|
+
# max_results: 1,
|
|
2531
|
+
# })
|
|
2532
|
+
#
|
|
2533
|
+
# @example Response structure
|
|
2534
|
+
#
|
|
2535
|
+
# resp.batch_segment_jobs #=> Array
|
|
2536
|
+
# resp.batch_segment_jobs[0].batch_segment_job_arn #=> String
|
|
2537
|
+
# resp.batch_segment_jobs[0].job_name #=> String
|
|
2538
|
+
# resp.batch_segment_jobs[0].status #=> String
|
|
2539
|
+
# resp.batch_segment_jobs[0].creation_date_time #=> Time
|
|
2540
|
+
# resp.batch_segment_jobs[0].last_updated_date_time #=> Time
|
|
2541
|
+
# resp.batch_segment_jobs[0].failure_reason #=> String
|
|
2542
|
+
# resp.batch_segment_jobs[0].solution_version_arn #=> String
|
|
2543
|
+
# resp.next_token #=> String
|
|
2544
|
+
#
|
|
2545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs AWS API Documentation
|
|
2546
|
+
#
|
|
2547
|
+
# @overload list_batch_segment_jobs(params = {})
|
|
2548
|
+
# @param [Hash] params ({})
|
|
2549
|
+
def list_batch_segment_jobs(params = {}, options = {})
|
|
2550
|
+
req = build_request(:list_batch_segment_jobs, params)
|
|
2551
|
+
req.send_request(options)
|
|
2552
|
+
end
|
|
2553
|
+
|
|
2183
2554
|
# Returns a list of campaigns that use the given solution. When a
|
|
2184
2555
|
# solution is not specified, all the campaigns associated with the
|
|
2185
2556
|
# account are listed. The response provides the properties for each
|
|
@@ -2320,6 +2691,7 @@ module Aws::Personalize
|
|
|
2320
2691
|
# resp.dataset_groups[0].creation_date_time #=> Time
|
|
2321
2692
|
# resp.dataset_groups[0].last_updated_date_time #=> Time
|
|
2322
2693
|
# resp.dataset_groups[0].failure_reason #=> String
|
|
2694
|
+
# resp.dataset_groups[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
2323
2695
|
# resp.next_token #=> String
|
|
2324
2696
|
#
|
|
2325
2697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups AWS API Documentation
|
|
@@ -2546,6 +2918,12 @@ module Aws::Personalize
|
|
|
2546
2918
|
# @option params [Integer] :max_results
|
|
2547
2919
|
# The maximum number of recipes to return.
|
|
2548
2920
|
#
|
|
2921
|
+
# @option params [String] :domain
|
|
2922
|
+
# Filters returned recipes by domain for a Domain dataset group. Only
|
|
2923
|
+
# recipes (Domain dataset group use cases) for this domain are included
|
|
2924
|
+
# in the response. If you don't specify a domain, only non-domain
|
|
2925
|
+
# recipes are returned.
|
|
2926
|
+
#
|
|
2549
2927
|
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2550
2928
|
#
|
|
2551
2929
|
# * {Types::ListRecipesResponse#recipes #recipes} => Array<Types::RecipeSummary>
|
|
@@ -2559,6 +2937,7 @@ module Aws::Personalize
|
|
|
2559
2937
|
# recipe_provider: "SERVICE", # accepts SERVICE
|
|
2560
2938
|
# next_token: "NextToken",
|
|
2561
2939
|
# max_results: 1,
|
|
2940
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
|
2562
2941
|
# })
|
|
2563
2942
|
#
|
|
2564
2943
|
# @example Response structure
|
|
@@ -2569,6 +2948,7 @@ module Aws::Personalize
|
|
|
2569
2948
|
# resp.recipes[0].status #=> String
|
|
2570
2949
|
# resp.recipes[0].creation_date_time #=> Time
|
|
2571
2950
|
# resp.recipes[0].last_updated_date_time #=> Time
|
|
2951
|
+
# resp.recipes[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
2572
2952
|
# resp.next_token #=> String
|
|
2573
2953
|
#
|
|
2574
2954
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes AWS API Documentation
|
|
@@ -2580,6 +2960,66 @@ module Aws::Personalize
|
|
|
2580
2960
|
req.send_request(options)
|
|
2581
2961
|
end
|
|
2582
2962
|
|
|
2963
|
+
# Returns a list of recommenders in a given Domain dataset group. When a
|
|
2964
|
+
# Domain dataset group is not specified, all the recommenders associated
|
|
2965
|
+
# with the account are listed. The response provides the properties for
|
|
2966
|
+
# each recommender, including the Amazon Resource Name (ARN). For more
|
|
2967
|
+
# information on recommenders, see [CreateRecommender][1].
|
|
2968
|
+
#
|
|
2969
|
+
#
|
|
2970
|
+
#
|
|
2971
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
|
|
2972
|
+
#
|
|
2973
|
+
# @option params [String] :dataset_group_arn
|
|
2974
|
+
# The Amazon Resource Name (ARN) of the Domain dataset group to list the
|
|
2975
|
+
# recommenders for. When a Domain dataset group is not specified, all
|
|
2976
|
+
# the recommenders associated with the account are listed.
|
|
2977
|
+
#
|
|
2978
|
+
# @option params [String] :next_token
|
|
2979
|
+
# A token returned from the previous call to `ListRecommenders` for
|
|
2980
|
+
# getting the next set of recommenders (if they exist).
|
|
2981
|
+
#
|
|
2982
|
+
# @option params [Integer] :max_results
|
|
2983
|
+
# The maximum number of recommenders to return.
|
|
2984
|
+
#
|
|
2985
|
+
# @return [Types::ListRecommendersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2986
|
+
#
|
|
2987
|
+
# * {Types::ListRecommendersResponse#recommenders #recommenders} => Array<Types::RecommenderSummary>
|
|
2988
|
+
# * {Types::ListRecommendersResponse#next_token #next_token} => String
|
|
2989
|
+
#
|
|
2990
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2991
|
+
#
|
|
2992
|
+
# @example Request syntax with placeholder values
|
|
2993
|
+
#
|
|
2994
|
+
# resp = client.list_recommenders({
|
|
2995
|
+
# dataset_group_arn: "Arn",
|
|
2996
|
+
# next_token: "NextToken",
|
|
2997
|
+
# max_results: 1,
|
|
2998
|
+
# })
|
|
2999
|
+
#
|
|
3000
|
+
# @example Response structure
|
|
3001
|
+
#
|
|
3002
|
+
# resp.recommenders #=> Array
|
|
3003
|
+
# resp.recommenders[0].name #=> String
|
|
3004
|
+
# resp.recommenders[0].recommender_arn #=> String
|
|
3005
|
+
# resp.recommenders[0].dataset_group_arn #=> String
|
|
3006
|
+
# resp.recommenders[0].recipe_arn #=> String
|
|
3007
|
+
# resp.recommenders[0].recommender_config.item_exploration_config #=> Hash
|
|
3008
|
+
# resp.recommenders[0].recommender_config.item_exploration_config["ParameterName"] #=> String
|
|
3009
|
+
# resp.recommenders[0].status #=> String
|
|
3010
|
+
# resp.recommenders[0].creation_date_time #=> Time
|
|
3011
|
+
# resp.recommenders[0].last_updated_date_time #=> Time
|
|
3012
|
+
# resp.next_token #=> String
|
|
3013
|
+
#
|
|
3014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders AWS API Documentation
|
|
3015
|
+
#
|
|
3016
|
+
# @overload list_recommenders(params = {})
|
|
3017
|
+
# @param [Hash] params ({})
|
|
3018
|
+
def list_recommenders(params = {}, options = {})
|
|
3019
|
+
req = build_request(:list_recommenders, params)
|
|
3020
|
+
req.send_request(options)
|
|
3021
|
+
end
|
|
3022
|
+
|
|
2583
3023
|
# Returns the list of schemas associated with the account. The response
|
|
2584
3024
|
# provides the properties for each schema, including the Amazon Resource
|
|
2585
3025
|
# Name (ARN). For more information on schemas, see CreateSchema.
|
|
@@ -2612,6 +3052,7 @@ module Aws::Personalize
|
|
|
2612
3052
|
# resp.schemas[0].schema_arn #=> String
|
|
2613
3053
|
# resp.schemas[0].creation_date_time #=> Time
|
|
2614
3054
|
# resp.schemas[0].last_updated_date_time #=> Time
|
|
3055
|
+
# resp.schemas[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
|
|
2615
3056
|
# resp.next_token #=> String
|
|
2616
3057
|
#
|
|
2617
3058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas AWS API Documentation
|
|
@@ -2816,6 +3257,42 @@ module Aws::Personalize
|
|
|
2816
3257
|
req.send_request(options)
|
|
2817
3258
|
end
|
|
2818
3259
|
|
|
3260
|
+
# Updates the recommender to modify the recommender configuration.
|
|
3261
|
+
#
|
|
3262
|
+
# @option params [required, String] :recommender_arn
|
|
3263
|
+
# The Amazon Resource Name (ARN) of the recommender to modify.
|
|
3264
|
+
#
|
|
3265
|
+
# @option params [required, Types::RecommenderConfig] :recommender_config
|
|
3266
|
+
# The configuration details of the recommender.
|
|
3267
|
+
#
|
|
3268
|
+
# @return [Types::UpdateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3269
|
+
#
|
|
3270
|
+
# * {Types::UpdateRecommenderResponse#recommender_arn #recommender_arn} => String
|
|
3271
|
+
#
|
|
3272
|
+
# @example Request syntax with placeholder values
|
|
3273
|
+
#
|
|
3274
|
+
# resp = client.update_recommender({
|
|
3275
|
+
# recommender_arn: "Arn", # required
|
|
3276
|
+
# recommender_config: { # required
|
|
3277
|
+
# item_exploration_config: {
|
|
3278
|
+
# "ParameterName" => "ParameterValue",
|
|
3279
|
+
# },
|
|
3280
|
+
# },
|
|
3281
|
+
# })
|
|
3282
|
+
#
|
|
3283
|
+
# @example Response structure
|
|
3284
|
+
#
|
|
3285
|
+
# resp.recommender_arn #=> String
|
|
3286
|
+
#
|
|
3287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommender AWS API Documentation
|
|
3288
|
+
#
|
|
3289
|
+
# @overload update_recommender(params = {})
|
|
3290
|
+
# @param [Hash] params ({})
|
|
3291
|
+
def update_recommender(params = {}, options = {})
|
|
3292
|
+
req = build_request(:update_recommender, params)
|
|
3293
|
+
req.send_request(options)
|
|
3294
|
+
end
|
|
3295
|
+
|
|
2819
3296
|
# @!endgroup
|
|
2820
3297
|
|
|
2821
3298
|
# @param params ({})
|
|
@@ -2829,7 +3306,7 @@ module Aws::Personalize
|
|
|
2829
3306
|
params: params,
|
|
2830
3307
|
config: config)
|
|
2831
3308
|
context[:gem_name] = 'aws-sdk-personalize'
|
|
2832
|
-
context[:gem_version] = '1.
|
|
3309
|
+
context[:gem_version] = '1.35.0'
|
|
2833
3310
|
Seahorse::Client::Request.new(handlers, context)
|
|
2834
3311
|
end
|
|
2835
3312
|
|