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