aws-sdk-personalize 1.7.0 → 1.12.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: ba039375af63cb4543ace6efb8b88a697bf1eacc
4
- data.tar.gz: d284796db16f4d705ed1a00a12939dbcbd3ead72
2
+ SHA256:
3
+ metadata.gz: c19c1c9271cb6cabf94b32c458927b8401f5ab163751b150188f37c0c4495dfb
4
+ data.tar.gz: 988d920bd5b44f11c9b9445aed8d47e5f80f766712ae02262bc9e539e9b2604f
5
5
  SHA512:
6
- metadata.gz: e09bc30db52b5f442affbfec4cf48816fa4963cdaf6dcd8b9084f75928a1a039cf8ea4b12a58929ef27681a1ba1e867b20d77ad632ea69b02e633060d03d8aea
7
- data.tar.gz: ff58a356beda3ab9ef9898d24e01affebd796f1363d60241fa8f9a4d3dafc30c40d579caae1ebd7c0ed3a019be3a9f8b2d2b0a6535f0548c77f974fd44dd70b3
6
+ metadata.gz: 9e64869d87dfc0ec152e2c3c7f0a0f5c7c769796c80615c39fcd4fdec711a90444eb5398fc84d8f40c1b3ff3df8f23958eeb7fcb02e5d98f226328a4289419ca
7
+ data.tar.gz: 209667e0405b44a2b9d662eeccd6e37237ef1e13237be8f28ee11fbcdea409364b19821961211085e619e780eaee9480285ea426a397ede7ae1e971f6b25bd21
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-personalize/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # personalize = Aws::Personalize::Client.new
28
+ # resp = personalize.create_batch_inference_job(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Personalize all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Personalize are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Personalize::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Personalize API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-personalize/customizations'
42
45
  # @service
43
46
  module Aws::Personalize
44
47
 
45
- GEM_VERSION = '1.7.0'
48
+ GEM_VERSION = '1.12.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:personalize)
31
31
 
32
32
  module Aws::Personalize
33
+ # An API client for Personalize. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Personalize::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::Personalize
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::Personalize
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::Personalize
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::Personalize
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::Personalize
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::Personalize
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::Personalize
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::Personalize
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::Personalize
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -264,6 +318,71 @@ module Aws::Personalize
264
318
 
265
319
  # @!group API Operations
266
320
 
321
+ # Creates a batch inference job. The operation can handle up to 50
322
+ # million records and the input file must be in JSON format. For more
323
+ # information, see recommendations-batch.
324
+ #
325
+ # @option params [required, String] :job_name
326
+ # The name of the batch inference job to create.
327
+ #
328
+ # @option params [required, String] :solution_version_arn
329
+ # The Amazon Resource Name (ARN) of the solution version that will be
330
+ # used to generate the batch inference recommendations.
331
+ #
332
+ # @option params [Integer] :num_results
333
+ # The number of recommendations to retreive.
334
+ #
335
+ # @option params [required, Types::BatchInferenceJobInput] :job_input
336
+ # The Amazon S3 path that leads to the input file to base your
337
+ # recommendations on. The input material must be in JSON format.
338
+ #
339
+ # @option params [required, Types::BatchInferenceJobOutput] :job_output
340
+ # The path to the Amazon S3 bucket where the job's output will be
341
+ # stored.
342
+ #
343
+ # @option params [required, String] :role_arn
344
+ # The ARN of the Amazon Identity and Access Management role that has
345
+ # permissions to read and write to your input and out Amazon S3 buckets
346
+ # respectively.
347
+ #
348
+ # @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
349
+ #
350
+ # * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
351
+ #
352
+ # @example Request syntax with placeholder values
353
+ #
354
+ # resp = client.create_batch_inference_job({
355
+ # job_name: "Name", # required
356
+ # solution_version_arn: "Arn", # required
357
+ # num_results: 1,
358
+ # job_input: { # required
359
+ # s3_data_source: { # required
360
+ # path: "S3Location", # required
361
+ # kms_key_arn: "KmsKeyArn",
362
+ # },
363
+ # },
364
+ # job_output: { # required
365
+ # s3_data_destination: { # required
366
+ # path: "S3Location", # required
367
+ # kms_key_arn: "KmsKeyArn",
368
+ # },
369
+ # },
370
+ # role_arn: "RoleArn", # required
371
+ # })
372
+ #
373
+ # @example Response structure
374
+ #
375
+ # resp.batch_inference_job_arn #=> String
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJob AWS API Documentation
378
+ #
379
+ # @overload create_batch_inference_job(params = {})
380
+ # @param [Hash] params ({})
381
+ def create_batch_inference_job(params = {}, options = {})
382
+ req = build_request(:create_batch_inference_job, params)
383
+ req.send_request(options)
384
+ end
385
+
267
386
  # Creates a campaign by deploying a solution version. When a client
268
387
  # calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
269
388
  # APIs, a campaign is specified in the request.
@@ -1168,6 +1287,48 @@ module Aws::Personalize
1168
1287
  req.send_request(options)
1169
1288
  end
1170
1289
 
1290
+ # Gets the properties of a batch inference job including name, Amazon
1291
+ # Resource Name (ARN), status, input and output configurations, and the
1292
+ # ARN of the solution version used to generate the recommendations.
1293
+ #
1294
+ # @option params [required, String] :batch_inference_job_arn
1295
+ # The ARN of the batch inference job to describe.
1296
+ #
1297
+ # @return [Types::DescribeBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1298
+ #
1299
+ # * {Types::DescribeBatchInferenceJobResponse#batch_inference_job #batch_inference_job} => Types::BatchInferenceJob
1300
+ #
1301
+ # @example Request syntax with placeholder values
1302
+ #
1303
+ # resp = client.describe_batch_inference_job({
1304
+ # batch_inference_job_arn: "Arn", # required
1305
+ # })
1306
+ #
1307
+ # @example Response structure
1308
+ #
1309
+ # resp.batch_inference_job.job_name #=> String
1310
+ # resp.batch_inference_job.batch_inference_job_arn #=> String
1311
+ # resp.batch_inference_job.failure_reason #=> String
1312
+ # resp.batch_inference_job.solution_version_arn #=> String
1313
+ # resp.batch_inference_job.num_results #=> Integer
1314
+ # resp.batch_inference_job.job_input.s3_data_source.path #=> String
1315
+ # resp.batch_inference_job.job_input.s3_data_source.kms_key_arn #=> String
1316
+ # resp.batch_inference_job.job_output.s3_data_destination.path #=> String
1317
+ # resp.batch_inference_job.job_output.s3_data_destination.kms_key_arn #=> String
1318
+ # resp.batch_inference_job.role_arn #=> String
1319
+ # resp.batch_inference_job.status #=> String
1320
+ # resp.batch_inference_job.creation_date_time #=> Time
1321
+ # resp.batch_inference_job.last_updated_date_time #=> Time
1322
+ #
1323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJob AWS API Documentation
1324
+ #
1325
+ # @overload describe_batch_inference_job(params = {})
1326
+ # @param [Hash] params ({})
1327
+ def describe_batch_inference_job(params = {}, options = {})
1328
+ req = build_request(:describe_batch_inference_job, params)
1329
+ req.send_request(options)
1330
+ end
1331
+
1171
1332
  # Describes the given campaign, including its status.
1172
1333
  #
1173
1334
  # A campaign can be in one of the following states:
@@ -1611,6 +1772,8 @@ module Aws::Personalize
1611
1772
  # resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
1612
1773
  # resp.solution_version.training_hours #=> Float
1613
1774
  # resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE"
1775
+ # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters #=> Hash
1776
+ # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters["ParameterName"] #=> String
1614
1777
  # resp.solution_version.status #=> String
1615
1778
  # resp.solution_version.failure_reason #=> String
1616
1779
  # resp.solution_version.creation_date_time #=> Time
@@ -1657,6 +1820,56 @@ module Aws::Personalize
1657
1820
  req.send_request(options)
1658
1821
  end
1659
1822
 
1823
+ # Gets a list of the batch inference jobs that have been performed off
1824
+ # of a solution version.
1825
+ #
1826
+ # @option params [String] :solution_version_arn
1827
+ # The Amazon Resource Name (ARN) of the solution version from which the
1828
+ # batch inference jobs were created.
1829
+ #
1830
+ # @option params [String] :next_token
1831
+ # The token to request the next page of results.
1832
+ #
1833
+ # @option params [Integer] :max_results
1834
+ # The maximum number of batch inference job results to return in each
1835
+ # page. The default value is 100.
1836
+ #
1837
+ # @return [Types::ListBatchInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1838
+ #
1839
+ # * {Types::ListBatchInferenceJobsResponse#batch_inference_jobs #batch_inference_jobs} => Array&lt;Types::BatchInferenceJobSummary&gt;
1840
+ # * {Types::ListBatchInferenceJobsResponse#next_token #next_token} => String
1841
+ #
1842
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1843
+ #
1844
+ # @example Request syntax with placeholder values
1845
+ #
1846
+ # resp = client.list_batch_inference_jobs({
1847
+ # solution_version_arn: "Arn",
1848
+ # next_token: "NextToken",
1849
+ # max_results: 1,
1850
+ # })
1851
+ #
1852
+ # @example Response structure
1853
+ #
1854
+ # resp.batch_inference_jobs #=> Array
1855
+ # resp.batch_inference_jobs[0].batch_inference_job_arn #=> String
1856
+ # resp.batch_inference_jobs[0].job_name #=> String
1857
+ # resp.batch_inference_jobs[0].status #=> String
1858
+ # resp.batch_inference_jobs[0].creation_date_time #=> Time
1859
+ # resp.batch_inference_jobs[0].last_updated_date_time #=> Time
1860
+ # resp.batch_inference_jobs[0].failure_reason #=> String
1861
+ # resp.batch_inference_jobs[0].solution_version_arn #=> String
1862
+ # resp.next_token #=> String
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs AWS API Documentation
1865
+ #
1866
+ # @overload list_batch_inference_jobs(params = {})
1867
+ # @param [Hash] params ({})
1868
+ def list_batch_inference_jobs(params = {}, options = {})
1869
+ req = build_request(:list_batch_inference_jobs, params)
1870
+ req.send_request(options)
1871
+ end
1872
+
1660
1873
  # Returns a list of campaigns that use the given solution. When a
1661
1874
  # solution is not specified, all the campaigns associated with the
1662
1875
  # account are listed. The response provides the properties for each
@@ -1680,6 +1893,8 @@ module Aws::Personalize
1680
1893
  # * {Types::ListCampaignsResponse#campaigns #campaigns} => Array&lt;Types::CampaignSummary&gt;
1681
1894
  # * {Types::ListCampaignsResponse#next_token #next_token} => String
1682
1895
  #
1896
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1897
+ #
1683
1898
  # @example Request syntax with placeholder values
1684
1899
  #
1685
1900
  # resp = client.list_campaigns({
@@ -1724,6 +1939,8 @@ module Aws::Personalize
1724
1939
  # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array&lt;Types::DatasetGroupSummary&gt;
1725
1940
  # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
1726
1941
  #
1942
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1943
+ #
1727
1944
  # @example Request syntax with placeholder values
1728
1945
  #
1729
1946
  # resp = client.list_dataset_groups({
@@ -1774,6 +1991,8 @@ module Aws::Personalize
1774
1991
  # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array&lt;Types::DatasetImportJobSummary&gt;
1775
1992
  # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
1776
1993
  #
1994
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1995
+ #
1777
1996
  # @example Request syntax with placeholder values
1778
1997
  #
1779
1998
  # resp = client.list_dataset_import_jobs({
@@ -1823,6 +2042,8 @@ module Aws::Personalize
1823
2042
  # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::DatasetSummary&gt;
1824
2043
  # * {Types::ListDatasetsResponse#next_token #next_token} => String
1825
2044
  #
2045
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2046
+ #
1826
2047
  # @example Request syntax with placeholder values
1827
2048
  #
1828
2049
  # resp = client.list_datasets({
@@ -1871,6 +2092,8 @@ module Aws::Personalize
1871
2092
  # * {Types::ListEventTrackersResponse#event_trackers #event_trackers} => Array&lt;Types::EventTrackerSummary&gt;
1872
2093
  # * {Types::ListEventTrackersResponse#next_token #next_token} => String
1873
2094
  #
2095
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2096
+ #
1874
2097
  # @example Request syntax with placeholder values
1875
2098
  #
1876
2099
  # resp = client.list_event_trackers({
@@ -1917,6 +2140,8 @@ module Aws::Personalize
1917
2140
  # * {Types::ListRecipesResponse#recipes #recipes} => Array&lt;Types::RecipeSummary&gt;
1918
2141
  # * {Types::ListRecipesResponse#next_token #next_token} => String
1919
2142
  #
2143
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2144
+ #
1920
2145
  # @example Request syntax with placeholder values
1921
2146
  #
1922
2147
  # resp = client.list_recipes({
@@ -1960,6 +2185,8 @@ module Aws::Personalize
1960
2185
  # * {Types::ListSchemasResponse#schemas #schemas} => Array&lt;Types::DatasetSchemaSummary&gt;
1961
2186
  # * {Types::ListSchemasResponse#next_token #next_token} => String
1962
2187
  #
2188
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2189
+ #
1963
2190
  # @example Request syntax with placeholder values
1964
2191
  #
1965
2192
  # resp = client.list_schemas({
@@ -2006,6 +2233,8 @@ module Aws::Personalize
2006
2233
  # * {Types::ListSolutionVersionsResponse#solution_versions #solution_versions} => Array&lt;Types::SolutionVersionSummary&gt;
2007
2234
  # * {Types::ListSolutionVersionsResponse#next_token #next_token} => String
2008
2235
  #
2236
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2237
+ #
2009
2238
  # @example Request syntax with placeholder values
2010
2239
  #
2011
2240
  # resp = client.list_solution_versions({
@@ -2054,6 +2283,8 @@ module Aws::Personalize
2054
2283
  # * {Types::ListSolutionsResponse#solutions #solutions} => Array&lt;Types::SolutionSummary&gt;
2055
2284
  # * {Types::ListSolutionsResponse#next_token #next_token} => String
2056
2285
  #
2286
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2287
+ #
2057
2288
  # @example Request syntax with placeholder values
2058
2289
  #
2059
2290
  # resp = client.list_solutions({
@@ -2142,7 +2373,7 @@ module Aws::Personalize
2142
2373
  params: params,
2143
2374
  config: config)
2144
2375
  context[:gem_name] = 'aws-sdk-personalize'
2145
- context[:gem_version] = '1.7.0'
2376
+ context[:gem_version] = '1.12.0'
2146
2377
  Seahorse::Client::Request.new(handlers, context)
2147
2378
  end
2148
2379
 
@@ -19,6 +19,11 @@ module Aws::Personalize
19
19
  AutoMLConfig = Shapes::StructureShape.new(name: 'AutoMLConfig')
20
20
  AutoMLResult = Shapes::StructureShape.new(name: 'AutoMLResult')
21
21
  AvroSchema = Shapes::StringShape.new(name: 'AvroSchema')
22
+ BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
23
+ BatchInferenceJobInput = Shapes::StructureShape.new(name: 'BatchInferenceJobInput')
24
+ BatchInferenceJobOutput = Shapes::StructureShape.new(name: 'BatchInferenceJobOutput')
25
+ BatchInferenceJobSummary = Shapes::StructureShape.new(name: 'BatchInferenceJobSummary')
26
+ BatchInferenceJobs = Shapes::ListShape.new(name: 'BatchInferenceJobs')
22
27
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
23
28
  Campaign = Shapes::StructureShape.new(name: 'Campaign')
24
29
  CampaignSummary = Shapes::StructureShape.new(name: 'CampaignSummary')
@@ -32,6 +37,8 @@ module Aws::Personalize
32
37
  ContinuousHyperParameterRanges = Shapes::ListShape.new(name: 'ContinuousHyperParameterRanges')
33
38
  ContinuousMaxValue = Shapes::FloatShape.new(name: 'ContinuousMaxValue')
34
39
  ContinuousMinValue = Shapes::FloatShape.new(name: 'ContinuousMinValue')
40
+ CreateBatchInferenceJobRequest = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobRequest')
41
+ CreateBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobResponse')
35
42
  CreateCampaignRequest = Shapes::StructureShape.new(name: 'CreateCampaignRequest')
36
43
  CreateCampaignResponse = Shapes::StructureShape.new(name: 'CreateCampaignResponse')
37
44
  CreateDatasetGroupRequest = Shapes::StructureShape.new(name: 'CreateDatasetGroupRequest')
@@ -77,6 +84,8 @@ module Aws::Personalize
77
84
  DeleteSolutionRequest = Shapes::StructureShape.new(name: 'DeleteSolutionRequest')
78
85
  DescribeAlgorithmRequest = Shapes::StructureShape.new(name: 'DescribeAlgorithmRequest')
79
86
  DescribeAlgorithmResponse = Shapes::StructureShape.new(name: 'DescribeAlgorithmResponse')
87
+ DescribeBatchInferenceJobRequest = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobRequest')
88
+ DescribeBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobResponse')
80
89
  DescribeCampaignRequest = Shapes::StructureShape.new(name: 'DescribeCampaignRequest')
81
90
  DescribeCampaignResponse = Shapes::StructureShape.new(name: 'DescribeCampaignResponse')
82
91
  DescribeDatasetGroupRequest = Shapes::StructureShape.new(name: 'DescribeDatasetGroupRequest')
@@ -126,6 +135,8 @@ module Aws::Personalize
126
135
  InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
127
136
  KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
128
137
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
138
+ ListBatchInferenceJobsRequest = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsRequest')
139
+ ListBatchInferenceJobsResponse = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsResponse')
129
140
  ListCampaignsRequest = Shapes::StructureShape.new(name: 'ListCampaignsRequest')
130
141
  ListCampaignsResponse = Shapes::StructureShape.new(name: 'ListCampaignsResponse')
131
142
  ListDatasetGroupsRequest = Shapes::StructureShape.new(name: 'ListDatasetGroupsRequest')
@@ -151,6 +162,7 @@ module Aws::Personalize
151
162
  Metrics = Shapes::MapShape.new(name: 'Metrics')
152
163
  Name = Shapes::StringShape.new(name: 'Name')
153
164
  NextToken = Shapes::StringShape.new(name: 'NextToken')
165
+ NumBatchResults = Shapes::IntegerShape.new(name: 'NumBatchResults')
154
166
  ParameterName = Shapes::StringShape.new(name: 'ParameterName')
155
167
  ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
156
168
  PerformAutoML = Shapes::BooleanShape.new(name: 'PerformAutoML')
@@ -165,6 +177,7 @@ module Aws::Personalize
165
177
  ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
166
178
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
167
179
  RoleArn = Shapes::StringShape.new(name: 'RoleArn')
180
+ S3DataConfig = Shapes::StructureShape.new(name: 'S3DataConfig')
168
181
  S3Location = Shapes::StringShape.new(name: 'S3Location')
169
182
  Schemas = Shapes::ListShape.new(name: 'Schemas')
170
183
  Solution = Shapes::StructureShape.new(name: 'Solution')
@@ -181,6 +194,7 @@ module Aws::Personalize
181
194
  TrainingMode = Shapes::StringShape.new(name: 'TrainingMode')
182
195
  TransactionsPerSecond = Shapes::IntegerShape.new(name: 'TransactionsPerSecond')
183
196
  Tunable = Shapes::BooleanShape.new(name: 'Tunable')
197
+ TunedHPOParams = Shapes::StructureShape.new(name: 'TunedHPOParams')
184
198
  UpdateCampaignRequest = Shapes::StructureShape.new(name: 'UpdateCampaignRequest')
185
199
  UpdateCampaignResponse = Shapes::StructureShape.new(name: 'UpdateCampaignResponse')
186
200
 
@@ -209,6 +223,36 @@ module Aws::Personalize
209
223
  AutoMLResult.add_member(:best_recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "bestRecipeArn"))
210
224
  AutoMLResult.struct_class = Types::AutoMLResult
211
225
 
226
+ BatchInferenceJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
227
+ BatchInferenceJob.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
228
+ BatchInferenceJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
229
+ BatchInferenceJob.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
230
+ BatchInferenceJob.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
231
+ BatchInferenceJob.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, location_name: "jobInput"))
232
+ BatchInferenceJob.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, location_name: "jobOutput"))
233
+ BatchInferenceJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
234
+ BatchInferenceJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
235
+ BatchInferenceJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
236
+ BatchInferenceJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
237
+ BatchInferenceJob.struct_class = Types::BatchInferenceJob
238
+
239
+ BatchInferenceJobInput.add_member(:s3_data_source, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataSource"))
240
+ BatchInferenceJobInput.struct_class = Types::BatchInferenceJobInput
241
+
242
+ BatchInferenceJobOutput.add_member(:s3_data_destination, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataDestination"))
243
+ BatchInferenceJobOutput.struct_class = Types::BatchInferenceJobOutput
244
+
245
+ BatchInferenceJobSummary.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
246
+ BatchInferenceJobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
247
+ BatchInferenceJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
248
+ BatchInferenceJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
249
+ BatchInferenceJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
250
+ BatchInferenceJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
251
+ BatchInferenceJobSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
252
+ BatchInferenceJobSummary.struct_class = Types::BatchInferenceJobSummary
253
+
254
+ BatchInferenceJobs.member = Shapes::ShapeRef.new(shape: BatchInferenceJobSummary)
255
+
212
256
  Campaign.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
213
257
  Campaign.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
214
258
  Campaign.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
@@ -253,6 +297,17 @@ module Aws::Personalize
253
297
 
254
298
  ContinuousHyperParameterRanges.member = Shapes::ShapeRef.new(shape: ContinuousHyperParameterRange)
255
299
 
300
+ CreateBatchInferenceJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
301
+ CreateBatchInferenceJobRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
302
+ CreateBatchInferenceJobRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
303
+ CreateBatchInferenceJobRequest.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, required: true, location_name: "jobInput"))
304
+ CreateBatchInferenceJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, required: true, location_name: "jobOutput"))
305
+ CreateBatchInferenceJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
306
+ CreateBatchInferenceJobRequest.struct_class = Types::CreateBatchInferenceJobRequest
307
+
308
+ CreateBatchInferenceJobResponse.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
309
+ CreateBatchInferenceJobResponse.struct_class = Types::CreateBatchInferenceJobResponse
310
+
256
311
  CreateCampaignRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
257
312
  CreateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
258
313
  CreateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, required: true, location_name: "minProvisionedTPS"))
@@ -450,6 +505,12 @@ module Aws::Personalize
450
505
  DescribeAlgorithmResponse.add_member(:algorithm, Shapes::ShapeRef.new(shape: Algorithm, location_name: "algorithm"))
451
506
  DescribeAlgorithmResponse.struct_class = Types::DescribeAlgorithmResponse
452
507
 
508
+ DescribeBatchInferenceJobRequest.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "batchInferenceJobArn"))
509
+ DescribeBatchInferenceJobRequest.struct_class = Types::DescribeBatchInferenceJobRequest
510
+
511
+ DescribeBatchInferenceJobResponse.add_member(:batch_inference_job, Shapes::ShapeRef.new(shape: BatchInferenceJob, location_name: "batchInferenceJob"))
512
+ DescribeBatchInferenceJobResponse.struct_class = Types::DescribeBatchInferenceJobResponse
513
+
453
514
  DescribeCampaignRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
454
515
  DescribeCampaignRequest.struct_class = Types::DescribeCampaignRequest
455
516
 
@@ -588,6 +649,15 @@ module Aws::Personalize
588
649
  LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
589
650
  LimitExceededException.struct_class = Types::LimitExceededException
590
651
 
652
+ ListBatchInferenceJobsRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
653
+ ListBatchInferenceJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
654
+ ListBatchInferenceJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
655
+ ListBatchInferenceJobsRequest.struct_class = Types::ListBatchInferenceJobsRequest
656
+
657
+ ListBatchInferenceJobsResponse.add_member(:batch_inference_jobs, Shapes::ShapeRef.new(shape: BatchInferenceJobs, location_name: "batchInferenceJobs"))
658
+ ListBatchInferenceJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
659
+ ListBatchInferenceJobsResponse.struct_class = Types::ListBatchInferenceJobsResponse
660
+
591
661
  ListCampaignsRequest.add_member(:solution_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionArn"))
592
662
  ListCampaignsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
593
663
  ListCampaignsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -702,6 +772,10 @@ module Aws::Personalize
702
772
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
703
773
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
704
774
 
775
+ S3DataConfig.add_member(:path, Shapes::ShapeRef.new(shape: S3Location, required: true, location_name: "path"))
776
+ S3DataConfig.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
777
+ S3DataConfig.struct_class = Types::S3DataConfig
778
+
705
779
  Schemas.member = Shapes::ShapeRef.new(shape: DatasetSchemaSummary)
706
780
 
707
781
  Solution.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -743,6 +817,7 @@ module Aws::Personalize
743
817
  SolutionVersion.add_member(:solution_config, Shapes::ShapeRef.new(shape: SolutionConfig, location_name: "solutionConfig"))
744
818
  SolutionVersion.add_member(:training_hours, Shapes::ShapeRef.new(shape: TrainingHours, location_name: "trainingHours"))
745
819
  SolutionVersion.add_member(:training_mode, Shapes::ShapeRef.new(shape: TrainingMode, location_name: "trainingMode"))
820
+ SolutionVersion.add_member(:tuned_hpo_params, Shapes::ShapeRef.new(shape: TunedHPOParams, location_name: "tunedHPOParams"))
746
821
  SolutionVersion.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
747
822
  SolutionVersion.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
748
823
  SolutionVersion.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
@@ -760,6 +835,9 @@ module Aws::Personalize
760
835
 
761
836
  Solutions.member = Shapes::ShapeRef.new(shape: SolutionSummary)
762
837
 
838
+ TunedHPOParams.add_member(:algorithm_hyper_parameters, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "algorithmHyperParameters"))
839
+ TunedHPOParams.struct_class = Types::TunedHPOParams
840
+
763
841
  UpdateCampaignRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
764
842
  UpdateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
765
843
  UpdateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minProvisionedTPS"))
@@ -787,6 +865,19 @@ module Aws::Personalize
787
865
  "uid" => "personalize-2018-05-22",
788
866
  }
789
867
 
868
+ api.add_operation(:create_batch_inference_job, Seahorse::Model::Operation.new.tap do |o|
869
+ o.name = "CreateBatchInferenceJob"
870
+ o.http_method = "POST"
871
+ o.http_request_uri = "/"
872
+ o.input = Shapes::ShapeRef.new(shape: CreateBatchInferenceJobRequest)
873
+ o.output = Shapes::ShapeRef.new(shape: CreateBatchInferenceJobResponse)
874
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
875
+ o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
876
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
877
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
878
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
879
+ end)
880
+
790
881
  api.add_operation(:create_campaign, Seahorse::Model::Operation.new.tap do |o|
791
882
  o.name = "CreateCampaign"
792
883
  o.http_method = "POST"
@@ -961,6 +1052,16 @@ module Aws::Personalize
961
1052
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
962
1053
  end)
963
1054
 
1055
+ api.add_operation(:describe_batch_inference_job, Seahorse::Model::Operation.new.tap do |o|
1056
+ o.name = "DescribeBatchInferenceJob"
1057
+ o.http_method = "POST"
1058
+ o.http_request_uri = "/"
1059
+ o.input = Shapes::ShapeRef.new(shape: DescribeBatchInferenceJobRequest)
1060
+ o.output = Shapes::ShapeRef.new(shape: DescribeBatchInferenceJobResponse)
1061
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1062
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1063
+ end)
1064
+
964
1065
  api.add_operation(:describe_campaign, Seahorse::Model::Operation.new.tap do |o|
965
1066
  o.name = "DescribeCampaign"
966
1067
  o.http_method = "POST"
@@ -1072,6 +1173,22 @@ module Aws::Personalize
1072
1173
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1073
1174
  end)
1074
1175
 
1176
+ api.add_operation(:list_batch_inference_jobs, Seahorse::Model::Operation.new.tap do |o|
1177
+ o.name = "ListBatchInferenceJobs"
1178
+ o.http_method = "POST"
1179
+ o.http_request_uri = "/"
1180
+ o.input = Shapes::ShapeRef.new(shape: ListBatchInferenceJobsRequest)
1181
+ o.output = Shapes::ShapeRef.new(shape: ListBatchInferenceJobsResponse)
1182
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1183
+ o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
1184
+ o[:pager] = Aws::Pager.new(
1185
+ limit_key: "max_results",
1186
+ tokens: {
1187
+ "next_token" => "next_token"
1188
+ }
1189
+ )
1190
+ end)
1191
+
1075
1192
  api.add_operation(:list_campaigns, Seahorse::Model::Operation.new.tap do |o|
1076
1193
  o.name = "ListCampaigns"
1077
1194
  o.http_method = "POST"
@@ -6,6 +6,34 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Personalize
9
+
10
+ # When Personalize returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Personalize::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Personalize errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Personalize::Errors::ServiceError
18
+ # # rescues all Personalize API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {InvalidInputException}
29
+ # * {InvalidNextTokenException}
30
+ # * {LimitExceededException}
31
+ # * {ResourceAlreadyExistsException}
32
+ # * {ResourceInUseException}
33
+ # * {ResourceNotFoundException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
9
37
  module Errors
10
38
 
11
39
  extend Aws::Errors::DynamicErrors
@@ -23,7 +51,6 @@ module Aws::Personalize
23
51
  def message
24
52
  @message || @data[:message]
25
53
  end
26
-
27
54
  end
28
55
 
29
56
  class InvalidNextTokenException < ServiceError
@@ -39,7 +66,6 @@ module Aws::Personalize
39
66
  def message
40
67
  @message || @data[:message]
41
68
  end
42
-
43
69
  end
44
70
 
45
71
  class LimitExceededException < ServiceError
@@ -55,7 +81,6 @@ module Aws::Personalize
55
81
  def message
56
82
  @message || @data[:message]
57
83
  end
58
-
59
84
  end
60
85
 
61
86
  class ResourceAlreadyExistsException < ServiceError
@@ -71,7 +96,6 @@ module Aws::Personalize
71
96
  def message
72
97
  @message || @data[:message]
73
98
  end
74
-
75
99
  end
76
100
 
77
101
  class ResourceInUseException < ServiceError
@@ -87,7 +111,6 @@ module Aws::Personalize
87
111
  def message
88
112
  @message || @data[:message]
89
113
  end
90
-
91
114
  end
92
115
 
93
116
  class ResourceNotFoundException < ServiceError
@@ -103,7 +126,6 @@ module Aws::Personalize
103
126
  def message
104
127
  @message || @data[:message]
105
128
  end
106
-
107
129
  end
108
130
 
109
131
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Personalize
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -132,6 +132,187 @@ module Aws::Personalize
132
132
  include Aws::Structure
133
133
  end
134
134
 
135
+ # Contains information on a batch inference job.
136
+ #
137
+ # @!attribute [rw] job_name
138
+ # The name of the batch inference job.
139
+ # @return [String]
140
+ #
141
+ # @!attribute [rw] batch_inference_job_arn
142
+ # The Amazon Resource Name (ARN) of the batch inference job.
143
+ # @return [String]
144
+ #
145
+ # @!attribute [rw] failure_reason
146
+ # If the batch inference job failed, the reason for the failure.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] solution_version_arn
150
+ # The Amazon Resource Name (ARN) of the solution version from which
151
+ # the batch inference job was created.
152
+ # @return [String]
153
+ #
154
+ # @!attribute [rw] num_results
155
+ # The number of recommendations generated by the batch inference job.
156
+ # This number includes the error messages generated for failed input
157
+ # records.
158
+ # @return [Integer]
159
+ #
160
+ # @!attribute [rw] job_input
161
+ # The Amazon S3 path that leads to the input data used to generate the
162
+ # batch inference job.
163
+ # @return [Types::BatchInferenceJobInput]
164
+ #
165
+ # @!attribute [rw] job_output
166
+ # The Amazon S3 bucket that contains the output data generated by the
167
+ # batch inference job.
168
+ # @return [Types::BatchInferenceJobOutput]
169
+ #
170
+ # @!attribute [rw] role_arn
171
+ # The ARN of the Amazon Identity and Access Management (IAM) role that
172
+ # requested the batch inference job.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] status
176
+ # The status of the batch inference job. The status is one of the
177
+ # following values:
178
+ #
179
+ # * PENDING
180
+ #
181
+ # * IN PROGRESS
182
+ #
183
+ # * ACTIVE
184
+ #
185
+ # * CREATE FAILED
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] creation_date_time
189
+ # The time at which the batch inference job was created.
190
+ # @return [Time]
191
+ #
192
+ # @!attribute [rw] last_updated_date_time
193
+ # The time at which the batch inference job was last updated.
194
+ # @return [Time]
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJob AWS API Documentation
197
+ #
198
+ class BatchInferenceJob < Struct.new(
199
+ :job_name,
200
+ :batch_inference_job_arn,
201
+ :failure_reason,
202
+ :solution_version_arn,
203
+ :num_results,
204
+ :job_input,
205
+ :job_output,
206
+ :role_arn,
207
+ :status,
208
+ :creation_date_time,
209
+ :last_updated_date_time)
210
+ include Aws::Structure
211
+ end
212
+
213
+ # The input configuration of a batch inference job.
214
+ #
215
+ # @note When making an API call, you may pass BatchInferenceJobInput
216
+ # data as a hash:
217
+ #
218
+ # {
219
+ # s3_data_source: { # required
220
+ # path: "S3Location", # required
221
+ # kms_key_arn: "KmsKeyArn",
222
+ # },
223
+ # }
224
+ #
225
+ # @!attribute [rw] s3_data_source
226
+ # The URI of the Amazon S3 location that contains your input data. The
227
+ # Amazon S3 bucket must be in the same region as the API endpoint you
228
+ # are calling.
229
+ # @return [Types::S3DataConfig]
230
+ #
231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobInput AWS API Documentation
232
+ #
233
+ class BatchInferenceJobInput < Struct.new(
234
+ :s3_data_source)
235
+ include Aws::Structure
236
+ end
237
+
238
+ # The output configuration parameters of a batch inference job.
239
+ #
240
+ # @note When making an API call, you may pass BatchInferenceJobOutput
241
+ # data as a hash:
242
+ #
243
+ # {
244
+ # s3_data_destination: { # required
245
+ # path: "S3Location", # required
246
+ # kms_key_arn: "KmsKeyArn",
247
+ # },
248
+ # }
249
+ #
250
+ # @!attribute [rw] s3_data_destination
251
+ # Information on the Amazon S3 bucket in which the batch inference
252
+ # job's output is stored.
253
+ # @return [Types::S3DataConfig]
254
+ #
255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobOutput AWS API Documentation
256
+ #
257
+ class BatchInferenceJobOutput < Struct.new(
258
+ :s3_data_destination)
259
+ include Aws::Structure
260
+ end
261
+
262
+ # A truncated version of the BatchInferenceJob datatype. The
263
+ # ListBatchInferenceJobs operation returns a list of batch inference job
264
+ # summaries.
265
+ #
266
+ # @!attribute [rw] batch_inference_job_arn
267
+ # The Amazon Resource Name (ARN) of the batch inference job.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] job_name
271
+ # The name of the batch inference job.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] status
275
+ # The status of the batch inference job. The status is one of the
276
+ # following values:
277
+ #
278
+ # * PENDING
279
+ #
280
+ # * IN PROGRESS
281
+ #
282
+ # * ACTIVE
283
+ #
284
+ # * CREATE FAILED
285
+ # @return [String]
286
+ #
287
+ # @!attribute [rw] creation_date_time
288
+ # The time at which the batch inference job was created.
289
+ # @return [Time]
290
+ #
291
+ # @!attribute [rw] last_updated_date_time
292
+ # The time at which the batch inference job was last updated.
293
+ # @return [Time]
294
+ #
295
+ # @!attribute [rw] failure_reason
296
+ # If the batch inference job failed, the reason for the failure.
297
+ # @return [String]
298
+ #
299
+ # @!attribute [rw] solution_version_arn
300
+ # The ARN of the solution version used by the batch inference job.
301
+ # @return [String]
302
+ #
303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobSummary AWS API Documentation
304
+ #
305
+ class BatchInferenceJobSummary < Struct.new(
306
+ :batch_inference_job_arn,
307
+ :job_name,
308
+ :status,
309
+ :creation_date_time,
310
+ :last_updated_date_time,
311
+ :failure_reason,
312
+ :solution_version_arn)
313
+ include Aws::Structure
314
+ end
315
+
135
316
  # Describes a deployed solution version, otherwise known as a campaign.
136
317
  # For more information on campaigns, see CreateCampaign.
137
318
  #
@@ -350,6 +531,80 @@ module Aws::Personalize
350
531
  include Aws::Structure
351
532
  end
352
533
 
534
+ # @note When making an API call, you may pass CreateBatchInferenceJobRequest
535
+ # data as a hash:
536
+ #
537
+ # {
538
+ # job_name: "Name", # required
539
+ # solution_version_arn: "Arn", # required
540
+ # num_results: 1,
541
+ # job_input: { # required
542
+ # s3_data_source: { # required
543
+ # path: "S3Location", # required
544
+ # kms_key_arn: "KmsKeyArn",
545
+ # },
546
+ # },
547
+ # job_output: { # required
548
+ # s3_data_destination: { # required
549
+ # path: "S3Location", # required
550
+ # kms_key_arn: "KmsKeyArn",
551
+ # },
552
+ # },
553
+ # role_arn: "RoleArn", # required
554
+ # }
555
+ #
556
+ # @!attribute [rw] job_name
557
+ # The name of the batch inference job to create.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] solution_version_arn
561
+ # The Amazon Resource Name (ARN) of the solution version that will be
562
+ # used to generate the batch inference recommendations.
563
+ # @return [String]
564
+ #
565
+ # @!attribute [rw] num_results
566
+ # The number of recommendations to retreive.
567
+ # @return [Integer]
568
+ #
569
+ # @!attribute [rw] job_input
570
+ # The Amazon S3 path that leads to the input file to base your
571
+ # recommendations on. The input material must be in JSON format.
572
+ # @return [Types::BatchInferenceJobInput]
573
+ #
574
+ # @!attribute [rw] job_output
575
+ # The path to the Amazon S3 bucket where the job's output will be
576
+ # stored.
577
+ # @return [Types::BatchInferenceJobOutput]
578
+ #
579
+ # @!attribute [rw] role_arn
580
+ # The ARN of the Amazon Identity and Access Management role that has
581
+ # permissions to read and write to your input and out Amazon S3
582
+ # buckets respectively.
583
+ # @return [String]
584
+ #
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
586
+ #
587
+ class CreateBatchInferenceJobRequest < Struct.new(
588
+ :job_name,
589
+ :solution_version_arn,
590
+ :num_results,
591
+ :job_input,
592
+ :job_output,
593
+ :role_arn)
594
+ include Aws::Structure
595
+ end
596
+
597
+ # @!attribute [rw] batch_inference_job_arn
598
+ # The ARN of the batch inference job.
599
+ # @return [String]
600
+ #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobResponse AWS API Documentation
602
+ #
603
+ class CreateBatchInferenceJobResponse < Struct.new(
604
+ :batch_inference_job_arn)
605
+ include Aws::Structure
606
+ end
607
+
353
608
  # @note When making an API call, you may pass CreateCampaignRequest
354
609
  # data as a hash:
355
610
  #
@@ -1480,6 +1735,35 @@ module Aws::Personalize
1480
1735
  include Aws::Structure
1481
1736
  end
1482
1737
 
1738
+ # @note When making an API call, you may pass DescribeBatchInferenceJobRequest
1739
+ # data as a hash:
1740
+ #
1741
+ # {
1742
+ # batch_inference_job_arn: "Arn", # required
1743
+ # }
1744
+ #
1745
+ # @!attribute [rw] batch_inference_job_arn
1746
+ # The ARN of the batch inference job to describe.
1747
+ # @return [String]
1748
+ #
1749
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJobRequest AWS API Documentation
1750
+ #
1751
+ class DescribeBatchInferenceJobRequest < Struct.new(
1752
+ :batch_inference_job_arn)
1753
+ include Aws::Structure
1754
+ end
1755
+
1756
+ # @!attribute [rw] batch_inference_job
1757
+ # Information on the specified batch inference job.
1758
+ # @return [Types::BatchInferenceJob]
1759
+ #
1760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJobResponse AWS API Documentation
1761
+ #
1762
+ class DescribeBatchInferenceJobResponse < Struct.new(
1763
+ :batch_inference_job)
1764
+ include Aws::Structure
1765
+ end
1766
+
1483
1767
  # @note When making an API call, you may pass DescribeCampaignRequest
1484
1768
  # data as a hash:
1485
1769
  #
@@ -2045,7 +2329,7 @@ module Aws::Personalize
2045
2329
  # }
2046
2330
  #
2047
2331
  # @!attribute [rw] type
2048
- # The data type of the metric.
2332
+ # The type of the metric. Valid values are `Maximize` and `Minimize`.
2049
2333
  # @return [String]
2050
2334
  #
2051
2335
  # @!attribute [rw] metric_name
@@ -2214,6 +2498,55 @@ module Aws::Personalize
2214
2498
  include Aws::Structure
2215
2499
  end
2216
2500
 
2501
+ # @note When making an API call, you may pass ListBatchInferenceJobsRequest
2502
+ # data as a hash:
2503
+ #
2504
+ # {
2505
+ # solution_version_arn: "Arn",
2506
+ # next_token: "NextToken",
2507
+ # max_results: 1,
2508
+ # }
2509
+ #
2510
+ # @!attribute [rw] solution_version_arn
2511
+ # The Amazon Resource Name (ARN) of the solution version from which
2512
+ # the batch inference jobs were created.
2513
+ # @return [String]
2514
+ #
2515
+ # @!attribute [rw] next_token
2516
+ # The token to request the next page of results.
2517
+ # @return [String]
2518
+ #
2519
+ # @!attribute [rw] max_results
2520
+ # The maximum number of batch inference job results to return in each
2521
+ # page. The default value is 100.
2522
+ # @return [Integer]
2523
+ #
2524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobsRequest AWS API Documentation
2525
+ #
2526
+ class ListBatchInferenceJobsRequest < Struct.new(
2527
+ :solution_version_arn,
2528
+ :next_token,
2529
+ :max_results)
2530
+ include Aws::Structure
2531
+ end
2532
+
2533
+ # @!attribute [rw] batch_inference_jobs
2534
+ # A list containing information on each job that is returned.
2535
+ # @return [Array<Types::BatchInferenceJobSummary>]
2536
+ #
2537
+ # @!attribute [rw] next_token
2538
+ # The token to use to retreive the next page of results. The value is
2539
+ # `null` when there are no more results to return.
2540
+ # @return [String]
2541
+ #
2542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobsResponse AWS API Documentation
2543
+ #
2544
+ class ListBatchInferenceJobsResponse < Struct.new(
2545
+ :batch_inference_jobs,
2546
+ :next_token)
2547
+ include Aws::Structure
2548
+ end
2549
+
2217
2550
  # @note When making an API call, you may pass ListCampaignsRequest
2218
2551
  # data as a hash:
2219
2552
  #
@@ -2764,6 +3097,34 @@ module Aws::Personalize
2764
3097
  include Aws::Structure
2765
3098
  end
2766
3099
 
3100
+ # The configuration details of an Amazon S3 input or output bucket.
3101
+ #
3102
+ # @note When making an API call, you may pass S3DataConfig
3103
+ # data as a hash:
3104
+ #
3105
+ # {
3106
+ # path: "S3Location", # required
3107
+ # kms_key_arn: "KmsKeyArn",
3108
+ # }
3109
+ #
3110
+ # @!attribute [rw] path
3111
+ # The file path of the Amazon S3 bucket.
3112
+ # @return [String]
3113
+ #
3114
+ # @!attribute [rw] kms_key_arn
3115
+ # The Amazon Resource Name (ARN) of the Amazon Key Management Service
3116
+ # (KMS) key that Amazon Personalize uses to encrypt or decrypt the
3117
+ # input and output files of a batch inference job.
3118
+ # @return [String]
3119
+ #
3120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/S3DataConfig AWS API Documentation
3121
+ #
3122
+ class S3DataConfig < Struct.new(
3123
+ :path,
3124
+ :kms_key_arn)
3125
+ include Aws::Structure
3126
+ end
3127
+
2767
3128
  # An object that provides information about a solution. A solution is a
2768
3129
  # trained model that can be deployed as a campaign.
2769
3130
  #
@@ -2910,9 +3271,7 @@ module Aws::Personalize
2910
3271
  # @return [String]
2911
3272
  #
2912
3273
  # @!attribute [rw] hpo_config
2913
- # Describes the properties for hyperparameter optimization (HPO). For
2914
- # use with the bring-your-own-recipe feature. Not used with Amazon
2915
- # Personalize predefined recipes.
3274
+ # Describes the properties for hyperparameter optimization (HPO).
2916
3275
  # @return [Types::HPOConfig]
2917
3276
  #
2918
3277
  # @!attribute [rw] algorithm_hyper_parameters
@@ -3040,6 +3399,11 @@ module Aws::Personalize
3040
3399
  # uses the native-recipe-hrnn-coldstart.
3041
3400
  # @return [String]
3042
3401
  #
3402
+ # @!attribute [rw] tuned_hpo_params
3403
+ # If hyperparameter optimization was performed, contains the
3404
+ # hyperparameter values of the best performing model.
3405
+ # @return [Types::TunedHPOParams]
3406
+ #
3043
3407
  # @!attribute [rw] status
3044
3408
  # The status of the solution version.
3045
3409
  #
@@ -3080,6 +3444,7 @@ module Aws::Personalize
3080
3444
  :solution_config,
3081
3445
  :training_hours,
3082
3446
  :training_mode,
3447
+ :tuned_hpo_params,
3083
3448
  :status,
3084
3449
  :failure_reason,
3085
3450
  :creation_date_time,
@@ -3130,6 +3495,20 @@ module Aws::Personalize
3130
3495
  include Aws::Structure
3131
3496
  end
3132
3497
 
3498
+ # If hyperparameter optimization (HPO) was performed, contains the
3499
+ # hyperparameter values of the best performing model.
3500
+ #
3501
+ # @!attribute [rw] algorithm_hyper_parameters
3502
+ # A list of the hyperparameter values of the best performing model.
3503
+ # @return [Hash<String,String>]
3504
+ #
3505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TunedHPOParams AWS API Documentation
3506
+ #
3507
+ class TunedHPOParams < Struct.new(
3508
+ :algorithm_hyper_parameters)
3509
+ include Aws::Structure
3510
+ end
3511
+
3133
3512
  # @note When making an API call, you may pass UpdateCampaignRequest
3134
3513
  # data as a hash:
3135
3514
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalize
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.7.0
4
+ version: 1.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-23 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon Personalize