aws-sdk-personalize 1.33.0 → 1.37.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.
@@ -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.
@@ -305,7 +313,7 @@ module Aws::Personalize
305
313
  # seconds to wait when opening a HTTP session before raising a
306
314
  # `Timeout::Error`.
307
315
  #
308
- # @option options [Integer] :http_read_timeout (60) The default
316
+ # @option options [Float] :http_read_timeout (60) The default
309
317
  # number of seconds to wait for response data. This value can
310
318
  # safely be set per-request on the session.
311
319
  #
@@ -321,6 +329,9 @@ module Aws::Personalize
321
329
  # disables this behaviour. This value can safely be set per
322
330
  # request on the session.
323
331
  #
332
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
333
+ # in seconds.
334
+ #
324
335
  # @option options [Boolean] :http_wire_trace (false) When `true`,
325
336
  # HTTP debug output will be sent to the `:logger`.
326
337
  #
@@ -429,7 +440,78 @@ module Aws::Personalize
429
440
  req.send_request(options)
430
441
  end
431
442
 
432
- # Creates a campaign by deploying a solution version. When a client
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
433
515
  # calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
434
516
  # APIs, a campaign is specified in the request.
435
517
  #
@@ -689,9 +771,9 @@ module Aws::Personalize
689
771
  req.send_request(options)
690
772
  end
691
773
 
692
- # Creates an empty dataset group. A dataset group contains related
693
- # datasets that supply data for training a model. A dataset group can
694
- # contain at most three datasets, one for each type of dataset:
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:
695
777
  #
696
778
  # * Interactions
697
779
  #
@@ -699,9 +781,13 @@ module Aws::Personalize
699
781
  #
700
782
  # * Users
701
783
  #
702
- # To train a model (create a solution), a dataset group that contains an
703
- # `Interactions` dataset is required. Call CreateDataset to add a
704
- # dataset to the group.
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.
705
791
  #
706
792
  # A dataset group can be in one of the following states:
707
793
  #
@@ -752,9 +838,17 @@ module Aws::Personalize
752
838
  # The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
753
839
  # used to encrypt the datasets.
754
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
+ #
755
848
  # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
756
849
  #
757
850
  # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
851
+ # * {Types::CreateDatasetGroupResponse#domain #domain} => String
758
852
  #
759
853
  # @example Request syntax with placeholder values
760
854
  #
@@ -762,11 +856,13 @@ module Aws::Personalize
762
856
  # name: "Name", # required
763
857
  # role_arn: "RoleArn",
764
858
  # kms_key_arn: "KmsKeyArn",
859
+ # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
765
860
  # })
766
861
  #
767
862
  # @example Response structure
768
863
  #
769
864
  # resp.dataset_group_arn #=> String
865
+ # resp.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
770
866
  #
771
867
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup AWS API Documentation
772
868
  #
@@ -973,12 +1069,127 @@ module Aws::Personalize
973
1069
  req.send_request(options)
974
1070
  end
975
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
+ # **Minimum recommendation requests per second**
1078
+ #
1079
+ # When you create a recommender, you can configure the recommender's
1080
+ # minimum recommendation requests per second. The minimum recommendation
1081
+ # requests per second (`minRecommendationRequestsPerSecond`) specifies
1082
+ # the baseline recommendation request throughput provisioned by Amazon
1083
+ # Personalize. The default minRecommendationRequestsPerSecond is `1`. A
1084
+ # recommendation request is a single `GetRecommendations` operation.
1085
+ # Request throughput is measured in requests per second and Amazon
1086
+ # Personalize uses your requests per second to derive your requests per
1087
+ # hour and the price of your recommender usage.
1088
+ #
1089
+ # If your requests per second increases beyond
1090
+ # `minRecommendationRequestsPerSecond`, Amazon Personalize auto-scales
1091
+ # the provisioned capacity up and down, but never below
1092
+ # `minRecommendationRequestsPerSecond`. There's a short time delay
1093
+ # while the capacity is increased that might cause loss of requests.
1094
+ #
1095
+ # Your bill is the greater of either the minimum requests per hour
1096
+ # (based on minRecommendationRequestsPerSecond) or the actual number of
1097
+ # requests. The actual request throughput used is calculated as the
1098
+ # average requests/second within a one-hour window. We recommend
1099
+ # starting with the default `minRecommendationRequestsPerSecond`, track
1100
+ # your usage using Amazon CloudWatch metrics, and then increase the
1101
+ # `minRecommendationRequestsPerSecond` as necessary.
1102
+ #
1103
+ # **Status**
1104
+ #
1105
+ # A recommender can be in one of the following states:
1106
+ #
1107
+ # * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
1108
+ # FAILED
1109
+ #
1110
+ # * DELETE PENDING > DELETE IN\_PROGRESS
1111
+ #
1112
+ # To get the recommender status, call DescribeRecommender.
1113
+ #
1114
+ # <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
1115
+ # the recommender for recommendations.
1116
+ #
1117
+ # </note>
1118
+ #
1119
+ # **Related APIs**
1120
+ #
1121
+ # * ListRecommenders
1122
+ #
1123
+ # * DescribeRecommender
1124
+ #
1125
+ # * UpdateRecommender
1126
+ #
1127
+ # * DeleteRecommender
1128
+ #
1129
+ #
1130
+ #
1131
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1132
+ #
1133
+ # @option params [required, String] :name
1134
+ # The name of the recommender.
1135
+ #
1136
+ # @option params [required, String] :dataset_group_arn
1137
+ # The Amazon Resource Name (ARN) of the destination domain dataset group
1138
+ # for the recommender.
1139
+ #
1140
+ # @option params [required, String] :recipe_arn
1141
+ # The Amazon Resource Name (ARN) of the recipe that the recommender will
1142
+ # use. For a recommender, a recipe is a Domain dataset group use case.
1143
+ # Only Domain dataset group use cases can be used to create a
1144
+ # recommender. For information about use cases see [Choosing recommender
1145
+ # use cases][1].
1146
+ #
1147
+ #
1148
+ #
1149
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
1150
+ #
1151
+ # @option params [Types::RecommenderConfig] :recommender_config
1152
+ # The configuration details of the recommender.
1153
+ #
1154
+ # @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1155
+ #
1156
+ # * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
1157
+ #
1158
+ # @example Request syntax with placeholder values
1159
+ #
1160
+ # resp = client.create_recommender({
1161
+ # name: "Name", # required
1162
+ # dataset_group_arn: "Arn", # required
1163
+ # recipe_arn: "Arn", # required
1164
+ # recommender_config: {
1165
+ # item_exploration_config: {
1166
+ # "ParameterName" => "ParameterValue",
1167
+ # },
1168
+ # min_recommendation_requests_per_second: 1,
1169
+ # },
1170
+ # })
1171
+ #
1172
+ # @example Response structure
1173
+ #
1174
+ # resp.recommender_arn #=> String
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommender AWS API Documentation
1177
+ #
1178
+ # @overload create_recommender(params = {})
1179
+ # @param [Hash] params ({})
1180
+ def create_recommender(params = {}, options = {})
1181
+ req = build_request(:create_recommender, params)
1182
+ req.send_request(options)
1183
+ end
1184
+
976
1185
  # Creates an Amazon Personalize schema from the specified schema string.
977
1186
  # The schema you create must be in Avro JSON format.
978
1187
  #
979
1188
  # Amazon Personalize recognizes three schema variants. Each schema is
980
1189
  # associated with a dataset type and has a set of required field and
981
- # keywords. You specify a schema when you call CreateDataset.
1190
+ # keywords. If you are creating a schema for a dataset in a Domain
1191
+ # dataset group, you provide the domain of the Domain dataset group. You
1192
+ # specify a schema when you call CreateDataset.
982
1193
  #
983
1194
  # **Related APIs**
984
1195
  #
@@ -994,6 +1205,11 @@ module Aws::Personalize
994
1205
  # @option params [required, String] :schema
995
1206
  # A schema in Avro JSON format.
996
1207
  #
1208
+ # @option params [String] :domain
1209
+ # The domain for the schema. If you are creating a schema for a dataset
1210
+ # in a Domain dataset group, specify the domain you chose when you
1211
+ # created the Domain dataset group.
1212
+ #
997
1213
  # @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
998
1214
  #
999
1215
  # * {Types::CreateSchemaResponse#schema_arn #schema_arn} => String
@@ -1003,6 +1219,7 @@ module Aws::Personalize
1003
1219
  # resp = client.create_schema({
1004
1220
  # name: "Name", # required
1005
1221
  # schema: "AvroSchema", # required
1222
+ # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
1006
1223
  # })
1007
1224
  #
1008
1225
  # @example Response structure
@@ -1198,10 +1415,10 @@ module Aws::Personalize
1198
1415
  req.send_request(options)
1199
1416
  end
1200
1417
 
1201
- # Trains or retrains an active solution. A solution is created using the
1202
- # CreateSolution operation and must be in the ACTIVE state before
1203
- # calling `CreateSolutionVersion`. A new version of the solution is
1204
- # created every time you call this operation.
1418
+ # Trains or retrains an active solution in a Custom dataset group. A
1419
+ # solution is created using the CreateSolution operation and must be in
1420
+ # the ACTIVE state before calling `CreateSolutionVersion`. A new version
1421
+ # of the solution is created every time you call this operation.
1205
1422
  #
1206
1423
  # **Status**
1207
1424
  #
@@ -1415,6 +1632,33 @@ module Aws::Personalize
1415
1632
  req.send_request(options)
1416
1633
  end
1417
1634
 
1635
+ # Deactivates and removes a recommender. A deleted recommender can no
1636
+ # longer be specified in a [GetRecommendations][1] request.
1637
+ #
1638
+ #
1639
+ #
1640
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1641
+ #
1642
+ # @option params [required, String] :recommender_arn
1643
+ # The Amazon Resource Name (ARN) of the recommender to delete.
1644
+ #
1645
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1646
+ #
1647
+ # @example Request syntax with placeholder values
1648
+ #
1649
+ # resp = client.delete_recommender({
1650
+ # recommender_arn: "Arn", # required
1651
+ # })
1652
+ #
1653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommender AWS API Documentation
1654
+ #
1655
+ # @overload delete_recommender(params = {})
1656
+ # @param [Hash] params ({})
1657
+ def delete_recommender(params = {}, options = {})
1658
+ req = build_request(:delete_recommender, params)
1659
+ req.send_request(options)
1660
+ end
1661
+
1418
1662
  # Deletes a schema. Before deleting a schema, you must delete all
1419
1663
  # datasets referencing the schema. For more information on schemas, see
1420
1664
  # CreateSchema.
@@ -1566,6 +1810,49 @@ module Aws::Personalize
1566
1810
  req.send_request(options)
1567
1811
  end
1568
1812
 
1813
+ # Gets the properties of a batch segment job including name, Amazon
1814
+ # Resource Name (ARN), status, input and output configurations, and the
1815
+ # ARN of the solution version used to generate segments.
1816
+ #
1817
+ # @option params [required, String] :batch_segment_job_arn
1818
+ # The ARN of the batch segment job to describe.
1819
+ #
1820
+ # @return [Types::DescribeBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1821
+ #
1822
+ # * {Types::DescribeBatchSegmentJobResponse#batch_segment_job #batch_segment_job} => Types::BatchSegmentJob
1823
+ #
1824
+ # @example Request syntax with placeholder values
1825
+ #
1826
+ # resp = client.describe_batch_segment_job({
1827
+ # batch_segment_job_arn: "Arn", # required
1828
+ # })
1829
+ #
1830
+ # @example Response structure
1831
+ #
1832
+ # resp.batch_segment_job.job_name #=> String
1833
+ # resp.batch_segment_job.batch_segment_job_arn #=> String
1834
+ # resp.batch_segment_job.filter_arn #=> String
1835
+ # resp.batch_segment_job.failure_reason #=> String
1836
+ # resp.batch_segment_job.solution_version_arn #=> String
1837
+ # resp.batch_segment_job.num_results #=> Integer
1838
+ # resp.batch_segment_job.job_input.s3_data_source.path #=> String
1839
+ # resp.batch_segment_job.job_input.s3_data_source.kms_key_arn #=> String
1840
+ # resp.batch_segment_job.job_output.s3_data_destination.path #=> String
1841
+ # resp.batch_segment_job.job_output.s3_data_destination.kms_key_arn #=> String
1842
+ # resp.batch_segment_job.role_arn #=> String
1843
+ # resp.batch_segment_job.status #=> String
1844
+ # resp.batch_segment_job.creation_date_time #=> Time
1845
+ # resp.batch_segment_job.last_updated_date_time #=> Time
1846
+ #
1847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob AWS API Documentation
1848
+ #
1849
+ # @overload describe_batch_segment_job(params = {})
1850
+ # @param [Hash] params ({})
1851
+ def describe_batch_segment_job(params = {}, options = {})
1852
+ req = build_request(:describe_batch_segment_job, params)
1853
+ req.send_request(options)
1854
+ end
1855
+
1569
1856
  # Describes the given campaign, including its status.
1570
1857
  #
1571
1858
  # A campaign can be in one of the following states:
@@ -1724,6 +2011,7 @@ module Aws::Personalize
1724
2011
  # resp.dataset_group.creation_date_time #=> Time
1725
2012
  # resp.dataset_group.last_updated_date_time #=> Time
1726
2013
  # resp.dataset_group.failure_reason #=> String
2014
+ # resp.dataset_group.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
1727
2015
  #
1728
2016
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup AWS API Documentation
1729
2017
  #
@@ -1934,6 +2222,67 @@ module Aws::Personalize
1934
2222
  req.send_request(options)
1935
2223
  end
1936
2224
 
2225
+ # Describes the given recommender, including its status.
2226
+ #
2227
+ # A recommender can be in one of the following states:
2228
+ #
2229
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
2230
+ # FAILED
2231
+ #
2232
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
2233
+ #
2234
+ # When the `status` is `CREATE FAILED`, the response includes the
2235
+ # `failureReason` key, which describes why.
2236
+ #
2237
+ # For more information on recommenders, see [CreateRecommender][1].
2238
+ #
2239
+ #
2240
+ #
2241
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
2242
+ #
2243
+ # @option params [required, String] :recommender_arn
2244
+ # The Amazon Resource Name (ARN) of the recommender to describe.
2245
+ #
2246
+ # @return [Types::DescribeRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2247
+ #
2248
+ # * {Types::DescribeRecommenderResponse#recommender #recommender} => Types::Recommender
2249
+ #
2250
+ # @example Request syntax with placeholder values
2251
+ #
2252
+ # resp = client.describe_recommender({
2253
+ # recommender_arn: "Arn", # required
2254
+ # })
2255
+ #
2256
+ # @example Response structure
2257
+ #
2258
+ # resp.recommender.recommender_arn #=> String
2259
+ # resp.recommender.dataset_group_arn #=> String
2260
+ # resp.recommender.name #=> String
2261
+ # resp.recommender.recipe_arn #=> String
2262
+ # resp.recommender.recommender_config.item_exploration_config #=> Hash
2263
+ # resp.recommender.recommender_config.item_exploration_config["ParameterName"] #=> String
2264
+ # resp.recommender.recommender_config.min_recommendation_requests_per_second #=> Integer
2265
+ # resp.recommender.creation_date_time #=> Time
2266
+ # resp.recommender.last_updated_date_time #=> Time
2267
+ # resp.recommender.status #=> String
2268
+ # resp.recommender.failure_reason #=> String
2269
+ # resp.recommender.latest_recommender_update.recommender_config.item_exploration_config #=> Hash
2270
+ # resp.recommender.latest_recommender_update.recommender_config.item_exploration_config["ParameterName"] #=> String
2271
+ # resp.recommender.latest_recommender_update.recommender_config.min_recommendation_requests_per_second #=> Integer
2272
+ # resp.recommender.latest_recommender_update.creation_date_time #=> Time
2273
+ # resp.recommender.latest_recommender_update.last_updated_date_time #=> Time
2274
+ # resp.recommender.latest_recommender_update.status #=> String
2275
+ # resp.recommender.latest_recommender_update.failure_reason #=> String
2276
+ #
2277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommender AWS API Documentation
2278
+ #
2279
+ # @overload describe_recommender(params = {})
2280
+ # @param [Hash] params ({})
2281
+ def describe_recommender(params = {}, options = {})
2282
+ req = build_request(:describe_recommender, params)
2283
+ req.send_request(options)
2284
+ end
2285
+
1937
2286
  # Describes a schema. For more information on schemas, see CreateSchema.
1938
2287
  #
1939
2288
  # @option params [required, String] :schema_arn
@@ -1956,6 +2305,7 @@ module Aws::Personalize
1956
2305
  # resp.schema.schema #=> String
1957
2306
  # resp.schema.creation_date_time #=> Time
1958
2307
  # resp.schema.last_updated_date_time #=> Time
2308
+ # resp.schema.domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
1959
2309
  #
1960
2310
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema AWS API Documentation
1961
2311
  #
@@ -2189,6 +2539,56 @@ module Aws::Personalize
2189
2539
  req.send_request(options)
2190
2540
  end
2191
2541
 
2542
+ # Gets a list of the batch segment jobs that have been performed off of
2543
+ # a solution version that you specify.
2544
+ #
2545
+ # @option params [String] :solution_version_arn
2546
+ # The Amazon Resource Name (ARN) of the solution version that the batch
2547
+ # segment jobs used to generate batch segments.
2548
+ #
2549
+ # @option params [String] :next_token
2550
+ # The token to request the next page of results.
2551
+ #
2552
+ # @option params [Integer] :max_results
2553
+ # The maximum number of batch segment job results to return in each
2554
+ # page. The default value is 100.
2555
+ #
2556
+ # @return [Types::ListBatchSegmentJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2557
+ #
2558
+ # * {Types::ListBatchSegmentJobsResponse#batch_segment_jobs #batch_segment_jobs} => Array&lt;Types::BatchSegmentJobSummary&gt;
2559
+ # * {Types::ListBatchSegmentJobsResponse#next_token #next_token} => String
2560
+ #
2561
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2562
+ #
2563
+ # @example Request syntax with placeholder values
2564
+ #
2565
+ # resp = client.list_batch_segment_jobs({
2566
+ # solution_version_arn: "Arn",
2567
+ # next_token: "NextToken",
2568
+ # max_results: 1,
2569
+ # })
2570
+ #
2571
+ # @example Response structure
2572
+ #
2573
+ # resp.batch_segment_jobs #=> Array
2574
+ # resp.batch_segment_jobs[0].batch_segment_job_arn #=> String
2575
+ # resp.batch_segment_jobs[0].job_name #=> String
2576
+ # resp.batch_segment_jobs[0].status #=> String
2577
+ # resp.batch_segment_jobs[0].creation_date_time #=> Time
2578
+ # resp.batch_segment_jobs[0].last_updated_date_time #=> Time
2579
+ # resp.batch_segment_jobs[0].failure_reason #=> String
2580
+ # resp.batch_segment_jobs[0].solution_version_arn #=> String
2581
+ # resp.next_token #=> String
2582
+ #
2583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs AWS API Documentation
2584
+ #
2585
+ # @overload list_batch_segment_jobs(params = {})
2586
+ # @param [Hash] params ({})
2587
+ def list_batch_segment_jobs(params = {}, options = {})
2588
+ req = build_request(:list_batch_segment_jobs, params)
2589
+ req.send_request(options)
2590
+ end
2591
+
2192
2592
  # Returns a list of campaigns that use the given solution. When a
2193
2593
  # solution is not specified, all the campaigns associated with the
2194
2594
  # account are listed. The response provides the properties for each
@@ -2329,6 +2729,7 @@ module Aws::Personalize
2329
2729
  # resp.dataset_groups[0].creation_date_time #=> Time
2330
2730
  # resp.dataset_groups[0].last_updated_date_time #=> Time
2331
2731
  # resp.dataset_groups[0].failure_reason #=> String
2732
+ # resp.dataset_groups[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
2332
2733
  # resp.next_token #=> String
2333
2734
  #
2334
2735
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups AWS API Documentation
@@ -2555,6 +2956,12 @@ module Aws::Personalize
2555
2956
  # @option params [Integer] :max_results
2556
2957
  # The maximum number of recipes to return.
2557
2958
  #
2959
+ # @option params [String] :domain
2960
+ # Filters returned recipes by domain for a Domain dataset group. Only
2961
+ # recipes (Domain dataset group use cases) for this domain are included
2962
+ # in the response. If you don't specify a domain, only non-domain
2963
+ # recipes are returned.
2964
+ #
2558
2965
  # @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2559
2966
  #
2560
2967
  # * {Types::ListRecipesResponse#recipes #recipes} => Array&lt;Types::RecipeSummary&gt;
@@ -2568,6 +2975,7 @@ module Aws::Personalize
2568
2975
  # recipe_provider: "SERVICE", # accepts SERVICE
2569
2976
  # next_token: "NextToken",
2570
2977
  # max_results: 1,
2978
+ # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
2571
2979
  # })
2572
2980
  #
2573
2981
  # @example Response structure
@@ -2578,6 +2986,7 @@ module Aws::Personalize
2578
2986
  # resp.recipes[0].status #=> String
2579
2987
  # resp.recipes[0].creation_date_time #=> Time
2580
2988
  # resp.recipes[0].last_updated_date_time #=> Time
2989
+ # resp.recipes[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
2581
2990
  # resp.next_token #=> String
2582
2991
  #
2583
2992
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes AWS API Documentation
@@ -2589,6 +2998,67 @@ module Aws::Personalize
2589
2998
  req.send_request(options)
2590
2999
  end
2591
3000
 
3001
+ # Returns a list of recommenders in a given Domain dataset group. When a
3002
+ # Domain dataset group is not specified, all the recommenders associated
3003
+ # with the account are listed. The response provides the properties for
3004
+ # each recommender, including the Amazon Resource Name (ARN). For more
3005
+ # information on recommenders, see [CreateRecommender][1].
3006
+ #
3007
+ #
3008
+ #
3009
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html
3010
+ #
3011
+ # @option params [String] :dataset_group_arn
3012
+ # The Amazon Resource Name (ARN) of the Domain dataset group to list the
3013
+ # recommenders for. When a Domain dataset group is not specified, all
3014
+ # the recommenders associated with the account are listed.
3015
+ #
3016
+ # @option params [String] :next_token
3017
+ # A token returned from the previous call to `ListRecommenders` for
3018
+ # getting the next set of recommenders (if they exist).
3019
+ #
3020
+ # @option params [Integer] :max_results
3021
+ # The maximum number of recommenders to return.
3022
+ #
3023
+ # @return [Types::ListRecommendersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3024
+ #
3025
+ # * {Types::ListRecommendersResponse#recommenders #recommenders} => Array&lt;Types::RecommenderSummary&gt;
3026
+ # * {Types::ListRecommendersResponse#next_token #next_token} => String
3027
+ #
3028
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3029
+ #
3030
+ # @example Request syntax with placeholder values
3031
+ #
3032
+ # resp = client.list_recommenders({
3033
+ # dataset_group_arn: "Arn",
3034
+ # next_token: "NextToken",
3035
+ # max_results: 1,
3036
+ # })
3037
+ #
3038
+ # @example Response structure
3039
+ #
3040
+ # resp.recommenders #=> Array
3041
+ # resp.recommenders[0].name #=> String
3042
+ # resp.recommenders[0].recommender_arn #=> String
3043
+ # resp.recommenders[0].dataset_group_arn #=> String
3044
+ # resp.recommenders[0].recipe_arn #=> String
3045
+ # resp.recommenders[0].recommender_config.item_exploration_config #=> Hash
3046
+ # resp.recommenders[0].recommender_config.item_exploration_config["ParameterName"] #=> String
3047
+ # resp.recommenders[0].recommender_config.min_recommendation_requests_per_second #=> Integer
3048
+ # resp.recommenders[0].status #=> String
3049
+ # resp.recommenders[0].creation_date_time #=> Time
3050
+ # resp.recommenders[0].last_updated_date_time #=> Time
3051
+ # resp.next_token #=> String
3052
+ #
3053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders AWS API Documentation
3054
+ #
3055
+ # @overload list_recommenders(params = {})
3056
+ # @param [Hash] params ({})
3057
+ def list_recommenders(params = {}, options = {})
3058
+ req = build_request(:list_recommenders, params)
3059
+ req.send_request(options)
3060
+ end
3061
+
2592
3062
  # Returns the list of schemas associated with the account. The response
2593
3063
  # provides the properties for each schema, including the Amazon Resource
2594
3064
  # Name (ARN). For more information on schemas, see CreateSchema.
@@ -2621,6 +3091,7 @@ module Aws::Personalize
2621
3091
  # resp.schemas[0].schema_arn #=> String
2622
3092
  # resp.schemas[0].creation_date_time #=> Time
2623
3093
  # resp.schemas[0].last_updated_date_time #=> Time
3094
+ # resp.schemas[0].domain #=> String, one of "ECOMMERCE", "VIDEO_ON_DEMAND"
2624
3095
  # resp.next_token #=> String
2625
3096
  #
2626
3097
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas AWS API Documentation
@@ -2825,6 +3296,43 @@ module Aws::Personalize
2825
3296
  req.send_request(options)
2826
3297
  end
2827
3298
 
3299
+ # Updates the recommender to modify the recommender configuration.
3300
+ #
3301
+ # @option params [required, String] :recommender_arn
3302
+ # The Amazon Resource Name (ARN) of the recommender to modify.
3303
+ #
3304
+ # @option params [required, Types::RecommenderConfig] :recommender_config
3305
+ # The configuration details of the recommender.
3306
+ #
3307
+ # @return [Types::UpdateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3308
+ #
3309
+ # * {Types::UpdateRecommenderResponse#recommender_arn #recommender_arn} => String
3310
+ #
3311
+ # @example Request syntax with placeholder values
3312
+ #
3313
+ # resp = client.update_recommender({
3314
+ # recommender_arn: "Arn", # required
3315
+ # recommender_config: { # required
3316
+ # item_exploration_config: {
3317
+ # "ParameterName" => "ParameterValue",
3318
+ # },
3319
+ # min_recommendation_requests_per_second: 1,
3320
+ # },
3321
+ # })
3322
+ #
3323
+ # @example Response structure
3324
+ #
3325
+ # resp.recommender_arn #=> String
3326
+ #
3327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommender AWS API Documentation
3328
+ #
3329
+ # @overload update_recommender(params = {})
3330
+ # @param [Hash] params ({})
3331
+ def update_recommender(params = {}, options = {})
3332
+ req = build_request(:update_recommender, params)
3333
+ req.send_request(options)
3334
+ end
3335
+
2828
3336
  # @!endgroup
2829
3337
 
2830
3338
  # @param params ({})
@@ -2838,7 +3346,7 @@ module Aws::Personalize
2838
3346
  params: params,
2839
3347
  config: config)
2840
3348
  context[:gem_name] = 'aws-sdk-personalize'
2841
- context[:gem_version] = '1.33.0'
3349
+ context[:gem_version] = '1.37.0'
2842
3350
  Seahorse::Client::Request.new(handlers, context)
2843
3351
  end
2844
3352