aws-sdk-personalize 1.8.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: b196ccf4986516a8f46f5a7faa06e234e28d46ff
4
- data.tar.gz: 5275e41401ce4a37f0285eb86898aec1b726ba78
2
+ SHA256:
3
+ metadata.gz: 366385df0d7899098cab3a61939b22572e20453efc9aa039a85807222bdee51a
4
+ data.tar.gz: e7f5448deecd704482dd8c0357796e50d760bd543d0f7b5ece832fcb0bf38613
5
5
  SHA512:
6
- metadata.gz: f98345f7b5937f212252cf1e984873d4bb9724191ea3fe0ae3c90c9127b8be1a15d58081284ad93b3bb9acafd35ec38c19affbb11c52482bc2379e5ba178323c
7
- data.tar.gz: ae5eec4fba2d788f2284fe64dfa19b5722fe4589eacb1068d07f0fcd3a5a7ea2275ceda2e4b09498d66d928fbb247692dacede8610c9aca48ed1396ee36b7f9c
6
+ metadata.gz: 97a29b9597b0974b380dedf461724232ec25f93df603ec6c9633dfa6d44edf64bf3bc490c81072b4b5cbc9dbbd295edffcb18a1e3766fbdf2234429465986b80
7
+ data.tar.gz: dc40a08c959f6599b053a7637e7f3f59e2613db1650d491c5fb0c0749902179f7c3c199d23acef539e19899e325c447c5c73a17072fb8a185525cfe9b987f366
@@ -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.8.0'
48
+ GEM_VERSION = '1.13.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`.
@@ -275,6 +329,11 @@ module Aws::Personalize
275
329
  # The Amazon Resource Name (ARN) of the solution version that will be
276
330
  # used to generate the batch inference recommendations.
277
331
  #
332
+ # @option params [String] :filter_arn
333
+ # The ARN of the filter to apply to the batch inference job. For more
334
+ # information on using filters, see Using Filters with Amazon
335
+ # Personalize.
336
+ #
278
337
  # @option params [Integer] :num_results
279
338
  # The number of recommendations to retreive.
280
339
  #
@@ -300,6 +359,7 @@ module Aws::Personalize
300
359
  # resp = client.create_batch_inference_job({
301
360
  # job_name: "Name", # required
302
361
  # solution_version_arn: "Arn", # required
362
+ # filter_arn: "Arn",
303
363
  # num_results: 1,
304
364
  # job_input: { # required
305
365
  # s3_data_source: { # required
@@ -736,6 +796,52 @@ module Aws::Personalize
736
796
  req.send_request(options)
737
797
  end
738
798
 
799
+ # Creates a recommendation filter. For more information, see Using
800
+ # Filters with Amazon Personalize.
801
+ #
802
+ # @option params [required, String] :name
803
+ # The name of the filter to create.
804
+ #
805
+ # @option params [required, String] :dataset_group_arn
806
+ # The ARN of the dataset group that the filter will belong to.
807
+ #
808
+ # @option params [required, String] :filter_expression
809
+ # The filter expression that designates the interaction types that the
810
+ # filter will filter out. A filter expression must follow the following
811
+ # format:
812
+ #
813
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
814
+ #
815
+ # Where "EVENT\_TYPE" is the type of event to filter out. To filter
816
+ # out all items with any interactions history, set `"*"` as the
817
+ # EVENT\_TYPE. For more information, see Using Filters with Amazon
818
+ # Personalize.
819
+ #
820
+ # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
821
+ #
822
+ # * {Types::CreateFilterResponse#filter_arn #filter_arn} => String
823
+ #
824
+ # @example Request syntax with placeholder values
825
+ #
826
+ # resp = client.create_filter({
827
+ # name: "Name", # required
828
+ # dataset_group_arn: "Arn", # required
829
+ # filter_expression: "FilterExpression", # required
830
+ # })
831
+ #
832
+ # @example Response structure
833
+ #
834
+ # resp.filter_arn #=> String
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilter AWS API Documentation
837
+ #
838
+ # @overload create_filter(params = {})
839
+ # @param [Hash] params ({})
840
+ def create_filter(params = {}, options = {})
841
+ req = build_request(:create_filter, params)
842
+ req.send_request(options)
843
+ end
844
+
739
845
  # Creates an Amazon Personalize schema from the specified schema string.
740
846
  # The schema you create must be in Avro JSON format.
741
847
  #
@@ -1127,6 +1233,28 @@ module Aws::Personalize
1127
1233
  req.send_request(options)
1128
1234
  end
1129
1235
 
1236
+ # Deletes a filter.
1237
+ #
1238
+ # @option params [required, String] :filter_arn
1239
+ # The ARN of the filter to delete.
1240
+ #
1241
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1242
+ #
1243
+ # @example Request syntax with placeholder values
1244
+ #
1245
+ # resp = client.delete_filter({
1246
+ # filter_arn: "Arn", # required
1247
+ # })
1248
+ #
1249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilter AWS API Documentation
1250
+ #
1251
+ # @overload delete_filter(params = {})
1252
+ # @param [Hash] params ({})
1253
+ def delete_filter(params = {}, options = {})
1254
+ req = build_request(:delete_filter, params)
1255
+ req.send_request(options)
1256
+ end
1257
+
1130
1258
  # Deletes a schema. Before deleting a schema, you must delete all
1131
1259
  # datasets referencing the schema. For more information on schemas, see
1132
1260
  # CreateSchema.
@@ -1254,6 +1382,7 @@ module Aws::Personalize
1254
1382
  #
1255
1383
  # resp.batch_inference_job.job_name #=> String
1256
1384
  # resp.batch_inference_job.batch_inference_job_arn #=> String
1385
+ # resp.batch_inference_job.filter_arn #=> String
1257
1386
  # resp.batch_inference_job.failure_reason #=> String
1258
1387
  # resp.batch_inference_job.solution_version_arn #=> String
1259
1388
  # resp.batch_inference_job.num_results #=> Integer
@@ -1509,6 +1638,41 @@ module Aws::Personalize
1509
1638
  req.send_request(options)
1510
1639
  end
1511
1640
 
1641
+ # Describes a filter's properties.
1642
+ #
1643
+ # @option params [required, String] :filter_arn
1644
+ # The ARN of the filter to describe.
1645
+ #
1646
+ # @return [Types::DescribeFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1647
+ #
1648
+ # * {Types::DescribeFilterResponse#filter #filter} => Types::Filter
1649
+ #
1650
+ # @example Request syntax with placeholder values
1651
+ #
1652
+ # resp = client.describe_filter({
1653
+ # filter_arn: "Arn", # required
1654
+ # })
1655
+ #
1656
+ # @example Response structure
1657
+ #
1658
+ # resp.filter.name #=> String
1659
+ # resp.filter.filter_arn #=> String
1660
+ # resp.filter.creation_date_time #=> Time
1661
+ # resp.filter.last_updated_date_time #=> Time
1662
+ # resp.filter.dataset_group_arn #=> String
1663
+ # resp.filter.failure_reason #=> String
1664
+ # resp.filter.filter_expression #=> String
1665
+ # resp.filter.status #=> String
1666
+ #
1667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilter AWS API Documentation
1668
+ #
1669
+ # @overload describe_filter(params = {})
1670
+ # @param [Hash] params ({})
1671
+ def describe_filter(params = {}, options = {})
1672
+ req = build_request(:describe_filter, params)
1673
+ req.send_request(options)
1674
+ end
1675
+
1512
1676
  # Describes a recipe.
1513
1677
  #
1514
1678
  # A recipe contains three items:
@@ -1718,6 +1882,8 @@ module Aws::Personalize
1718
1882
  # resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
1719
1883
  # resp.solution_version.training_hours #=> Float
1720
1884
  # resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE"
1885
+ # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters #=> Hash
1886
+ # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters["ParameterName"] #=> String
1721
1887
  # resp.solution_version.status #=> String
1722
1888
  # resp.solution_version.failure_reason #=> String
1723
1889
  # resp.solution_version.creation_date_time #=> Time
@@ -1783,6 +1949,8 @@ module Aws::Personalize
1783
1949
  # * {Types::ListBatchInferenceJobsResponse#batch_inference_jobs #batch_inference_jobs} => Array&lt;Types::BatchInferenceJobSummary&gt;
1784
1950
  # * {Types::ListBatchInferenceJobsResponse#next_token #next_token} => String
1785
1951
  #
1952
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1953
+ #
1786
1954
  # @example Request syntax with placeholder values
1787
1955
  #
1788
1956
  # resp = client.list_batch_inference_jobs({
@@ -1800,6 +1968,7 @@ module Aws::Personalize
1800
1968
  # resp.batch_inference_jobs[0].creation_date_time #=> Time
1801
1969
  # resp.batch_inference_jobs[0].last_updated_date_time #=> Time
1802
1970
  # resp.batch_inference_jobs[0].failure_reason #=> String
1971
+ # resp.batch_inference_jobs[0].solution_version_arn #=> String
1803
1972
  # resp.next_token #=> String
1804
1973
  #
1805
1974
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs AWS API Documentation
@@ -1834,6 +2003,8 @@ module Aws::Personalize
1834
2003
  # * {Types::ListCampaignsResponse#campaigns #campaigns} => Array&lt;Types::CampaignSummary&gt;
1835
2004
  # * {Types::ListCampaignsResponse#next_token #next_token} => String
1836
2005
  #
2006
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2007
+ #
1837
2008
  # @example Request syntax with placeholder values
1838
2009
  #
1839
2010
  # resp = client.list_campaigns({
@@ -1878,6 +2049,8 @@ module Aws::Personalize
1878
2049
  # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array&lt;Types::DatasetGroupSummary&gt;
1879
2050
  # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
1880
2051
  #
2052
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2053
+ #
1881
2054
  # @example Request syntax with placeholder values
1882
2055
  #
1883
2056
  # resp = client.list_dataset_groups({
@@ -1928,6 +2101,8 @@ module Aws::Personalize
1928
2101
  # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array&lt;Types::DatasetImportJobSummary&gt;
1929
2102
  # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
1930
2103
  #
2104
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2105
+ #
1931
2106
  # @example Request syntax with placeholder values
1932
2107
  #
1933
2108
  # resp = client.list_dataset_import_jobs({
@@ -1977,6 +2152,8 @@ module Aws::Personalize
1977
2152
  # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::DatasetSummary&gt;
1978
2153
  # * {Types::ListDatasetsResponse#next_token #next_token} => String
1979
2154
  #
2155
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2156
+ #
1980
2157
  # @example Request syntax with placeholder values
1981
2158
  #
1982
2159
  # resp = client.list_datasets({
@@ -2025,6 +2202,8 @@ module Aws::Personalize
2025
2202
  # * {Types::ListEventTrackersResponse#event_trackers #event_trackers} => Array&lt;Types::EventTrackerSummary&gt;
2026
2203
  # * {Types::ListEventTrackersResponse#next_token #next_token} => String
2027
2204
  #
2205
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2206
+ #
2028
2207
  # @example Request syntax with placeholder values
2029
2208
  #
2030
2209
  # resp = client.list_event_trackers({
@@ -2052,6 +2231,52 @@ module Aws::Personalize
2052
2231
  req.send_request(options)
2053
2232
  end
2054
2233
 
2234
+ # Lists all filters that belong to a given dataset group.
2235
+ #
2236
+ # @option params [String] :dataset_group_arn
2237
+ # The ARN of the dataset group that contains the filters.
2238
+ #
2239
+ # @option params [String] :next_token
2240
+ # A token returned from the previous call to `ListFilters` for getting
2241
+ # the next set of filters (if they exist).
2242
+ #
2243
+ # @option params [Integer] :max_results
2244
+ # The maximum number of filters to return.
2245
+ #
2246
+ # @return [Types::ListFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2247
+ #
2248
+ # * {Types::ListFiltersResponse#filters #filters} => Array&lt;Types::FilterSummary&gt;
2249
+ # * {Types::ListFiltersResponse#next_token #next_token} => String
2250
+ #
2251
+ # @example Request syntax with placeholder values
2252
+ #
2253
+ # resp = client.list_filters({
2254
+ # dataset_group_arn: "Arn",
2255
+ # next_token: "NextToken",
2256
+ # max_results: 1,
2257
+ # })
2258
+ #
2259
+ # @example Response structure
2260
+ #
2261
+ # resp.filters #=> Array
2262
+ # resp.filters[0].name #=> String
2263
+ # resp.filters[0].filter_arn #=> String
2264
+ # resp.filters[0].creation_date_time #=> Time
2265
+ # resp.filters[0].last_updated_date_time #=> Time
2266
+ # resp.filters[0].dataset_group_arn #=> String
2267
+ # resp.filters[0].failure_reason #=> String
2268
+ # resp.filters[0].status #=> String
2269
+ # resp.next_token #=> String
2270
+ #
2271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters AWS API Documentation
2272
+ #
2273
+ # @overload list_filters(params = {})
2274
+ # @param [Hash] params ({})
2275
+ def list_filters(params = {}, options = {})
2276
+ req = build_request(:list_filters, params)
2277
+ req.send_request(options)
2278
+ end
2279
+
2055
2280
  # Returns a list of available recipes. The response provides the
2056
2281
  # properties for each recipe, including the recipe's Amazon Resource
2057
2282
  # Name (ARN).
@@ -2071,6 +2296,8 @@ module Aws::Personalize
2071
2296
  # * {Types::ListRecipesResponse#recipes #recipes} => Array&lt;Types::RecipeSummary&gt;
2072
2297
  # * {Types::ListRecipesResponse#next_token #next_token} => String
2073
2298
  #
2299
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2300
+ #
2074
2301
  # @example Request syntax with placeholder values
2075
2302
  #
2076
2303
  # resp = client.list_recipes({
@@ -2114,6 +2341,8 @@ module Aws::Personalize
2114
2341
  # * {Types::ListSchemasResponse#schemas #schemas} => Array&lt;Types::DatasetSchemaSummary&gt;
2115
2342
  # * {Types::ListSchemasResponse#next_token #next_token} => String
2116
2343
  #
2344
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2345
+ #
2117
2346
  # @example Request syntax with placeholder values
2118
2347
  #
2119
2348
  # resp = client.list_schemas({
@@ -2160,6 +2389,8 @@ module Aws::Personalize
2160
2389
  # * {Types::ListSolutionVersionsResponse#solution_versions #solution_versions} => Array&lt;Types::SolutionVersionSummary&gt;
2161
2390
  # * {Types::ListSolutionVersionsResponse#next_token #next_token} => String
2162
2391
  #
2392
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2393
+ #
2163
2394
  # @example Request syntax with placeholder values
2164
2395
  #
2165
2396
  # resp = client.list_solution_versions({
@@ -2208,6 +2439,8 @@ module Aws::Personalize
2208
2439
  # * {Types::ListSolutionsResponse#solutions #solutions} => Array&lt;Types::SolutionSummary&gt;
2209
2440
  # * {Types::ListSolutionsResponse#next_token #next_token} => String
2210
2441
  #
2442
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2443
+ #
2211
2444
  # @example Request syntax with placeholder values
2212
2445
  #
2213
2446
  # resp = client.list_solutions({
@@ -2296,7 +2529,7 @@ module Aws::Personalize
2296
2529
  params: params,
2297
2530
  config: config)
2298
2531
  context[:gem_name] = 'aws-sdk-personalize'
2299
- context[:gem_version] = '1.8.0'
2532
+ context[:gem_version] = '1.13.0'
2300
2533
  Seahorse::Client::Request.new(handlers, context)
2301
2534
  end
2302
2535
 
@@ -49,6 +49,8 @@ module Aws::Personalize
49
49
  CreateDatasetResponse = Shapes::StructureShape.new(name: 'CreateDatasetResponse')
50
50
  CreateEventTrackerRequest = Shapes::StructureShape.new(name: 'CreateEventTrackerRequest')
51
51
  CreateEventTrackerResponse = Shapes::StructureShape.new(name: 'CreateEventTrackerResponse')
52
+ CreateFilterRequest = Shapes::StructureShape.new(name: 'CreateFilterRequest')
53
+ CreateFilterResponse = Shapes::StructureShape.new(name: 'CreateFilterResponse')
52
54
  CreateSchemaRequest = Shapes::StructureShape.new(name: 'CreateSchemaRequest')
53
55
  CreateSchemaResponse = Shapes::StructureShape.new(name: 'CreateSchemaResponse')
54
56
  CreateSolutionRequest = Shapes::StructureShape.new(name: 'CreateSolutionRequest')
@@ -80,6 +82,7 @@ module Aws::Personalize
80
82
  DeleteDatasetGroupRequest = Shapes::StructureShape.new(name: 'DeleteDatasetGroupRequest')
81
83
  DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
82
84
  DeleteEventTrackerRequest = Shapes::StructureShape.new(name: 'DeleteEventTrackerRequest')
85
+ DeleteFilterRequest = Shapes::StructureShape.new(name: 'DeleteFilterRequest')
83
86
  DeleteSchemaRequest = Shapes::StructureShape.new(name: 'DeleteSchemaRequest')
84
87
  DeleteSolutionRequest = Shapes::StructureShape.new(name: 'DeleteSolutionRequest')
85
88
  DescribeAlgorithmRequest = Shapes::StructureShape.new(name: 'DescribeAlgorithmRequest')
@@ -98,6 +101,8 @@ module Aws::Personalize
98
101
  DescribeEventTrackerResponse = Shapes::StructureShape.new(name: 'DescribeEventTrackerResponse')
99
102
  DescribeFeatureTransformationRequest = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationRequest')
100
103
  DescribeFeatureTransformationResponse = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationResponse')
104
+ DescribeFilterRequest = Shapes::StructureShape.new(name: 'DescribeFilterRequest')
105
+ DescribeFilterResponse = Shapes::StructureShape.new(name: 'DescribeFilterResponse')
101
106
  DescribeRecipeRequest = Shapes::StructureShape.new(name: 'DescribeRecipeRequest')
102
107
  DescribeRecipeResponse = Shapes::StructureShape.new(name: 'DescribeRecipeResponse')
103
108
  DescribeSchemaRequest = Shapes::StructureShape.new(name: 'DescribeSchemaRequest')
@@ -118,6 +123,10 @@ module Aws::Personalize
118
123
  FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
119
124
  FeatureTransformationParameters = Shapes::MapShape.new(name: 'FeatureTransformationParameters')
120
125
  FeaturizationParameters = Shapes::MapShape.new(name: 'FeaturizationParameters')
126
+ Filter = Shapes::StructureShape.new(name: 'Filter')
127
+ FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
128
+ FilterSummary = Shapes::StructureShape.new(name: 'FilterSummary')
129
+ Filters = Shapes::ListShape.new(name: 'Filters')
121
130
  GetSolutionMetricsRequest = Shapes::StructureShape.new(name: 'GetSolutionMetricsRequest')
122
131
  GetSolutionMetricsResponse = Shapes::StructureShape.new(name: 'GetSolutionMetricsResponse')
123
132
  HPOConfig = Shapes::StructureShape.new(name: 'HPOConfig')
@@ -147,6 +156,8 @@ module Aws::Personalize
147
156
  ListDatasetsResponse = Shapes::StructureShape.new(name: 'ListDatasetsResponse')
148
157
  ListEventTrackersRequest = Shapes::StructureShape.new(name: 'ListEventTrackersRequest')
149
158
  ListEventTrackersResponse = Shapes::StructureShape.new(name: 'ListEventTrackersResponse')
159
+ ListFiltersRequest = Shapes::StructureShape.new(name: 'ListFiltersRequest')
160
+ ListFiltersResponse = Shapes::StructureShape.new(name: 'ListFiltersResponse')
150
161
  ListRecipesRequest = Shapes::StructureShape.new(name: 'ListRecipesRequest')
151
162
  ListRecipesResponse = Shapes::StructureShape.new(name: 'ListRecipesResponse')
152
163
  ListSchemasRequest = Shapes::StructureShape.new(name: 'ListSchemasRequest')
@@ -194,6 +205,7 @@ module Aws::Personalize
194
205
  TrainingMode = Shapes::StringShape.new(name: 'TrainingMode')
195
206
  TransactionsPerSecond = Shapes::IntegerShape.new(name: 'TransactionsPerSecond')
196
207
  Tunable = Shapes::BooleanShape.new(name: 'Tunable')
208
+ TunedHPOParams = Shapes::StructureShape.new(name: 'TunedHPOParams')
197
209
  UpdateCampaignRequest = Shapes::StructureShape.new(name: 'UpdateCampaignRequest')
198
210
  UpdateCampaignResponse = Shapes::StructureShape.new(name: 'UpdateCampaignResponse')
199
211
 
@@ -224,6 +236,7 @@ module Aws::Personalize
224
236
 
225
237
  BatchInferenceJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
226
238
  BatchInferenceJob.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
239
+ BatchInferenceJob.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
227
240
  BatchInferenceJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
228
241
  BatchInferenceJob.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
229
242
  BatchInferenceJob.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
@@ -247,6 +260,7 @@ module Aws::Personalize
247
260
  BatchInferenceJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
248
261
  BatchInferenceJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
249
262
  BatchInferenceJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
263
+ BatchInferenceJobSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
250
264
  BatchInferenceJobSummary.struct_class = Types::BatchInferenceJobSummary
251
265
 
252
266
  BatchInferenceJobs.member = Shapes::ShapeRef.new(shape: BatchInferenceJobSummary)
@@ -297,6 +311,7 @@ module Aws::Personalize
297
311
 
298
312
  CreateBatchInferenceJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
299
313
  CreateBatchInferenceJobRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
314
+ CreateBatchInferenceJobRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
300
315
  CreateBatchInferenceJobRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
301
316
  CreateBatchInferenceJobRequest.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, required: true, location_name: "jobInput"))
302
317
  CreateBatchInferenceJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, required: true, location_name: "jobOutput"))
@@ -348,6 +363,14 @@ module Aws::Personalize
348
363
  CreateEventTrackerResponse.add_member(:tracking_id, Shapes::ShapeRef.new(shape: TrackingId, location_name: "trackingId"))
349
364
  CreateEventTrackerResponse.struct_class = Types::CreateEventTrackerResponse
350
365
 
366
+ CreateFilterRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
367
+ CreateFilterRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
368
+ CreateFilterRequest.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, required: true, location_name: "filterExpression"))
369
+ CreateFilterRequest.struct_class = Types::CreateFilterRequest
370
+
371
+ CreateFilterResponse.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
372
+ CreateFilterResponse.struct_class = Types::CreateFilterResponse
373
+
351
374
  CreateSchemaRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
352
375
  CreateSchemaRequest.add_member(:schema, Shapes::ShapeRef.new(shape: AvroSchema, required: true, location_name: "schema"))
353
376
  CreateSchemaRequest.struct_class = Types::CreateSchemaRequest
@@ -491,6 +514,9 @@ module Aws::Personalize
491
514
  DeleteEventTrackerRequest.add_member(:event_tracker_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "eventTrackerArn"))
492
515
  DeleteEventTrackerRequest.struct_class = Types::DeleteEventTrackerRequest
493
516
 
517
+ DeleteFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
518
+ DeleteFilterRequest.struct_class = Types::DeleteFilterRequest
519
+
494
520
  DeleteSchemaRequest.add_member(:schema_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "schemaArn"))
495
521
  DeleteSchemaRequest.struct_class = Types::DeleteSchemaRequest
496
522
 
@@ -545,6 +571,12 @@ module Aws::Personalize
545
571
  DescribeFeatureTransformationResponse.add_member(:feature_transformation, Shapes::ShapeRef.new(shape: FeatureTransformation, location_name: "featureTransformation"))
546
572
  DescribeFeatureTransformationResponse.struct_class = Types::DescribeFeatureTransformationResponse
547
573
 
574
+ DescribeFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
575
+ DescribeFilterRequest.struct_class = Types::DescribeFilterRequest
576
+
577
+ DescribeFilterResponse.add_member(:filter, Shapes::ShapeRef.new(shape: Filter, location_name: "filter"))
578
+ DescribeFilterResponse.struct_class = Types::DescribeFilterResponse
579
+
548
580
  DescribeRecipeRequest.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "recipeArn"))
549
581
  DescribeRecipeRequest.struct_class = Types::DescribeRecipeRequest
550
582
 
@@ -602,6 +634,27 @@ module Aws::Personalize
602
634
  FeaturizationParameters.key = Shapes::ShapeRef.new(shape: ParameterName)
603
635
  FeaturizationParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
604
636
 
637
+ Filter.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
638
+ Filter.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
639
+ Filter.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
640
+ Filter.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
641
+ Filter.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
642
+ Filter.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
643
+ Filter.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, location_name: "filterExpression"))
644
+ Filter.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
645
+ Filter.struct_class = Types::Filter
646
+
647
+ FilterSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
648
+ FilterSummary.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
649
+ FilterSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
650
+ FilterSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
651
+ FilterSummary.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
652
+ FilterSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
653
+ FilterSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
654
+ FilterSummary.struct_class = Types::FilterSummary
655
+
656
+ Filters.member = Shapes::ShapeRef.new(shape: FilterSummary)
657
+
605
658
  GetSolutionMetricsRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
606
659
  GetSolutionMetricsRequest.struct_class = Types::GetSolutionMetricsRequest
607
660
 
@@ -700,6 +753,15 @@ module Aws::Personalize
700
753
  ListEventTrackersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
701
754
  ListEventTrackersResponse.struct_class = Types::ListEventTrackersResponse
702
755
 
756
+ ListFiltersRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
757
+ ListFiltersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
758
+ ListFiltersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
759
+ ListFiltersRequest.struct_class = Types::ListFiltersRequest
760
+
761
+ ListFiltersResponse.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
762
+ ListFiltersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
763
+ ListFiltersResponse.struct_class = Types::ListFiltersResponse
764
+
703
765
  ListRecipesRequest.add_member(:recipe_provider, Shapes::ShapeRef.new(shape: RecipeProvider, location_name: "recipeProvider"))
704
766
  ListRecipesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
705
767
  ListRecipesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -815,6 +877,7 @@ module Aws::Personalize
815
877
  SolutionVersion.add_member(:solution_config, Shapes::ShapeRef.new(shape: SolutionConfig, location_name: "solutionConfig"))
816
878
  SolutionVersion.add_member(:training_hours, Shapes::ShapeRef.new(shape: TrainingHours, location_name: "trainingHours"))
817
879
  SolutionVersion.add_member(:training_mode, Shapes::ShapeRef.new(shape: TrainingMode, location_name: "trainingMode"))
880
+ SolutionVersion.add_member(:tuned_hpo_params, Shapes::ShapeRef.new(shape: TunedHPOParams, location_name: "tunedHPOParams"))
818
881
  SolutionVersion.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
819
882
  SolutionVersion.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
820
883
  SolutionVersion.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
@@ -832,6 +895,9 @@ module Aws::Personalize
832
895
 
833
896
  Solutions.member = Shapes::ShapeRef.new(shape: SolutionSummary)
834
897
 
898
+ TunedHPOParams.add_member(:algorithm_hyper_parameters, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "algorithmHyperParameters"))
899
+ TunedHPOParams.struct_class = Types::TunedHPOParams
900
+
835
901
  UpdateCampaignRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
836
902
  UpdateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
837
903
  UpdateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minProvisionedTPS"))
@@ -935,6 +1001,18 @@ module Aws::Personalize
935
1001
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
936
1002
  end)
937
1003
 
1004
+ api.add_operation(:create_filter, Seahorse::Model::Operation.new.tap do |o|
1005
+ o.name = "CreateFilter"
1006
+ o.http_method = "POST"
1007
+ o.http_request_uri = "/"
1008
+ o.input = Shapes::ShapeRef.new(shape: CreateFilterRequest)
1009
+ o.output = Shapes::ShapeRef.new(shape: CreateFilterResponse)
1010
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1011
+ o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
1012
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1013
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
1014
+ end)
1015
+
938
1016
  api.add_operation(:create_schema, Seahorse::Model::Operation.new.tap do |o|
939
1017
  o.name = "CreateSchema"
940
1018
  o.http_method = "POST"
@@ -1014,6 +1092,16 @@ module Aws::Personalize
1014
1092
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1015
1093
  end)
1016
1094
 
1095
+ api.add_operation(:delete_filter, Seahorse::Model::Operation.new.tap do |o|
1096
+ o.name = "DeleteFilter"
1097
+ o.http_method = "POST"
1098
+ o.http_request_uri = "/"
1099
+ o.input = Shapes::ShapeRef.new(shape: DeleteFilterRequest)
1100
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
1101
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1102
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1103
+ end)
1104
+
1017
1105
  api.add_operation(:delete_schema, Seahorse::Model::Operation.new.tap do |o|
1018
1106
  o.name = "DeleteSchema"
1019
1107
  o.http_method = "POST"
@@ -1116,6 +1204,16 @@ module Aws::Personalize
1116
1204
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1117
1205
  end)
1118
1206
 
1207
+ api.add_operation(:describe_filter, Seahorse::Model::Operation.new.tap do |o|
1208
+ o.name = "DescribeFilter"
1209
+ o.http_method = "POST"
1210
+ o.http_request_uri = "/"
1211
+ o.input = Shapes::ShapeRef.new(shape: DescribeFilterRequest)
1212
+ o.output = Shapes::ShapeRef.new(shape: DescribeFilterResponse)
1213
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1214
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1215
+ end)
1216
+
1119
1217
  api.add_operation(:describe_recipe, Seahorse::Model::Operation.new.tap do |o|
1120
1218
  o.name = "DescribeRecipe"
1121
1219
  o.http_method = "POST"
@@ -1262,6 +1360,16 @@ module Aws::Personalize
1262
1360
  )
1263
1361
  end)
1264
1362
 
1363
+ api.add_operation(:list_filters, Seahorse::Model::Operation.new.tap do |o|
1364
+ o.name = "ListFilters"
1365
+ o.http_method = "POST"
1366
+ o.http_request_uri = "/"
1367
+ o.input = Shapes::ShapeRef.new(shape: ListFiltersRequest)
1368
+ o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
1369
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1370
+ o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
1371
+ end)
1372
+
1265
1373
  api.add_operation(:list_recipes, Seahorse::Model::Operation.new.tap do |o|
1266
1374
  o.name = "ListRecipes"
1267
1375
  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 ({})
@@ -142,6 +142,10 @@ module Aws::Personalize
142
142
  # The Amazon Resource Name (ARN) of the batch inference job.
143
143
  # @return [String]
144
144
  #
145
+ # @!attribute [rw] filter_arn
146
+ # The ARN of the filter used on the batch inference job.
147
+ # @return [String]
148
+ #
145
149
  # @!attribute [rw] failure_reason
146
150
  # If the batch inference job failed, the reason for the failure.
147
151
  # @return [String]
@@ -198,6 +202,7 @@ module Aws::Personalize
198
202
  class BatchInferenceJob < Struct.new(
199
203
  :job_name,
200
204
  :batch_inference_job_arn,
205
+ :filter_arn,
201
206
  :failure_reason,
202
207
  :solution_version_arn,
203
208
  :num_results,
@@ -296,6 +301,10 @@ module Aws::Personalize
296
301
  # If the batch inference job failed, the reason for the failure.
297
302
  # @return [String]
298
303
  #
304
+ # @!attribute [rw] solution_version_arn
305
+ # The ARN of the solution version used by the batch inference job.
306
+ # @return [String]
307
+ #
299
308
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobSummary AWS API Documentation
300
309
  #
301
310
  class BatchInferenceJobSummary < Struct.new(
@@ -304,7 +313,8 @@ module Aws::Personalize
304
313
  :status,
305
314
  :creation_date_time,
306
315
  :last_updated_date_time,
307
- :failure_reason)
316
+ :failure_reason,
317
+ :solution_version_arn)
308
318
  include Aws::Structure
309
319
  end
310
320
 
@@ -532,6 +542,7 @@ module Aws::Personalize
532
542
  # {
533
543
  # job_name: "Name", # required
534
544
  # solution_version_arn: "Arn", # required
545
+ # filter_arn: "Arn",
535
546
  # num_results: 1,
536
547
  # job_input: { # required
537
548
  # s3_data_source: { # required
@@ -557,6 +568,12 @@ module Aws::Personalize
557
568
  # used to generate the batch inference recommendations.
558
569
  # @return [String]
559
570
  #
571
+ # @!attribute [rw] filter_arn
572
+ # The ARN of the filter to apply to the batch inference job. For more
573
+ # information on using filters, see Using Filters with Amazon
574
+ # Personalize.
575
+ # @return [String]
576
+ #
560
577
  # @!attribute [rw] num_results
561
578
  # The number of recommendations to retreive.
562
579
  # @return [Integer]
@@ -582,6 +599,7 @@ module Aws::Personalize
582
599
  class CreateBatchInferenceJobRequest < Struct.new(
583
600
  :job_name,
584
601
  :solution_version_arn,
602
+ :filter_arn,
585
603
  :num_results,
586
604
  :job_input,
587
605
  :job_output,
@@ -839,6 +857,56 @@ module Aws::Personalize
839
857
  include Aws::Structure
840
858
  end
841
859
 
860
+ # @note When making an API call, you may pass CreateFilterRequest
861
+ # data as a hash:
862
+ #
863
+ # {
864
+ # name: "Name", # required
865
+ # dataset_group_arn: "Arn", # required
866
+ # filter_expression: "FilterExpression", # required
867
+ # }
868
+ #
869
+ # @!attribute [rw] name
870
+ # The name of the filter to create.
871
+ # @return [String]
872
+ #
873
+ # @!attribute [rw] dataset_group_arn
874
+ # The ARN of the dataset group that the filter will belong to.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] filter_expression
878
+ # The filter expression that designates the interaction types that the
879
+ # filter will filter out. A filter expression must follow the
880
+ # following format:
881
+ #
882
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
883
+ #
884
+ # Where "EVENT\_TYPE" is the type of event to filter out. To filter
885
+ # out all items with any interactions history, set `"*"` as the
886
+ # EVENT\_TYPE. For more information, see Using Filters with Amazon
887
+ # Personalize.
888
+ # @return [String]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
891
+ #
892
+ class CreateFilterRequest < Struct.new(
893
+ :name,
894
+ :dataset_group_arn,
895
+ :filter_expression)
896
+ include Aws::Structure
897
+ end
898
+
899
+ # @!attribute [rw] filter_arn
900
+ # The ARN of the new filter.
901
+ # @return [String]
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterResponse AWS API Documentation
904
+ #
905
+ class CreateFilterResponse < Struct.new(
906
+ :filter_arn)
907
+ include Aws::Structure
908
+ end
909
+
842
910
  # @note When making an API call, you may pass CreateSchemaRequest
843
911
  # data as a hash:
844
912
  #
@@ -1665,6 +1733,24 @@ module Aws::Personalize
1665
1733
  include Aws::Structure
1666
1734
  end
1667
1735
 
1736
+ # @note When making an API call, you may pass DeleteFilterRequest
1737
+ # data as a hash:
1738
+ #
1739
+ # {
1740
+ # filter_arn: "Arn", # required
1741
+ # }
1742
+ #
1743
+ # @!attribute [rw] filter_arn
1744
+ # The ARN of the filter to delete.
1745
+ # @return [String]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilterRequest AWS API Documentation
1748
+ #
1749
+ class DeleteFilterRequest < Struct.new(
1750
+ :filter_arn)
1751
+ include Aws::Structure
1752
+ end
1753
+
1668
1754
  # @note When making an API call, you may pass DeleteSchemaRequest
1669
1755
  # data as a hash:
1670
1756
  #
@@ -1945,6 +2031,35 @@ module Aws::Personalize
1945
2031
  include Aws::Structure
1946
2032
  end
1947
2033
 
2034
+ # @note When making an API call, you may pass DescribeFilterRequest
2035
+ # data as a hash:
2036
+ #
2037
+ # {
2038
+ # filter_arn: "Arn", # required
2039
+ # }
2040
+ #
2041
+ # @!attribute [rw] filter_arn
2042
+ # The ARN of the filter to describe.
2043
+ # @return [String]
2044
+ #
2045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterRequest AWS API Documentation
2046
+ #
2047
+ class DescribeFilterRequest < Struct.new(
2048
+ :filter_arn)
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # @!attribute [rw] filter
2053
+ # The filter's details.
2054
+ # @return [Types::Filter]
2055
+ #
2056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterResponse AWS API Documentation
2057
+ #
2058
+ class DescribeFilterResponse < Struct.new(
2059
+ :filter)
2060
+ include Aws::Structure
2061
+ end
2062
+
1948
2063
  # @note When making an API call, you may pass DescribeRecipeRequest
1949
2064
  # data as a hash:
1950
2065
  #
@@ -2215,6 +2330,105 @@ module Aws::Personalize
2215
2330
  include Aws::Structure
2216
2331
  end
2217
2332
 
2333
+ # Contains information on a recommendation filter, including its ARN,
2334
+ # status, and filter expression.
2335
+ #
2336
+ # @!attribute [rw] name
2337
+ # The name of the filter.
2338
+ # @return [String]
2339
+ #
2340
+ # @!attribute [rw] filter_arn
2341
+ # The ARN of the filter.
2342
+ # @return [String]
2343
+ #
2344
+ # @!attribute [rw] creation_date_time
2345
+ # The time at which the filter was created.
2346
+ # @return [Time]
2347
+ #
2348
+ # @!attribute [rw] last_updated_date_time
2349
+ # The time at which the filter was last updated.
2350
+ # @return [Time]
2351
+ #
2352
+ # @!attribute [rw] dataset_group_arn
2353
+ # The ARN of the dataset group to which the filter belongs.
2354
+ # @return [String]
2355
+ #
2356
+ # @!attribute [rw] failure_reason
2357
+ # If the filter failed, the reason for its failure.
2358
+ # @return [String]
2359
+ #
2360
+ # @!attribute [rw] filter_expression
2361
+ # Specifies the type of item interactions to filter out of
2362
+ # recommendation results. The filter expression must follow the
2363
+ # following format:
2364
+ #
2365
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
2366
+ #
2367
+ # Where "EVENT\_TYPE" is the type of event to filter out. For more
2368
+ # information, see Using Filters with Amazon Personalize.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] status
2372
+ # The status of the filter.
2373
+ # @return [String]
2374
+ #
2375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Filter AWS API Documentation
2376
+ #
2377
+ class Filter < Struct.new(
2378
+ :name,
2379
+ :filter_arn,
2380
+ :creation_date_time,
2381
+ :last_updated_date_time,
2382
+ :dataset_group_arn,
2383
+ :failure_reason,
2384
+ :filter_expression,
2385
+ :status)
2386
+ include Aws::Structure
2387
+ end
2388
+
2389
+ # A short summary of a filter's attributes.
2390
+ #
2391
+ # @!attribute [rw] name
2392
+ # The name of the filter.
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] filter_arn
2396
+ # The ARN of the filter.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] creation_date_time
2400
+ # The time at which the filter was created.
2401
+ # @return [Time]
2402
+ #
2403
+ # @!attribute [rw] last_updated_date_time
2404
+ # The time at which the filter was last updated.
2405
+ # @return [Time]
2406
+ #
2407
+ # @!attribute [rw] dataset_group_arn
2408
+ # The ARN of the dataset group to which the filter belongs.
2409
+ # @return [String]
2410
+ #
2411
+ # @!attribute [rw] failure_reason
2412
+ # If the filter failed, the reason for the failure.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] status
2416
+ # The status of the filter.
2417
+ # @return [String]
2418
+ #
2419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FilterSummary AWS API Documentation
2420
+ #
2421
+ class FilterSummary < Struct.new(
2422
+ :name,
2423
+ :filter_arn,
2424
+ :creation_date_time,
2425
+ :last_updated_date_time,
2426
+ :dataset_group_arn,
2427
+ :failure_reason,
2428
+ :status)
2429
+ include Aws::Structure
2430
+ end
2431
+
2218
2432
  # @note When making an API call, you may pass GetSolutionMetricsRequest
2219
2433
  # data as a hash:
2220
2434
  #
@@ -2324,7 +2538,7 @@ module Aws::Personalize
2324
2538
  # }
2325
2539
  #
2326
2540
  # @!attribute [rw] type
2327
- # The data type of the metric.
2541
+ # The type of the metric. Valid values are `Maximize` and `Minimize`.
2328
2542
  # @return [String]
2329
2543
  #
2330
2544
  # @!attribute [rw] metric_name
@@ -2777,6 +2991,53 @@ module Aws::Personalize
2777
2991
  include Aws::Structure
2778
2992
  end
2779
2993
 
2994
+ # @note When making an API call, you may pass ListFiltersRequest
2995
+ # data as a hash:
2996
+ #
2997
+ # {
2998
+ # dataset_group_arn: "Arn",
2999
+ # next_token: "NextToken",
3000
+ # max_results: 1,
3001
+ # }
3002
+ #
3003
+ # @!attribute [rw] dataset_group_arn
3004
+ # The ARN of the dataset group that contains the filters.
3005
+ # @return [String]
3006
+ #
3007
+ # @!attribute [rw] next_token
3008
+ # A token returned from the previous call to `ListFilters` for getting
3009
+ # the next set of filters (if they exist).
3010
+ # @return [String]
3011
+ #
3012
+ # @!attribute [rw] max_results
3013
+ # The maximum number of filters to return.
3014
+ # @return [Integer]
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersRequest AWS API Documentation
3017
+ #
3018
+ class ListFiltersRequest < Struct.new(
3019
+ :dataset_group_arn,
3020
+ :next_token,
3021
+ :max_results)
3022
+ include Aws::Structure
3023
+ end
3024
+
3025
+ # @!attribute [rw] filters
3026
+ # A list of returned filters.
3027
+ # @return [Array<Types::FilterSummary>]
3028
+ #
3029
+ # @!attribute [rw] next_token
3030
+ # A token for getting the next set of filters (if they exist).
3031
+ # @return [String]
3032
+ #
3033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersResponse AWS API Documentation
3034
+ #
3035
+ class ListFiltersResponse < Struct.new(
3036
+ :filters,
3037
+ :next_token)
3038
+ include Aws::Structure
3039
+ end
3040
+
2780
3041
  # @note When making an API call, you may pass ListRecipesRequest
2781
3042
  # data as a hash:
2782
3043
  #
@@ -3394,6 +3655,11 @@ module Aws::Personalize
3394
3655
  # uses the native-recipe-hrnn-coldstart.
3395
3656
  # @return [String]
3396
3657
  #
3658
+ # @!attribute [rw] tuned_hpo_params
3659
+ # If hyperparameter optimization was performed, contains the
3660
+ # hyperparameter values of the best performing model.
3661
+ # @return [Types::TunedHPOParams]
3662
+ #
3397
3663
  # @!attribute [rw] status
3398
3664
  # The status of the solution version.
3399
3665
  #
@@ -3434,6 +3700,7 @@ module Aws::Personalize
3434
3700
  :solution_config,
3435
3701
  :training_hours,
3436
3702
  :training_mode,
3703
+ :tuned_hpo_params,
3437
3704
  :status,
3438
3705
  :failure_reason,
3439
3706
  :creation_date_time,
@@ -3484,6 +3751,20 @@ module Aws::Personalize
3484
3751
  include Aws::Structure
3485
3752
  end
3486
3753
 
3754
+ # If hyperparameter optimization (HPO) was performed, contains the
3755
+ # hyperparameter values of the best performing model.
3756
+ #
3757
+ # @!attribute [rw] algorithm_hyper_parameters
3758
+ # A list of the hyperparameter values of the best performing model.
3759
+ # @return [Hash<String,String>]
3760
+ #
3761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TunedHPOParams AWS API Documentation
3762
+ #
3763
+ class TunedHPOParams < Struct.new(
3764
+ :algorithm_hyper_parameters)
3765
+ include Aws::Structure
3766
+ end
3767
+
3487
3768
  # @note When making an API call, you may pass UpdateCampaignRequest
3488
3769
  # data as a hash:
3489
3770
  #
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.8.0
4
+ version: 1.13.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-11-14 00:00:00.000000000 Z
11
+ date: 2020-06-05 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