aws-sdk-personalize 1.0.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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: cc3fbadfee2b93d8ff496de705d732ce54604a5d
4
+ data.tar.gz: 40a930efd02c08a81312aaed5a82b1c7ff1cd20a
5
+ SHA512:
6
+ metadata.gz: 2218a233b6c3e04c548d82323b7885b730d1adffd1bd674e475505ad835c2519a0e573c6b8b88aa797e57d564f9e8cd16e44aabe9c2bf9186a1e8859cfcf5912
7
+ data.tar.gz: cd517885936ec7166f2b37ff5f9a08aed13892e36cc8d8f3b4ea28c07df50216b30a8e78f59007448855351c58ac349cbbe2edc27943ac33af11ec61fc553e80
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-personalize/types'
12
+ require_relative 'aws-sdk-personalize/client_api'
13
+ require_relative 'aws-sdk-personalize/client'
14
+ require_relative 'aws-sdk-personalize/errors'
15
+ require_relative 'aws-sdk-personalize/resource'
16
+ require_relative 'aws-sdk-personalize/customizations'
17
+
18
+ # This module provides support for Amazon Personalize. This module is available in the
19
+ # `aws-sdk-personalize` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Personalize all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::Personalize::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::Personalize
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,2147 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/signature_v4.rb'
28
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
+
30
+ Aws::Plugins::GlobalConfiguration.add_identifier(:personalize)
31
+
32
+ module Aws::Personalize
33
+ class Client < Seahorse::Client::Base
34
+
35
+ include Aws::ClientStubs
36
+
37
+ @identifier = :personalize
38
+
39
+ set_api(ClientApi::API)
40
+
41
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
42
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
43
+ add_plugin(Aws::Plugins::Logging)
44
+ add_plugin(Aws::Plugins::ParamConverter)
45
+ add_plugin(Aws::Plugins::ParamValidator)
46
+ add_plugin(Aws::Plugins::UserAgent)
47
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
48
+ add_plugin(Aws::Plugins::RetryErrors)
49
+ add_plugin(Aws::Plugins::GlobalConfiguration)
50
+ add_plugin(Aws::Plugins::RegionalEndpoint)
51
+ add_plugin(Aws::Plugins::EndpointDiscovery)
52
+ add_plugin(Aws::Plugins::EndpointPattern)
53
+ add_plugin(Aws::Plugins::ResponsePaging)
54
+ add_plugin(Aws::Plugins::StubResponses)
55
+ add_plugin(Aws::Plugins::IdempotencyToken)
56
+ add_plugin(Aws::Plugins::JsonvalueConverter)
57
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
+ add_plugin(Aws::Plugins::TransferEncoding)
60
+ add_plugin(Aws::Plugins::SignatureV4)
61
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
+
63
+ # @overload initialize(options)
64
+ # @param [Hash] options
65
+ # @option options [required, Aws::CredentialProvider] :credentials
66
+ # Your AWS credentials. This can be an instance of any one of the
67
+ # following classes:
68
+ #
69
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
70
+ # credentials.
71
+ #
72
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
73
+ # from an EC2 IMDS on an EC2 instance.
74
+ #
75
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
76
+ # shared file, such as `~/.aws/config`.
77
+ #
78
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
79
+ #
80
+ # When `:credentials` are not configured directly, the following
81
+ # locations will be searched for credentials:
82
+ #
83
+ # * `Aws.config[:credentials]`
84
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
85
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
86
+ # * `~/.aws/credentials`
87
+ # * `~/.aws/config`
88
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
89
+ # very aggressive. Construct and pass an instance of
90
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
91
+ # timeouts.
92
+ #
93
+ # @option options [required, String] :region
94
+ # The AWS region to connect to. The configured `:region` is
95
+ # used to determine the service `:endpoint`. When not passed,
96
+ # a default `:region` is search for in the following locations:
97
+ #
98
+ # * `Aws.config[:region]`
99
+ # * `ENV['AWS_REGION']`
100
+ # * `ENV['AMAZON_REGION']`
101
+ # * `ENV['AWS_DEFAULT_REGION']`
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ #
105
+ # @option options [String] :access_key_id
106
+ #
107
+ # @option options [Boolean] :active_endpoint_cache (false)
108
+ # When set to `true`, a thread polling for endpoints will be running in
109
+ # the background every 60 secs (default). Defaults to `false`.
110
+ #
111
+ # @option options [Boolean] :client_side_monitoring (false)
112
+ # When `true`, client-side metrics will be collected for all API requests from
113
+ # this client.
114
+ #
115
+ # @option options [String] :client_side_monitoring_client_id ("")
116
+ # Allows you to provide an identifier for this client which will be attached to
117
+ # all generated client side metrics. Defaults to an empty string.
118
+ #
119
+ # @option options [Integer] :client_side_monitoring_port (31000)
120
+ # Required for publishing client metrics. The port that the client side monitoring
121
+ # agent is running on, where client metrics will be published via UDP.
122
+ #
123
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
124
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
125
+ # will use the Client Side Monitoring Agent Publisher.
126
+ #
127
+ # @option options [Boolean] :convert_params (true)
128
+ # When `true`, an attempt is made to coerce request parameters into
129
+ # the required types.
130
+ #
131
+ # @option options [Boolean] :disable_host_prefix_injection (false)
132
+ # Set to true to disable SDK automatically adding host prefix
133
+ # to default service endpoint when available.
134
+ #
135
+ # @option options [String] :endpoint
136
+ # The client endpoint is normally constructed from the `:region`
137
+ # option. You should only configure an `:endpoint` when connecting
138
+ # to test endpoints. This should be avalid HTTP(S) URI.
139
+ #
140
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
141
+ # Used for the maximum size limit of the LRU cache storing endpoints data
142
+ # for endpoint discovery enabled operations. Defaults to 1000.
143
+ #
144
+ # @option options [Integer] :endpoint_cache_max_threads (10)
145
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
146
+ #
147
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
148
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
149
+ # Use this option to config the time interval in seconds for making
150
+ # requests fetching endpoints information. Defaults to 60 sec.
151
+ #
152
+ # @option options [Boolean] :endpoint_discovery (false)
153
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
154
+ #
155
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
156
+ # The log formatter.
157
+ #
158
+ # @option options [Symbol] :log_level (:info)
159
+ # The log level to send messages to the `:logger` at.
160
+ #
161
+ # @option options [Logger] :logger
162
+ # The Logger instance to send log messages to. If this option
163
+ # is not set, logging will be disabled.
164
+ #
165
+ # @option options [String] :profile ("default")
166
+ # Used when loading credentials from the shared credentials file
167
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
168
+ #
169
+ # @option options [Float] :retry_base_delay (0.3)
170
+ # The base delay in seconds used by the default backoff function.
171
+ #
172
+ # @option options [Symbol] :retry_jitter (:none)
173
+ # 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.
174
+ #
175
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
176
+ #
177
+ # @option options [Integer] :retry_limit (3)
178
+ # The maximum number of times to retry failed requests. Only
179
+ # ~ 500 level server errors and certain ~ 400 level client errors
180
+ # are retried. Generally, these are throttling errors, data
181
+ # checksum errors, networking errors, timeout errors and auth
182
+ # errors from expired credentials.
183
+ #
184
+ # @option options [Integer] :retry_max_delay (0)
185
+ # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
186
+ #
187
+ # @option options [String] :secret_access_key
188
+ #
189
+ # @option options [String] :session_token
190
+ #
191
+ # @option options [Boolean] :simple_json (false)
192
+ # Disables request parameter conversion, validation, and formatting.
193
+ # Also disable response data type conversions. This option is useful
194
+ # when you want to ensure the highest level of performance by
195
+ # avoiding overhead of walking request parameters and response data
196
+ # structures.
197
+ #
198
+ # When `:simple_json` is enabled, the request parameters hash must
199
+ # be formatted exactly as the DynamoDB API expects.
200
+ #
201
+ # @option options [Boolean] :stub_responses (false)
202
+ # Causes the client to return stubbed responses. By default
203
+ # fake responses are generated and returned. You can specify
204
+ # the response data to return or errors to raise by calling
205
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
206
+ #
207
+ # ** Please note ** When response stubbing is enabled, no HTTP
208
+ # requests are made, and retries are disabled.
209
+ #
210
+ # @option options [Boolean] :validate_params (true)
211
+ # When `true`, request parameters are validated before
212
+ # sending the request.
213
+ #
214
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
215
+ # requests through. Formatted like 'http://proxy.com:123'.
216
+ #
217
+ # @option options [Float] :http_open_timeout (15) The number of
218
+ # seconds to wait when opening a HTTP session before rasing a
219
+ # `Timeout::Error`.
220
+ #
221
+ # @option options [Integer] :http_read_timeout (60) The default
222
+ # number of seconds to wait for response data. This value can
223
+ # safely be set
224
+ # per-request on the session yeidled by {#session_for}.
225
+ #
226
+ # @option options [Float] :http_idle_timeout (5) The number of
227
+ # seconds a connection is allowed to sit idble before it is
228
+ # considered stale. Stale connections are closed and removed
229
+ # from the pool before making a request.
230
+ #
231
+ # @option options [Float] :http_continue_timeout (1) The number of
232
+ # seconds to wait for a 100-continue response before sending the
233
+ # request body. This option has no effect unless the request has
234
+ # "Expect" header set to "100-continue". Defaults to `nil` which
235
+ # disables this behaviour. This value can safely be set per
236
+ # request on the session yeidled by {#session_for}.
237
+ #
238
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
239
+ # HTTP debug output will be sent to the `:logger`.
240
+ #
241
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
242
+ # SSL peer certificates are verified when establishing a
243
+ # connection.
244
+ #
245
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
246
+ # certificate authority bundle file that should be used when
247
+ # verifying peer certificates. If you do not pass
248
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
249
+ # will be used if available.
250
+ #
251
+ # @option options [String] :ssl_ca_directory Full path of the
252
+ # directory that contains the unbundled SSL certificate
253
+ # authority files for verifying peer certificates. If you do
254
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
255
+ # system default will be used if available.
256
+ #
257
+ def initialize(*args)
258
+ super
259
+ end
260
+
261
+ # @!group API Operations
262
+
263
+ # Creates a campaign by deploying a solution version. When a client
264
+ # calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
265
+ # APIs, a campaign is specified in the request.
266
+ #
267
+ # **Minimum Provisioned TPS and Auto-Scaling**
268
+ #
269
+ # A transaction is a single `GetRecommendations` or
270
+ # `GetPersonalizedRanking` call. Transactions per second (TPS) is the
271
+ # throughput and unit of billing for Amazon Personalize. The minimum
272
+ # provisioned TPS (`minProvisionedTPS`) specifies the baseline
273
+ # throughput provisioned by Amazon Personalize, and thus, the minimum
274
+ # billing charge. If your TPS increases beyond `minProvisionedTPS`,
275
+ # Amazon Personalize auto-scales the provisioned capacity up and down,
276
+ # but never below `minProvisionedTPS`, to maintain a 70% utilization.
277
+ # There's a short time delay while the capacity is increased that might
278
+ # cause loss of transactions. It's recommended to start with a low
279
+ # `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
280
+ # and then increase the `minProvisionedTPS` as necessary.
281
+ #
282
+ # **Status**
283
+ #
284
+ # A campaign can be in one of the following states:
285
+ #
286
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
287
+ # FAILED
288
+ #
289
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
290
+ #
291
+ # To get the campaign status, call DescribeCampaign.
292
+ #
293
+ # <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
294
+ # campaign for recommendations.
295
+ #
296
+ # </note>
297
+ #
298
+ # **Related APIs**
299
+ #
300
+ # * ListCampaigns
301
+ #
302
+ # * DescribeCampaign
303
+ #
304
+ # * UpdateCampaign
305
+ #
306
+ # * DeleteCampaign
307
+ #
308
+ #
309
+ #
310
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
311
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
312
+ #
313
+ # @option params [required, String] :name
314
+ # A name for the new campaign. The campaign name must be unique within
315
+ # your account.
316
+ #
317
+ # @option params [required, String] :solution_version_arn
318
+ # The Amazon Resource Name (ARN) of the solution version to deploy.
319
+ #
320
+ # @option params [required, Integer] :min_provisioned_tps
321
+ # Specifies the requested minimum provisioned transactions
322
+ # (recommendations) per second that Amazon Personalize will support.
323
+ #
324
+ # @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
325
+ #
326
+ # * {Types::CreateCampaignResponse#campaign_arn #campaign_arn} => String
327
+ #
328
+ # @example Request syntax with placeholder values
329
+ #
330
+ # resp = client.create_campaign({
331
+ # name: "Name", # required
332
+ # solution_version_arn: "Arn", # required
333
+ # min_provisioned_tps: 1, # required
334
+ # })
335
+ #
336
+ # @example Response structure
337
+ #
338
+ # resp.campaign_arn #=> String
339
+ #
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaign AWS API Documentation
341
+ #
342
+ # @overload create_campaign(params = {})
343
+ # @param [Hash] params ({})
344
+ def create_campaign(params = {}, options = {})
345
+ req = build_request(:create_campaign, params)
346
+ req.send_request(options)
347
+ end
348
+
349
+ # Creates an empty dataset and adds it to the specified dataset group.
350
+ # Use CreateDatasetImportJob to import your training data to a dataset.
351
+ #
352
+ # There are three types of datasets:
353
+ #
354
+ # * Interactions
355
+ #
356
+ # * Items
357
+ #
358
+ # * Users
359
+ #
360
+ # Each dataset type has an associated schema with required field types.
361
+ # Only the `Interactions` dataset is required in order to train a model
362
+ # (also referred to as creating a solution).
363
+ #
364
+ # A dataset can be in one of the following states:
365
+ #
366
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
367
+ # FAILED
368
+ #
369
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
370
+ #
371
+ # To get the status of the dataset, call DescribeDataset.
372
+ #
373
+ # **Related APIs**
374
+ #
375
+ # * CreateDatasetGroup
376
+ #
377
+ # * ListDatasets
378
+ #
379
+ # * DescribeDataset
380
+ #
381
+ # * DeleteDataset
382
+ #
383
+ # @option params [required, String] :name
384
+ # The name for the dataset.
385
+ #
386
+ # @option params [required, String] :schema_arn
387
+ # The ARN of the schema to associate with the dataset. The schema
388
+ # defines the dataset fields.
389
+ #
390
+ # @option params [required, String] :dataset_group_arn
391
+ # The Amazon Resource Name (ARN) of the dataset group to add the dataset
392
+ # to.
393
+ #
394
+ # @option params [required, String] :dataset_type
395
+ # The type of dataset.
396
+ #
397
+ # One of the following (case insensitive) values:
398
+ #
399
+ # * Interactions
400
+ #
401
+ # * Items
402
+ #
403
+ # * Users
404
+ #
405
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
406
+ #
407
+ # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
408
+ #
409
+ # @example Request syntax with placeholder values
410
+ #
411
+ # resp = client.create_dataset({
412
+ # name: "Name", # required
413
+ # schema_arn: "Arn", # required
414
+ # dataset_group_arn: "Arn", # required
415
+ # dataset_type: "DatasetType", # required
416
+ # })
417
+ #
418
+ # @example Response structure
419
+ #
420
+ # resp.dataset_arn #=> String
421
+ #
422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDataset AWS API Documentation
423
+ #
424
+ # @overload create_dataset(params = {})
425
+ # @param [Hash] params ({})
426
+ def create_dataset(params = {}, options = {})
427
+ req = build_request(:create_dataset, params)
428
+ req.send_request(options)
429
+ end
430
+
431
+ # Creates an empty dataset group. A dataset group contains related
432
+ # datasets that supply data for training a model. A dataset group can
433
+ # contain at most three datasets, one for each type of dataset:
434
+ #
435
+ # * Interactions
436
+ #
437
+ # * Items
438
+ #
439
+ # * Users
440
+ #
441
+ # To train a model (create a solution), a dataset group that contains an
442
+ # `Interactions` dataset is required. Call CreateDataset to add a
443
+ # dataset to the group.
444
+ #
445
+ # A dataset group can be in one of the following states:
446
+ #
447
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
448
+ # FAILED
449
+ #
450
+ # * DELETE PENDING
451
+ #
452
+ # To get the status of the dataset group, call DescribeDatasetGroup. If
453
+ # the status shows as CREATE FAILED, the response includes a
454
+ # `failureReason` key, which describes why the creation failed.
455
+ #
456
+ # <note markdown="1"> You must wait until the `status` of the dataset group is `ACTIVE`
457
+ # before adding a dataset to the group.
458
+ #
459
+ # </note>
460
+ #
461
+ # You can specify an AWS Key Management Service (KMS) key to encrypt the
462
+ # datasets in the group. If you specify a KMS key, you must also include
463
+ # an AWS Identity and Access Management (IAM) role that has permission
464
+ # to access the key.
465
+ #
466
+ # **APIs that require a dataset group ARN in the request**
467
+ #
468
+ # * CreateDataset
469
+ #
470
+ # * CreateEventTracker
471
+ #
472
+ # * CreateSolution
473
+ #
474
+ # **Related APIs**
475
+ #
476
+ # * ListDatasetGroups
477
+ #
478
+ # * DescribeDatasetGroup
479
+ #
480
+ # * DeleteDatasetGroup
481
+ #
482
+ # @option params [required, String] :name
483
+ # The name for the new dataset group.
484
+ #
485
+ # @option params [String] :role_arn
486
+ # The ARN of the IAM role that has permissions to access the KMS key.
487
+ # Supplying an IAM role is only valid when also specifying a KMS key.
488
+ #
489
+ # @option params [String] :kms_key_arn
490
+ # The Amazon Resource Name (ARN) of a KMS key used to encrypt the
491
+ # datasets.
492
+ #
493
+ # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
+ #
495
+ # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
496
+ #
497
+ # @example Request syntax with placeholder values
498
+ #
499
+ # resp = client.create_dataset_group({
500
+ # name: "Name", # required
501
+ # role_arn: "RoleArn",
502
+ # kms_key_arn: "KmsKeyArn",
503
+ # })
504
+ #
505
+ # @example Response structure
506
+ #
507
+ # resp.dataset_group_arn #=> String
508
+ #
509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup AWS API Documentation
510
+ #
511
+ # @overload create_dataset_group(params = {})
512
+ # @param [Hash] params ({})
513
+ def create_dataset_group(params = {}, options = {})
514
+ req = build_request(:create_dataset_group, params)
515
+ req.send_request(options)
516
+ end
517
+
518
+ # Creates a job that imports training data from your data source (an
519
+ # Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
520
+ # Personalize to import the training data, you must specify an AWS
521
+ # Identity and Access Management (IAM) role that has permission to read
522
+ # from the data source.
523
+ #
524
+ # The dataset import job replaces any previous data in the dataset.
525
+ #
526
+ # **Status**
527
+ #
528
+ # A dataset import job can be in one of the following states:
529
+ #
530
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
531
+ # FAILED
532
+ #
533
+ # ^
534
+ #
535
+ # To get the status of the import job, call DescribeDatasetImportJob,
536
+ # providing the Amazon Resource Name (ARN) of the dataset import job.
537
+ # The dataset import is complete when the status shows as ACTIVE. If the
538
+ # status shows as CREATE FAILED, the response includes a `failureReason`
539
+ # key, which describes why the job failed.
540
+ #
541
+ # <note markdown="1"> Importing takes time. You must wait until the status shows as ACTIVE
542
+ # before training a model using the dataset.
543
+ #
544
+ # </note>
545
+ #
546
+ # **Related APIs**
547
+ #
548
+ # * ListDatasetImportJobs
549
+ #
550
+ # * DescribeDatasetImportJob
551
+ #
552
+ # @option params [required, String] :job_name
553
+ # The name for the dataset import job.
554
+ #
555
+ # @option params [required, String] :dataset_arn
556
+ # The ARN of the dataset that receives the imported data.
557
+ #
558
+ # @option params [required, Types::DataSource] :data_source
559
+ # The Amazon S3 bucket that contains the training data to import.
560
+ #
561
+ # @option params [required, String] :role_arn
562
+ # The ARN of the IAM role that has permissions to read from the Amazon
563
+ # S3 data source.
564
+ #
565
+ # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
566
+ #
567
+ # * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
568
+ #
569
+ # @example Request syntax with placeholder values
570
+ #
571
+ # resp = client.create_dataset_import_job({
572
+ # job_name: "Name", # required
573
+ # dataset_arn: "Arn", # required
574
+ # data_source: { # required
575
+ # data_location: "S3Location",
576
+ # },
577
+ # role_arn: "RoleArn", # required
578
+ # })
579
+ #
580
+ # @example Response structure
581
+ #
582
+ # resp.dataset_import_job_arn #=> String
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJob AWS API Documentation
585
+ #
586
+ # @overload create_dataset_import_job(params = {})
587
+ # @param [Hash] params ({})
588
+ def create_dataset_import_job(params = {}, options = {})
589
+ req = build_request(:create_dataset_import_job, params)
590
+ req.send_request(options)
591
+ end
592
+
593
+ # Creates an event tracker that you use when sending event data to the
594
+ # specified dataset group using the [PutEvents][1] API.
595
+ #
596
+ # When Amazon Personalize creates an event tracker, it also creates an
597
+ # *event-interactions* dataset in the dataset group associated with the
598
+ # event tracker. The event-interactions dataset stores the event data
599
+ # from the `PutEvents` call. The contents of this dataset are not
600
+ # available to the user.
601
+ #
602
+ # <note markdown="1"> Only one event tracker can be associated with a dataset group. You
603
+ # will get an error if you call `CreateEventTracker` using the same
604
+ # dataset group as an existing event tracker.
605
+ #
606
+ # </note>
607
+ #
608
+ # When you send event data you include your tracking ID. The tracking ID
609
+ # identifies the customer and authorizes the customer to send the data.
610
+ #
611
+ # The event tracker can be in one of the following states:
612
+ #
613
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
614
+ # FAILED
615
+ #
616
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
617
+ #
618
+ # To get the status of the event tracker, call DescribeEventTracker.
619
+ #
620
+ # <note markdown="1"> The event tracker must be in the ACTIVE state before using the
621
+ # tracking ID.
622
+ #
623
+ # </note>
624
+ #
625
+ # **Related APIs**
626
+ #
627
+ # * ListEventTrackers
628
+ #
629
+ # * DescribeEventTracker
630
+ #
631
+ # * DeleteEventTracker
632
+ #
633
+ #
634
+ #
635
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html
636
+ #
637
+ # @option params [required, String] :name
638
+ # The name for the event tracker.
639
+ #
640
+ # @option params [required, String] :dataset_group_arn
641
+ # The Amazon Resource Name (ARN) of the dataset group that receives the
642
+ # event data.
643
+ #
644
+ # @return [Types::CreateEventTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
645
+ #
646
+ # * {Types::CreateEventTrackerResponse#event_tracker_arn #event_tracker_arn} => String
647
+ # * {Types::CreateEventTrackerResponse#tracking_id #tracking_id} => String
648
+ #
649
+ # @example Request syntax with placeholder values
650
+ #
651
+ # resp = client.create_event_tracker({
652
+ # name: "Name", # required
653
+ # dataset_group_arn: "Arn", # required
654
+ # })
655
+ #
656
+ # @example Response structure
657
+ #
658
+ # resp.event_tracker_arn #=> String
659
+ # resp.tracking_id #=> String
660
+ #
661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTracker AWS API Documentation
662
+ #
663
+ # @overload create_event_tracker(params = {})
664
+ # @param [Hash] params ({})
665
+ def create_event_tracker(params = {}, options = {})
666
+ req = build_request(:create_event_tracker, params)
667
+ req.send_request(options)
668
+ end
669
+
670
+ # Creates an Amazon Personalize schema from the specified schema string.
671
+ # The schema you create must be in Avro JSON format.
672
+ #
673
+ # Amazon Personalize recognizes three schema variants. Each schema is
674
+ # associated with a dataset type and has a set of required field and
675
+ # keywords. You specify a schema when you call CreateDataset.
676
+ #
677
+ # **Related APIs**
678
+ #
679
+ # * ListSchemas
680
+ #
681
+ # * DescribeSchema
682
+ #
683
+ # * DeleteSchema
684
+ #
685
+ # @option params [required, String] :name
686
+ # The name for the schema.
687
+ #
688
+ # @option params [required, String] :schema
689
+ # A schema in Avro JSON format.
690
+ #
691
+ # @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
692
+ #
693
+ # * {Types::CreateSchemaResponse#schema_arn #schema_arn} => String
694
+ #
695
+ # @example Request syntax with placeholder values
696
+ #
697
+ # resp = client.create_schema({
698
+ # name: "Name", # required
699
+ # schema: "AvroSchema", # required
700
+ # })
701
+ #
702
+ # @example Response structure
703
+ #
704
+ # resp.schema_arn #=> String
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchema AWS API Documentation
707
+ #
708
+ # @overload create_schema(params = {})
709
+ # @param [Hash] params ({})
710
+ def create_schema(params = {}, options = {})
711
+ req = build_request(:create_schema, params)
712
+ req.send_request(options)
713
+ end
714
+
715
+ # Creates the configuration for training a model. A trained model is
716
+ # known as a solution. After the configuration is created, you train the
717
+ # model (create a solution) by calling the CreateSolutionVersion
718
+ # operation. Every time you call `CreateSolutionVersion`, a new version
719
+ # of the solution is created.
720
+ #
721
+ # After creating a solution version, you check its accuracy by calling
722
+ # GetSolutionMetrics. When you are satisfied with the version, you
723
+ # deploy it using CreateCampaign. The campaign provides recommendations
724
+ # to a client through the [GetRecommendations][1] API.
725
+ #
726
+ # To train a model, Amazon Personalize requires training data and a
727
+ # recipe. The training data comes from the dataset group that you
728
+ # provide in the request. A recipe specifies the training algorithm and
729
+ # a feature transformation. You can specify one of the predefined
730
+ # recipes provided by Amazon Personalize. Alternatively, you can specify
731
+ # `performAutoML` and Amazon Personalize will analyze your data and
732
+ # select the optimum USER\_PERSONALIZATION recipe for you.
733
+ #
734
+ # **Status**
735
+ #
736
+ # A solution can be in one of the following states:
737
+ #
738
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
739
+ # FAILED
740
+ #
741
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
742
+ #
743
+ # To get the status of the solution, call DescribeSolution. Wait until
744
+ # the status shows as ACTIVE before calling `CreateSolutionVersion`.
745
+ #
746
+ # **Related APIs**
747
+ #
748
+ # * ListSolutions
749
+ #
750
+ # * CreateSolutionVersion
751
+ #
752
+ # * DescribeSolution
753
+ #
754
+ # * DeleteSolution
755
+ # ^
756
+ #
757
+ # * ListSolutionVersions
758
+ #
759
+ # * DescribeSolutionVersion
760
+ #
761
+ #
762
+ #
763
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
764
+ #
765
+ # @option params [required, String] :name
766
+ # The name for the solution.
767
+ #
768
+ # @option params [Boolean] :perform_hpo
769
+ # Whether to perform hyperparameter optimization (HPO) on the specified
770
+ # or selected recipe. The default is `false`.
771
+ #
772
+ # When performing AutoML, this parameter is always `true` and you should
773
+ # not set it to `false`.
774
+ #
775
+ # @option params [Boolean] :perform_auto_ml
776
+ # Whether to perform automated machine learning (AutoML). The default is
777
+ # `false`. For this case, you must specify `recipeArn`.
778
+ #
779
+ # When set to `true`, Amazon Personalize analyzes your training data and
780
+ # selects the optimal USER\_PERSONALIZATION recipe and hyperparameters.
781
+ # In this case, you must omit `recipeArn`. Amazon Personalize determines
782
+ # the optimal recipe by running tests with different values for the
783
+ # hyperparameters. AutoML lengthens the training process as compared to
784
+ # selecting a specific recipe.
785
+ #
786
+ # @option params [String] :recipe_arn
787
+ # The ARN of the recipe to use for model training. Only specified when
788
+ # `performAutoML` is false.
789
+ #
790
+ # @option params [required, String] :dataset_group_arn
791
+ # The Amazon Resource Name (ARN) of the dataset group that provides the
792
+ # training data.
793
+ #
794
+ # @option params [String] :event_type
795
+ # When your have multiple event types (using an `EVENT_TYPE` schema
796
+ # field), this parameter specifies which event type (for example,
797
+ # 'click' or 'like') is used for training the model.
798
+ #
799
+ # @option params [Types::SolutionConfig] :solution_config
800
+ # The configuration to use with the solution. When `performAutoML` is
801
+ # set to true, Amazon Personalize only evaluates the `autoMLConfig`
802
+ # section of the solution configuration.
803
+ #
804
+ # @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
805
+ #
806
+ # * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
807
+ #
808
+ # @example Request syntax with placeholder values
809
+ #
810
+ # resp = client.create_solution({
811
+ # name: "Name", # required
812
+ # perform_hpo: false,
813
+ # perform_auto_ml: false,
814
+ # recipe_arn: "Arn",
815
+ # dataset_group_arn: "Arn", # required
816
+ # event_type: "EventType",
817
+ # solution_config: {
818
+ # event_value_threshold: "EventValueThreshold",
819
+ # hpo_config: {
820
+ # hpo_objective: {
821
+ # type: "HPOObjectiveType",
822
+ # metric_name: "MetricName",
823
+ # metric_regex: "MetricRegex",
824
+ # },
825
+ # hpo_resource_config: {
826
+ # max_number_of_training_jobs: "HPOResource",
827
+ # max_parallel_training_jobs: "HPOResource",
828
+ # },
829
+ # algorithm_hyper_parameter_ranges: {
830
+ # integer_hyper_parameter_ranges: [
831
+ # {
832
+ # name: "ParameterName",
833
+ # min_value: 1,
834
+ # max_value: 1,
835
+ # },
836
+ # ],
837
+ # continuous_hyper_parameter_ranges: [
838
+ # {
839
+ # name: "ParameterName",
840
+ # min_value: 1.0,
841
+ # max_value: 1.0,
842
+ # },
843
+ # ],
844
+ # categorical_hyper_parameter_ranges: [
845
+ # {
846
+ # name: "ParameterName",
847
+ # values: ["CategoricalValue"],
848
+ # },
849
+ # ],
850
+ # },
851
+ # },
852
+ # algorithm_hyper_parameters: {
853
+ # "ParameterName" => "ParameterValue",
854
+ # },
855
+ # feature_transformation_parameters: {
856
+ # "ParameterName" => "ParameterValue",
857
+ # },
858
+ # auto_ml_config: {
859
+ # metric_name: "MetricName",
860
+ # recipe_list: ["Arn"],
861
+ # },
862
+ # },
863
+ # })
864
+ #
865
+ # @example Response structure
866
+ #
867
+ # resp.solution_arn #=> String
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolution AWS API Documentation
870
+ #
871
+ # @overload create_solution(params = {})
872
+ # @param [Hash] params ({})
873
+ def create_solution(params = {}, options = {})
874
+ req = build_request(:create_solution, params)
875
+ req.send_request(options)
876
+ end
877
+
878
+ # Trains or retrains an active solution. A solution is created using the
879
+ # CreateSolution operation and must be in the ACTIVE state before
880
+ # calling `CreateSolutionVersion`. A new version of the solution is
881
+ # created every time you call this operation.
882
+ #
883
+ # **Status**
884
+ #
885
+ # A solution version can be in one of the following states:
886
+ #
887
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
888
+ # FAILED
889
+ #
890
+ # ^
891
+ #
892
+ # To get the status of the version, call DescribeSolutionVersion. Wait
893
+ # until the status shows as ACTIVE before calling `CreateCampaign`.
894
+ #
895
+ # If the status shows as CREATE FAILED, the response includes a
896
+ # `failureReason` key, which describes why the job failed.
897
+ #
898
+ # **Related APIs**
899
+ #
900
+ # * ListSolutionVersions
901
+ #
902
+ # * DescribeSolutionVersion
903
+ # ^
904
+ #
905
+ # * ListSolutions
906
+ #
907
+ # * CreateSolution
908
+ #
909
+ # * DescribeSolution
910
+ #
911
+ # * DeleteSolution
912
+ #
913
+ # @option params [required, String] :solution_arn
914
+ # The Amazon Resource Name (ARN) of the solution containing the training
915
+ # configuration information.
916
+ #
917
+ # @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
918
+ #
919
+ # * {Types::CreateSolutionVersionResponse#solution_version_arn #solution_version_arn} => String
920
+ #
921
+ # @example Request syntax with placeholder values
922
+ #
923
+ # resp = client.create_solution_version({
924
+ # solution_arn: "Arn", # required
925
+ # })
926
+ #
927
+ # @example Response structure
928
+ #
929
+ # resp.solution_version_arn #=> String
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersion AWS API Documentation
932
+ #
933
+ # @overload create_solution_version(params = {})
934
+ # @param [Hash] params ({})
935
+ def create_solution_version(params = {}, options = {})
936
+ req = build_request(:create_solution_version, params)
937
+ req.send_request(options)
938
+ end
939
+
940
+ # Removes a campaign by deleting the solution deployment. The solution
941
+ # that the campaign is based on is not deleted and can be redeployed
942
+ # when needed. A deleted campaign can no longer be specified in a
943
+ # [GetRecommendations][1] request. For more information on campaigns,
944
+ # see CreateCampaign.
945
+ #
946
+ #
947
+ #
948
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
949
+ #
950
+ # @option params [required, String] :campaign_arn
951
+ # The Amazon Resource Name (ARN) of the campaign to delete.
952
+ #
953
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
954
+ #
955
+ # @example Request syntax with placeholder values
956
+ #
957
+ # resp = client.delete_campaign({
958
+ # campaign_arn: "Arn", # required
959
+ # })
960
+ #
961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteCampaign AWS API Documentation
962
+ #
963
+ # @overload delete_campaign(params = {})
964
+ # @param [Hash] params ({})
965
+ def delete_campaign(params = {}, options = {})
966
+ req = build_request(:delete_campaign, params)
967
+ req.send_request(options)
968
+ end
969
+
970
+ # Deletes a dataset. You can't delete a dataset if an associated
971
+ # `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN
972
+ # PROGRESS state. For more information on datasets, see CreateDataset.
973
+ #
974
+ # @option params [required, String] :dataset_arn
975
+ # The Amazon Resource Name (ARN) of the dataset to delete.
976
+ #
977
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
978
+ #
979
+ # @example Request syntax with placeholder values
980
+ #
981
+ # resp = client.delete_dataset({
982
+ # dataset_arn: "Arn", # required
983
+ # })
984
+ #
985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDataset AWS API Documentation
986
+ #
987
+ # @overload delete_dataset(params = {})
988
+ # @param [Hash] params ({})
989
+ def delete_dataset(params = {}, options = {})
990
+ req = build_request(:delete_dataset, params)
991
+ req.send_request(options)
992
+ end
993
+
994
+ # Deletes a dataset group. Before you delete a dataset group, you must
995
+ # delete the following:
996
+ #
997
+ # * All associated event trackers.
998
+ #
999
+ # * All associated solutions.
1000
+ #
1001
+ # * All datasets in the dataset group.
1002
+ #
1003
+ # @option params [required, String] :dataset_group_arn
1004
+ # The ARN of the dataset group to delete.
1005
+ #
1006
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1007
+ #
1008
+ # @example Request syntax with placeholder values
1009
+ #
1010
+ # resp = client.delete_dataset_group({
1011
+ # dataset_group_arn: "Arn", # required
1012
+ # })
1013
+ #
1014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetGroup AWS API Documentation
1015
+ #
1016
+ # @overload delete_dataset_group(params = {})
1017
+ # @param [Hash] params ({})
1018
+ def delete_dataset_group(params = {}, options = {})
1019
+ req = build_request(:delete_dataset_group, params)
1020
+ req.send_request(options)
1021
+ end
1022
+
1023
+ # Deletes the event tracker. Does not delete the event-interactions
1024
+ # dataset from the associated dataset group. For more information on
1025
+ # event trackers, see CreateEventTracker.
1026
+ #
1027
+ # @option params [required, String] :event_tracker_arn
1028
+ # The Amazon Resource Name (ARN) of the event tracker to delete.
1029
+ #
1030
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1031
+ #
1032
+ # @example Request syntax with placeholder values
1033
+ #
1034
+ # resp = client.delete_event_tracker({
1035
+ # event_tracker_arn: "Arn", # required
1036
+ # })
1037
+ #
1038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteEventTracker AWS API Documentation
1039
+ #
1040
+ # @overload delete_event_tracker(params = {})
1041
+ # @param [Hash] params ({})
1042
+ def delete_event_tracker(params = {}, options = {})
1043
+ req = build_request(:delete_event_tracker, params)
1044
+ req.send_request(options)
1045
+ end
1046
+
1047
+ # Deletes a schema. Before deleting a schema, you must delete all
1048
+ # datasets referencing the schema. For more information on schemas, see
1049
+ # CreateSchema.
1050
+ #
1051
+ # @option params [required, String] :schema_arn
1052
+ # The Amazon Resource Name (ARN) of the schema to delete.
1053
+ #
1054
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1055
+ #
1056
+ # @example Request syntax with placeholder values
1057
+ #
1058
+ # resp = client.delete_schema({
1059
+ # schema_arn: "Arn", # required
1060
+ # })
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSchema AWS API Documentation
1063
+ #
1064
+ # @overload delete_schema(params = {})
1065
+ # @param [Hash] params ({})
1066
+ def delete_schema(params = {}, options = {})
1067
+ req = build_request(:delete_schema, params)
1068
+ req.send_request(options)
1069
+ end
1070
+
1071
+ # Deletes all versions of a solution and the `Solution` object itself.
1072
+ # Before deleting a solution, you must delete all campaigns based on the
1073
+ # solution. To determine what campaigns are using the solution, call
1074
+ # ListCampaigns and supply the Amazon Resource Name (ARN) of the
1075
+ # solution. You can't delete a solution if an associated
1076
+ # `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For
1077
+ # more information on solutions, see CreateSolution.
1078
+ #
1079
+ # @option params [required, String] :solution_arn
1080
+ # The ARN of the solution to delete.
1081
+ #
1082
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1083
+ #
1084
+ # @example Request syntax with placeholder values
1085
+ #
1086
+ # resp = client.delete_solution({
1087
+ # solution_arn: "Arn", # required
1088
+ # })
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSolution AWS API Documentation
1091
+ #
1092
+ # @overload delete_solution(params = {})
1093
+ # @param [Hash] params ({})
1094
+ def delete_solution(params = {}, options = {})
1095
+ req = build_request(:delete_solution, params)
1096
+ req.send_request(options)
1097
+ end
1098
+
1099
+ # Describes the given algorithm.
1100
+ #
1101
+ # @option params [required, String] :algorithm_arn
1102
+ # The Amazon Resource Name (ARN) of the algorithm to describe.
1103
+ #
1104
+ # @return [Types::DescribeAlgorithmResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
+ #
1106
+ # * {Types::DescribeAlgorithmResponse#algorithm #algorithm} => Types::Algorithm
1107
+ #
1108
+ # @example Request syntax with placeholder values
1109
+ #
1110
+ # resp = client.describe_algorithm({
1111
+ # algorithm_arn: "Arn", # required
1112
+ # })
1113
+ #
1114
+ # @example Response structure
1115
+ #
1116
+ # resp.algorithm.name #=> String
1117
+ # resp.algorithm.algorithm_arn #=> String
1118
+ # resp.algorithm.algorithm_image.name #=> String
1119
+ # resp.algorithm.algorithm_image.docker_uri #=> String
1120
+ # resp.algorithm.default_hyper_parameters #=> Hash
1121
+ # resp.algorithm.default_hyper_parameters["ParameterName"] #=> String
1122
+ # resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
1123
+ # resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
1124
+ # resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
1125
+ # resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
1126
+ # resp.algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].is_tunable #=> Boolean
1127
+ # resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
1128
+ # resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
1129
+ # resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
1130
+ # resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
1131
+ # resp.algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].is_tunable #=> Boolean
1132
+ # resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
1133
+ # resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
1134
+ # resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
1135
+ # resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
1136
+ # resp.algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].is_tunable #=> Boolean
1137
+ # resp.algorithm.default_resource_config #=> Hash
1138
+ # resp.algorithm.default_resource_config["ParameterName"] #=> String
1139
+ # resp.algorithm.training_input_mode #=> String
1140
+ # resp.algorithm.role_arn #=> String
1141
+ # resp.algorithm.creation_date_time #=> Time
1142
+ # resp.algorithm.last_updated_date_time #=> Time
1143
+ #
1144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithm AWS API Documentation
1145
+ #
1146
+ # @overload describe_algorithm(params = {})
1147
+ # @param [Hash] params ({})
1148
+ def describe_algorithm(params = {}, options = {})
1149
+ req = build_request(:describe_algorithm, params)
1150
+ req.send_request(options)
1151
+ end
1152
+
1153
+ # Describes the given campaign, including its status.
1154
+ #
1155
+ # A campaign can be in one of the following states:
1156
+ #
1157
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1158
+ # FAILED
1159
+ #
1160
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1161
+ #
1162
+ # When the `status` is `CREATE FAILED`, the response includes the
1163
+ # `failureReason` key, which describes why.
1164
+ #
1165
+ # For more information on campaigns, see CreateCampaign.
1166
+ #
1167
+ # @option params [required, String] :campaign_arn
1168
+ # The Amazon Resource Name (ARN) of the campaign.
1169
+ #
1170
+ # @return [Types::DescribeCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1171
+ #
1172
+ # * {Types::DescribeCampaignResponse#campaign #campaign} => Types::Campaign
1173
+ #
1174
+ # @example Request syntax with placeholder values
1175
+ #
1176
+ # resp = client.describe_campaign({
1177
+ # campaign_arn: "Arn", # required
1178
+ # })
1179
+ #
1180
+ # @example Response structure
1181
+ #
1182
+ # resp.campaign.name #=> String
1183
+ # resp.campaign.campaign_arn #=> String
1184
+ # resp.campaign.solution_version_arn #=> String
1185
+ # resp.campaign.min_provisioned_tps #=> Integer
1186
+ # resp.campaign.status #=> String
1187
+ # resp.campaign.failure_reason #=> String
1188
+ # resp.campaign.creation_date_time #=> Time
1189
+ # resp.campaign.last_updated_date_time #=> Time
1190
+ # resp.campaign.latest_campaign_update.solution_version_arn #=> String
1191
+ # resp.campaign.latest_campaign_update.min_provisioned_tps #=> Integer
1192
+ # resp.campaign.latest_campaign_update.status #=> String
1193
+ # resp.campaign.latest_campaign_update.failure_reason #=> String
1194
+ # resp.campaign.latest_campaign_update.creation_date_time #=> Time
1195
+ # resp.campaign.latest_campaign_update.last_updated_date_time #=> Time
1196
+ #
1197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign AWS API Documentation
1198
+ #
1199
+ # @overload describe_campaign(params = {})
1200
+ # @param [Hash] params ({})
1201
+ def describe_campaign(params = {}, options = {})
1202
+ req = build_request(:describe_campaign, params)
1203
+ req.send_request(options)
1204
+ end
1205
+
1206
+ # Describes the given dataset. For more information on datasets, see
1207
+ # CreateDataset.
1208
+ #
1209
+ # @option params [required, String] :dataset_arn
1210
+ # The Amazon Resource Name (ARN) of the dataset to describe.
1211
+ #
1212
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1213
+ #
1214
+ # * {Types::DescribeDatasetResponse#dataset #dataset} => Types::Dataset
1215
+ #
1216
+ # @example Request syntax with placeholder values
1217
+ #
1218
+ # resp = client.describe_dataset({
1219
+ # dataset_arn: "Arn", # required
1220
+ # })
1221
+ #
1222
+ # @example Response structure
1223
+ #
1224
+ # resp.dataset.name #=> String
1225
+ # resp.dataset.dataset_arn #=> String
1226
+ # resp.dataset.dataset_group_arn #=> String
1227
+ # resp.dataset.dataset_type #=> String
1228
+ # resp.dataset.schema_arn #=> String
1229
+ # resp.dataset.status #=> String
1230
+ # resp.dataset.creation_date_time #=> Time
1231
+ # resp.dataset.last_updated_date_time #=> Time
1232
+ #
1233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset AWS API Documentation
1234
+ #
1235
+ # @overload describe_dataset(params = {})
1236
+ # @param [Hash] params ({})
1237
+ def describe_dataset(params = {}, options = {})
1238
+ req = build_request(:describe_dataset, params)
1239
+ req.send_request(options)
1240
+ end
1241
+
1242
+ # Describes the given dataset group. For more information on dataset
1243
+ # groups, see CreateDatasetGroup.
1244
+ #
1245
+ # @option params [required, String] :dataset_group_arn
1246
+ # The Amazon Resource Name (ARN) of the dataset group to describe.
1247
+ #
1248
+ # @return [Types::DescribeDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
+ #
1250
+ # * {Types::DescribeDatasetGroupResponse#dataset_group #dataset_group} => Types::DatasetGroup
1251
+ #
1252
+ # @example Request syntax with placeholder values
1253
+ #
1254
+ # resp = client.describe_dataset_group({
1255
+ # dataset_group_arn: "Arn", # required
1256
+ # })
1257
+ #
1258
+ # @example Response structure
1259
+ #
1260
+ # resp.dataset_group.name #=> String
1261
+ # resp.dataset_group.dataset_group_arn #=> String
1262
+ # resp.dataset_group.status #=> String
1263
+ # resp.dataset_group.role_arn #=> String
1264
+ # resp.dataset_group.kms_key_arn #=> String
1265
+ # resp.dataset_group.creation_date_time #=> Time
1266
+ # resp.dataset_group.last_updated_date_time #=> Time
1267
+ # resp.dataset_group.failure_reason #=> String
1268
+ #
1269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup AWS API Documentation
1270
+ #
1271
+ # @overload describe_dataset_group(params = {})
1272
+ # @param [Hash] params ({})
1273
+ def describe_dataset_group(params = {}, options = {})
1274
+ req = build_request(:describe_dataset_group, params)
1275
+ req.send_request(options)
1276
+ end
1277
+
1278
+ # Describes the dataset import job created by CreateDatasetImportJob,
1279
+ # including the import job status.
1280
+ #
1281
+ # @option params [required, String] :dataset_import_job_arn
1282
+ # The Amazon Resource Name (ARN) of the dataset import job to describe.
1283
+ #
1284
+ # @return [Types::DescribeDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1285
+ #
1286
+ # * {Types::DescribeDatasetImportJobResponse#dataset_import_job #dataset_import_job} => Types::DatasetImportJob
1287
+ #
1288
+ # @example Request syntax with placeholder values
1289
+ #
1290
+ # resp = client.describe_dataset_import_job({
1291
+ # dataset_import_job_arn: "Arn", # required
1292
+ # })
1293
+ #
1294
+ # @example Response structure
1295
+ #
1296
+ # resp.dataset_import_job.job_name #=> String
1297
+ # resp.dataset_import_job.dataset_import_job_arn #=> String
1298
+ # resp.dataset_import_job.dataset_arn #=> String
1299
+ # resp.dataset_import_job.data_source.data_location #=> String
1300
+ # resp.dataset_import_job.role_arn #=> String
1301
+ # resp.dataset_import_job.status #=> String
1302
+ # resp.dataset_import_job.creation_date_time #=> Time
1303
+ # resp.dataset_import_job.last_updated_date_time #=> Time
1304
+ # resp.dataset_import_job.failure_reason #=> String
1305
+ #
1306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJob AWS API Documentation
1307
+ #
1308
+ # @overload describe_dataset_import_job(params = {})
1309
+ # @param [Hash] params ({})
1310
+ def describe_dataset_import_job(params = {}, options = {})
1311
+ req = build_request(:describe_dataset_import_job, params)
1312
+ req.send_request(options)
1313
+ end
1314
+
1315
+ # Describes an event tracker. The response includes the `trackingId` and
1316
+ # `status` of the event tracker. For more information on event trackers,
1317
+ # see CreateEventTracker.
1318
+ #
1319
+ # @option params [required, String] :event_tracker_arn
1320
+ # The Amazon Resource Name (ARN) of the event tracker to describe.
1321
+ #
1322
+ # @return [Types::DescribeEventTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1323
+ #
1324
+ # * {Types::DescribeEventTrackerResponse#event_tracker #event_tracker} => Types::EventTracker
1325
+ #
1326
+ # @example Request syntax with placeholder values
1327
+ #
1328
+ # resp = client.describe_event_tracker({
1329
+ # event_tracker_arn: "Arn", # required
1330
+ # })
1331
+ #
1332
+ # @example Response structure
1333
+ #
1334
+ # resp.event_tracker.name #=> String
1335
+ # resp.event_tracker.event_tracker_arn #=> String
1336
+ # resp.event_tracker.account_id #=> String
1337
+ # resp.event_tracker.tracking_id #=> String
1338
+ # resp.event_tracker.dataset_group_arn #=> String
1339
+ # resp.event_tracker.status #=> String
1340
+ # resp.event_tracker.creation_date_time #=> Time
1341
+ # resp.event_tracker.last_updated_date_time #=> Time
1342
+ #
1343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTracker AWS API Documentation
1344
+ #
1345
+ # @overload describe_event_tracker(params = {})
1346
+ # @param [Hash] params ({})
1347
+ def describe_event_tracker(params = {}, options = {})
1348
+ req = build_request(:describe_event_tracker, params)
1349
+ req.send_request(options)
1350
+ end
1351
+
1352
+ # Describes the given feature transformation.
1353
+ #
1354
+ # @option params [required, String] :feature_transformation_arn
1355
+ # The Amazon Resource Name (ARN) of the feature transformation to
1356
+ # describe.
1357
+ #
1358
+ # @return [Types::DescribeFeatureTransformationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1359
+ #
1360
+ # * {Types::DescribeFeatureTransformationResponse#feature_transformation #feature_transformation} => Types::FeatureTransformation
1361
+ #
1362
+ # @example Request syntax with placeholder values
1363
+ #
1364
+ # resp = client.describe_feature_transformation({
1365
+ # feature_transformation_arn: "Arn", # required
1366
+ # })
1367
+ #
1368
+ # @example Response structure
1369
+ #
1370
+ # resp.feature_transformation.name #=> String
1371
+ # resp.feature_transformation.feature_transformation_arn #=> String
1372
+ # resp.feature_transformation.default_parameters #=> Hash
1373
+ # resp.feature_transformation.default_parameters["ParameterName"] #=> String
1374
+ # resp.feature_transformation.creation_date_time #=> Time
1375
+ # resp.feature_transformation.last_updated_date_time #=> Time
1376
+ # resp.feature_transformation.status #=> String
1377
+ #
1378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformation AWS API Documentation
1379
+ #
1380
+ # @overload describe_feature_transformation(params = {})
1381
+ # @param [Hash] params ({})
1382
+ def describe_feature_transformation(params = {}, options = {})
1383
+ req = build_request(:describe_feature_transformation, params)
1384
+ req.send_request(options)
1385
+ end
1386
+
1387
+ # Describes a recipe.
1388
+ #
1389
+ # A recipe contains three items:
1390
+ #
1391
+ # * An algorithm that trains a model.
1392
+ #
1393
+ # * Hyperparameters that govern the training.
1394
+ #
1395
+ # * Feature transformation information for modifying the input data
1396
+ # before training.
1397
+ #
1398
+ # Amazon Personalize provides a set of predefined recipes. You specify a
1399
+ # recipe when you create a solution with the CreateSolution API.
1400
+ # `CreateSolution` trains a model by using the algorithm in the
1401
+ # specified recipe and a training dataset. The solution, when deployed
1402
+ # as a campaign, can provide recommendations using the
1403
+ # [GetRecommendations][1] API.
1404
+ #
1405
+ #
1406
+ #
1407
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1408
+ #
1409
+ # @option params [required, String] :recipe_arn
1410
+ # The Amazon Resource Name (ARN) of the recipe to describe.
1411
+ #
1412
+ # @return [Types::DescribeRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1413
+ #
1414
+ # * {Types::DescribeRecipeResponse#recipe #recipe} => Types::Recipe
1415
+ #
1416
+ # @example Request syntax with placeholder values
1417
+ #
1418
+ # resp = client.describe_recipe({
1419
+ # recipe_arn: "Arn", # required
1420
+ # })
1421
+ #
1422
+ # @example Response structure
1423
+ #
1424
+ # resp.recipe.name #=> String
1425
+ # resp.recipe.recipe_arn #=> String
1426
+ # resp.recipe.algorithm_arn #=> String
1427
+ # resp.recipe.feature_transformation_arn #=> String
1428
+ # resp.recipe.status #=> String
1429
+ # resp.recipe.description #=> String
1430
+ # resp.recipe.creation_date_time #=> Time
1431
+ # resp.recipe.recipe_type #=> String
1432
+ # resp.recipe.last_updated_date_time #=> Time
1433
+ #
1434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipe AWS API Documentation
1435
+ #
1436
+ # @overload describe_recipe(params = {})
1437
+ # @param [Hash] params ({})
1438
+ def describe_recipe(params = {}, options = {})
1439
+ req = build_request(:describe_recipe, params)
1440
+ req.send_request(options)
1441
+ end
1442
+
1443
+ # Describes a schema. For more information on schemas, see CreateSchema.
1444
+ #
1445
+ # @option params [required, String] :schema_arn
1446
+ # The Amazon Resource Name (ARN) of the schema to retrieve.
1447
+ #
1448
+ # @return [Types::DescribeSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1449
+ #
1450
+ # * {Types::DescribeSchemaResponse#schema #schema} => Types::DatasetSchema
1451
+ #
1452
+ # @example Request syntax with placeholder values
1453
+ #
1454
+ # resp = client.describe_schema({
1455
+ # schema_arn: "Arn", # required
1456
+ # })
1457
+ #
1458
+ # @example Response structure
1459
+ #
1460
+ # resp.schema.name #=> String
1461
+ # resp.schema.schema_arn #=> String
1462
+ # resp.schema.schema #=> String
1463
+ # resp.schema.creation_date_time #=> Time
1464
+ # resp.schema.last_updated_date_time #=> Time
1465
+ #
1466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema AWS API Documentation
1467
+ #
1468
+ # @overload describe_schema(params = {})
1469
+ # @param [Hash] params ({})
1470
+ def describe_schema(params = {}, options = {})
1471
+ req = build_request(:describe_schema, params)
1472
+ req.send_request(options)
1473
+ end
1474
+
1475
+ # Describes a solution. For more information on solutions, see
1476
+ # CreateSolution.
1477
+ #
1478
+ # @option params [required, String] :solution_arn
1479
+ # The Amazon Resource Name (ARN) of the solution to describe.
1480
+ #
1481
+ # @return [Types::DescribeSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1482
+ #
1483
+ # * {Types::DescribeSolutionResponse#solution #solution} => Types::Solution
1484
+ #
1485
+ # @example Request syntax with placeholder values
1486
+ #
1487
+ # resp = client.describe_solution({
1488
+ # solution_arn: "Arn", # required
1489
+ # })
1490
+ #
1491
+ # @example Response structure
1492
+ #
1493
+ # resp.solution.name #=> String
1494
+ # resp.solution.solution_arn #=> String
1495
+ # resp.solution.perform_hpo #=> Boolean
1496
+ # resp.solution.perform_auto_ml #=> Boolean
1497
+ # resp.solution.recipe_arn #=> String
1498
+ # resp.solution.dataset_group_arn #=> String
1499
+ # resp.solution.event_type #=> String
1500
+ # resp.solution.solution_config.event_value_threshold #=> String
1501
+ # resp.solution.solution_config.hpo_config.hpo_objective.type #=> String
1502
+ # resp.solution.solution_config.hpo_config.hpo_objective.metric_name #=> String
1503
+ # resp.solution.solution_config.hpo_config.hpo_objective.metric_regex #=> String
1504
+ # resp.solution.solution_config.hpo_config.hpo_resource_config.max_number_of_training_jobs #=> String
1505
+ # resp.solution.solution_config.hpo_config.hpo_resource_config.max_parallel_training_jobs #=> String
1506
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
1507
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
1508
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
1509
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
1510
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
1511
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
1512
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
1513
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
1514
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
1515
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
1516
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
1517
+ # resp.solution.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
1518
+ # resp.solution.solution_config.algorithm_hyper_parameters #=> Hash
1519
+ # resp.solution.solution_config.algorithm_hyper_parameters["ParameterName"] #=> String
1520
+ # resp.solution.solution_config.feature_transformation_parameters #=> Hash
1521
+ # resp.solution.solution_config.feature_transformation_parameters["ParameterName"] #=> String
1522
+ # resp.solution.solution_config.auto_ml_config.metric_name #=> String
1523
+ # resp.solution.solution_config.auto_ml_config.recipe_list #=> Array
1524
+ # resp.solution.solution_config.auto_ml_config.recipe_list[0] #=> String
1525
+ # resp.solution.auto_ml_result.best_recipe_arn #=> String
1526
+ # resp.solution.status #=> String
1527
+ # resp.solution.creation_date_time #=> Time
1528
+ # resp.solution.last_updated_date_time #=> Time
1529
+ # resp.solution.latest_solution_version.solution_version_arn #=> String
1530
+ # resp.solution.latest_solution_version.status #=> String
1531
+ # resp.solution.latest_solution_version.creation_date_time #=> Time
1532
+ # resp.solution.latest_solution_version.last_updated_date_time #=> Time
1533
+ # resp.solution.latest_solution_version.failure_reason #=> String
1534
+ #
1535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolution AWS API Documentation
1536
+ #
1537
+ # @overload describe_solution(params = {})
1538
+ # @param [Hash] params ({})
1539
+ def describe_solution(params = {}, options = {})
1540
+ req = build_request(:describe_solution, params)
1541
+ req.send_request(options)
1542
+ end
1543
+
1544
+ # Describes a specific version of a solution. For more information on
1545
+ # solutions, see CreateSolution.
1546
+ #
1547
+ # @option params [required, String] :solution_version_arn
1548
+ # The Amazon Resource Name (ARN) of the solution version.
1549
+ #
1550
+ # @return [Types::DescribeSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1551
+ #
1552
+ # * {Types::DescribeSolutionVersionResponse#solution_version #solution_version} => Types::SolutionVersion
1553
+ #
1554
+ # @example Request syntax with placeholder values
1555
+ #
1556
+ # resp = client.describe_solution_version({
1557
+ # solution_version_arn: "Arn", # required
1558
+ # })
1559
+ #
1560
+ # @example Response structure
1561
+ #
1562
+ # resp.solution_version.solution_version_arn #=> String
1563
+ # resp.solution_version.solution_arn #=> String
1564
+ # resp.solution_version.perform_hpo #=> Boolean
1565
+ # resp.solution_version.perform_auto_ml #=> Boolean
1566
+ # resp.solution_version.recipe_arn #=> String
1567
+ # resp.solution_version.event_type #=> String
1568
+ # resp.solution_version.dataset_group_arn #=> String
1569
+ # resp.solution_version.solution_config.event_value_threshold #=> String
1570
+ # resp.solution_version.solution_config.hpo_config.hpo_objective.type #=> String
1571
+ # resp.solution_version.solution_config.hpo_config.hpo_objective.metric_name #=> String
1572
+ # resp.solution_version.solution_config.hpo_config.hpo_objective.metric_regex #=> String
1573
+ # resp.solution_version.solution_config.hpo_config.hpo_resource_config.max_number_of_training_jobs #=> String
1574
+ # resp.solution_version.solution_config.hpo_config.hpo_resource_config.max_parallel_training_jobs #=> String
1575
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges #=> Array
1576
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].name #=> String
1577
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].min_value #=> Integer
1578
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.integer_hyper_parameter_ranges[0].max_value #=> Integer
1579
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges #=> Array
1580
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].name #=> String
1581
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].min_value #=> Float
1582
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.continuous_hyper_parameter_ranges[0].max_value #=> Float
1583
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges #=> Array
1584
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].name #=> String
1585
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values #=> Array
1586
+ # resp.solution_version.solution_config.hpo_config.algorithm_hyper_parameter_ranges.categorical_hyper_parameter_ranges[0].values[0] #=> String
1587
+ # resp.solution_version.solution_config.algorithm_hyper_parameters #=> Hash
1588
+ # resp.solution_version.solution_config.algorithm_hyper_parameters["ParameterName"] #=> String
1589
+ # resp.solution_version.solution_config.feature_transformation_parameters #=> Hash
1590
+ # resp.solution_version.solution_config.feature_transformation_parameters["ParameterName"] #=> String
1591
+ # resp.solution_version.solution_config.auto_ml_config.metric_name #=> String
1592
+ # resp.solution_version.solution_config.auto_ml_config.recipe_list #=> Array
1593
+ # resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
1594
+ # resp.solution_version.status #=> String
1595
+ # resp.solution_version.failure_reason #=> String
1596
+ # resp.solution_version.creation_date_time #=> Time
1597
+ # resp.solution_version.last_updated_date_time #=> Time
1598
+ #
1599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersion AWS API Documentation
1600
+ #
1601
+ # @overload describe_solution_version(params = {})
1602
+ # @param [Hash] params ({})
1603
+ def describe_solution_version(params = {}, options = {})
1604
+ req = build_request(:describe_solution_version, params)
1605
+ req.send_request(options)
1606
+ end
1607
+
1608
+ # Gets the metrics for the specified solution version.
1609
+ #
1610
+ # @option params [required, String] :solution_version_arn
1611
+ # The Amazon Resource Name (ARN) of the solution version for which to
1612
+ # get metrics.
1613
+ #
1614
+ # @return [Types::GetSolutionMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1615
+ #
1616
+ # * {Types::GetSolutionMetricsResponse#solution_version_arn #solution_version_arn} => String
1617
+ # * {Types::GetSolutionMetricsResponse#metrics #metrics} => Hash&lt;String,Float&gt;
1618
+ #
1619
+ # @example Request syntax with placeholder values
1620
+ #
1621
+ # resp = client.get_solution_metrics({
1622
+ # solution_version_arn: "Arn", # required
1623
+ # })
1624
+ #
1625
+ # @example Response structure
1626
+ #
1627
+ # resp.solution_version_arn #=> String
1628
+ # resp.metrics #=> Hash
1629
+ # resp.metrics["MetricName"] #=> Float
1630
+ #
1631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetrics AWS API Documentation
1632
+ #
1633
+ # @overload get_solution_metrics(params = {})
1634
+ # @param [Hash] params ({})
1635
+ def get_solution_metrics(params = {}, options = {})
1636
+ req = build_request(:get_solution_metrics, params)
1637
+ req.send_request(options)
1638
+ end
1639
+
1640
+ # Returns a list of campaigns that use the given solution. When a
1641
+ # solution is not specified, all the campaigns associated with the
1642
+ # account are listed. The response provides the properties for each
1643
+ # campaign, including the Amazon Resource Name (ARN). For more
1644
+ # information on campaigns, see CreateCampaign.
1645
+ #
1646
+ # @option params [String] :solution_arn
1647
+ # The Amazon Resource Name (ARN) of the solution to list the campaigns
1648
+ # for. When a solution is not specified, all the campaigns associated
1649
+ # with the account are listed.
1650
+ #
1651
+ # @option params [String] :next_token
1652
+ # A token returned from the previous call to `ListCampaigns` for getting
1653
+ # the next set of campaigns (if they exist).
1654
+ #
1655
+ # @option params [Integer] :max_results
1656
+ # The maximum number of campaigns to return.
1657
+ #
1658
+ # @return [Types::ListCampaignsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1659
+ #
1660
+ # * {Types::ListCampaignsResponse#campaigns #campaigns} => Array&lt;Types::CampaignSummary&gt;
1661
+ # * {Types::ListCampaignsResponse#next_token #next_token} => String
1662
+ #
1663
+ # @example Request syntax with placeholder values
1664
+ #
1665
+ # resp = client.list_campaigns({
1666
+ # solution_arn: "Arn",
1667
+ # next_token: "NextToken",
1668
+ # max_results: 1,
1669
+ # })
1670
+ #
1671
+ # @example Response structure
1672
+ #
1673
+ # resp.campaigns #=> Array
1674
+ # resp.campaigns[0].name #=> String
1675
+ # resp.campaigns[0].campaign_arn #=> String
1676
+ # resp.campaigns[0].status #=> String
1677
+ # resp.campaigns[0].creation_date_time #=> Time
1678
+ # resp.campaigns[0].last_updated_date_time #=> Time
1679
+ # resp.campaigns[0].failure_reason #=> String
1680
+ # resp.next_token #=> String
1681
+ #
1682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns AWS API Documentation
1683
+ #
1684
+ # @overload list_campaigns(params = {})
1685
+ # @param [Hash] params ({})
1686
+ def list_campaigns(params = {}, options = {})
1687
+ req = build_request(:list_campaigns, params)
1688
+ req.send_request(options)
1689
+ end
1690
+
1691
+ # Returns a list of dataset groups. The response provides the properties
1692
+ # for each dataset group, including the Amazon Resource Name (ARN). For
1693
+ # more information on dataset groups, see CreateDatasetGroup.
1694
+ #
1695
+ # @option params [String] :next_token
1696
+ # A token returned from the previous call to `ListDatasetGroups` for
1697
+ # getting the next set of dataset groups (if they exist).
1698
+ #
1699
+ # @option params [Integer] :max_results
1700
+ # The maximum number of dataset groups to return.
1701
+ #
1702
+ # @return [Types::ListDatasetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1703
+ #
1704
+ # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array&lt;Types::DatasetGroupSummary&gt;
1705
+ # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
1706
+ #
1707
+ # @example Request syntax with placeholder values
1708
+ #
1709
+ # resp = client.list_dataset_groups({
1710
+ # next_token: "NextToken",
1711
+ # max_results: 1,
1712
+ # })
1713
+ #
1714
+ # @example Response structure
1715
+ #
1716
+ # resp.dataset_groups #=> Array
1717
+ # resp.dataset_groups[0].name #=> String
1718
+ # resp.dataset_groups[0].dataset_group_arn #=> String
1719
+ # resp.dataset_groups[0].status #=> String
1720
+ # resp.dataset_groups[0].creation_date_time #=> Time
1721
+ # resp.dataset_groups[0].last_updated_date_time #=> Time
1722
+ # resp.dataset_groups[0].failure_reason #=> String
1723
+ # resp.next_token #=> String
1724
+ #
1725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups AWS API Documentation
1726
+ #
1727
+ # @overload list_dataset_groups(params = {})
1728
+ # @param [Hash] params ({})
1729
+ def list_dataset_groups(params = {}, options = {})
1730
+ req = build_request(:list_dataset_groups, params)
1731
+ req.send_request(options)
1732
+ end
1733
+
1734
+ # Returns a list of dataset import jobs that use the given dataset. When
1735
+ # a dataset is not specified, all the dataset import jobs associated
1736
+ # with the account are listed. The response provides the properties for
1737
+ # each dataset import job, including the Amazon Resource Name (ARN). For
1738
+ # more information on dataset import jobs, see CreateDatasetImportJob.
1739
+ # For more information on datasets, see CreateDataset.
1740
+ #
1741
+ # @option params [String] :dataset_arn
1742
+ # The Amazon Resource Name (ARN) of the dataset to list the dataset
1743
+ # import jobs for.
1744
+ #
1745
+ # @option params [String] :next_token
1746
+ # A token returned from the previous call to `ListDatasetImportJobs` for
1747
+ # getting the next set of dataset import jobs (if they exist).
1748
+ #
1749
+ # @option params [Integer] :max_results
1750
+ # The maximum number of dataset import jobs to return.
1751
+ #
1752
+ # @return [Types::ListDatasetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1753
+ #
1754
+ # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array&lt;Types::DatasetImportJobSummary&gt;
1755
+ # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
1756
+ #
1757
+ # @example Request syntax with placeholder values
1758
+ #
1759
+ # resp = client.list_dataset_import_jobs({
1760
+ # dataset_arn: "Arn",
1761
+ # next_token: "NextToken",
1762
+ # max_results: 1,
1763
+ # })
1764
+ #
1765
+ # @example Response structure
1766
+ #
1767
+ # resp.dataset_import_jobs #=> Array
1768
+ # resp.dataset_import_jobs[0].dataset_import_job_arn #=> String
1769
+ # resp.dataset_import_jobs[0].job_name #=> String
1770
+ # resp.dataset_import_jobs[0].status #=> String
1771
+ # resp.dataset_import_jobs[0].creation_date_time #=> Time
1772
+ # resp.dataset_import_jobs[0].last_updated_date_time #=> Time
1773
+ # resp.dataset_import_jobs[0].failure_reason #=> String
1774
+ # resp.next_token #=> String
1775
+ #
1776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobs AWS API Documentation
1777
+ #
1778
+ # @overload list_dataset_import_jobs(params = {})
1779
+ # @param [Hash] params ({})
1780
+ def list_dataset_import_jobs(params = {}, options = {})
1781
+ req = build_request(:list_dataset_import_jobs, params)
1782
+ req.send_request(options)
1783
+ end
1784
+
1785
+ # Returns the list of datasets contained in the given dataset group. The
1786
+ # response provides the properties for each dataset, including the
1787
+ # Amazon Resource Name (ARN). For more information on datasets, see
1788
+ # CreateDataset.
1789
+ #
1790
+ # @option params [String] :dataset_group_arn
1791
+ # The Amazon Resource Name (ARN) of the dataset group that contains the
1792
+ # datasets to list.
1793
+ #
1794
+ # @option params [String] :next_token
1795
+ # A token returned from the previous call to `ListDatasetImportJobs` for
1796
+ # getting the next set of dataset import jobs (if they exist).
1797
+ #
1798
+ # @option params [Integer] :max_results
1799
+ # The maximum number of datasets to return.
1800
+ #
1801
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1802
+ #
1803
+ # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::DatasetSummary&gt;
1804
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
1805
+ #
1806
+ # @example Request syntax with placeholder values
1807
+ #
1808
+ # resp = client.list_datasets({
1809
+ # dataset_group_arn: "Arn",
1810
+ # next_token: "NextToken",
1811
+ # max_results: 1,
1812
+ # })
1813
+ #
1814
+ # @example Response structure
1815
+ #
1816
+ # resp.datasets #=> Array
1817
+ # resp.datasets[0].name #=> String
1818
+ # resp.datasets[0].dataset_arn #=> String
1819
+ # resp.datasets[0].dataset_type #=> String
1820
+ # resp.datasets[0].status #=> String
1821
+ # resp.datasets[0].creation_date_time #=> Time
1822
+ # resp.datasets[0].last_updated_date_time #=> Time
1823
+ # resp.next_token #=> String
1824
+ #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasets AWS API Documentation
1826
+ #
1827
+ # @overload list_datasets(params = {})
1828
+ # @param [Hash] params ({})
1829
+ def list_datasets(params = {}, options = {})
1830
+ req = build_request(:list_datasets, params)
1831
+ req.send_request(options)
1832
+ end
1833
+
1834
+ # Returns the list of event trackers associated with the account. The
1835
+ # response provides the properties for each event tracker, including the
1836
+ # Amazon Resource Name (ARN) and tracking ID. For more information on
1837
+ # event trackers, see CreateEventTracker.
1838
+ #
1839
+ # @option params [String] :dataset_group_arn
1840
+ # The ARN of a dataset group used to filter the response.
1841
+ #
1842
+ # @option params [String] :next_token
1843
+ # A token returned from the previous call to `ListEventTrackers` for
1844
+ # getting the next set of event trackers (if they exist).
1845
+ #
1846
+ # @option params [Integer] :max_results
1847
+ # The maximum number of event trackers to return.
1848
+ #
1849
+ # @return [Types::ListEventTrackersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1850
+ #
1851
+ # * {Types::ListEventTrackersResponse#event_trackers #event_trackers} => Array&lt;Types::EventTrackerSummary&gt;
1852
+ # * {Types::ListEventTrackersResponse#next_token #next_token} => String
1853
+ #
1854
+ # @example Request syntax with placeholder values
1855
+ #
1856
+ # resp = client.list_event_trackers({
1857
+ # dataset_group_arn: "Arn",
1858
+ # next_token: "NextToken",
1859
+ # max_results: 1,
1860
+ # })
1861
+ #
1862
+ # @example Response structure
1863
+ #
1864
+ # resp.event_trackers #=> Array
1865
+ # resp.event_trackers[0].name #=> String
1866
+ # resp.event_trackers[0].event_tracker_arn #=> String
1867
+ # resp.event_trackers[0].status #=> String
1868
+ # resp.event_trackers[0].creation_date_time #=> Time
1869
+ # resp.event_trackers[0].last_updated_date_time #=> Time
1870
+ # resp.next_token #=> String
1871
+ #
1872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackers AWS API Documentation
1873
+ #
1874
+ # @overload list_event_trackers(params = {})
1875
+ # @param [Hash] params ({})
1876
+ def list_event_trackers(params = {}, options = {})
1877
+ req = build_request(:list_event_trackers, params)
1878
+ req.send_request(options)
1879
+ end
1880
+
1881
+ # Returns a list of available recipes. The response provides the
1882
+ # properties for each recipe, including the recipe's Amazon Resource
1883
+ # Name (ARN).
1884
+ #
1885
+ # @option params [String] :recipe_provider
1886
+ # The default is `SERVICE`.
1887
+ #
1888
+ # @option params [String] :next_token
1889
+ # A token returned from the previous call to `ListRecipes` for getting
1890
+ # the next set of recipes (if they exist).
1891
+ #
1892
+ # @option params [Integer] :max_results
1893
+ # The maximum number of recipes to return.
1894
+ #
1895
+ # @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1896
+ #
1897
+ # * {Types::ListRecipesResponse#recipes #recipes} => Array&lt;Types::RecipeSummary&gt;
1898
+ # * {Types::ListRecipesResponse#next_token #next_token} => String
1899
+ #
1900
+ # @example Request syntax with placeholder values
1901
+ #
1902
+ # resp = client.list_recipes({
1903
+ # recipe_provider: "SERVICE", # accepts SERVICE
1904
+ # next_token: "NextToken",
1905
+ # max_results: 1,
1906
+ # })
1907
+ #
1908
+ # @example Response structure
1909
+ #
1910
+ # resp.recipes #=> Array
1911
+ # resp.recipes[0].name #=> String
1912
+ # resp.recipes[0].recipe_arn #=> String
1913
+ # resp.recipes[0].status #=> String
1914
+ # resp.recipes[0].creation_date_time #=> Time
1915
+ # resp.recipes[0].last_updated_date_time #=> Time
1916
+ # resp.next_token #=> String
1917
+ #
1918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes AWS API Documentation
1919
+ #
1920
+ # @overload list_recipes(params = {})
1921
+ # @param [Hash] params ({})
1922
+ def list_recipes(params = {}, options = {})
1923
+ req = build_request(:list_recipes, params)
1924
+ req.send_request(options)
1925
+ end
1926
+
1927
+ # Returns the list of schemas associated with the account. The response
1928
+ # provides the properties for each schema, including the Amazon Resource
1929
+ # Name (ARN). For more information on schemas, see CreateSchema.
1930
+ #
1931
+ # @option params [String] :next_token
1932
+ # A token returned from the previous call to `ListSchemas` for getting
1933
+ # the next set of schemas (if they exist).
1934
+ #
1935
+ # @option params [Integer] :max_results
1936
+ # The maximum number of schemas to return.
1937
+ #
1938
+ # @return [Types::ListSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1939
+ #
1940
+ # * {Types::ListSchemasResponse#schemas #schemas} => Array&lt;Types::DatasetSchemaSummary&gt;
1941
+ # * {Types::ListSchemasResponse#next_token #next_token} => String
1942
+ #
1943
+ # @example Request syntax with placeholder values
1944
+ #
1945
+ # resp = client.list_schemas({
1946
+ # next_token: "NextToken",
1947
+ # max_results: 1,
1948
+ # })
1949
+ #
1950
+ # @example Response structure
1951
+ #
1952
+ # resp.schemas #=> Array
1953
+ # resp.schemas[0].name #=> String
1954
+ # resp.schemas[0].schema_arn #=> String
1955
+ # resp.schemas[0].creation_date_time #=> Time
1956
+ # resp.schemas[0].last_updated_date_time #=> Time
1957
+ # resp.next_token #=> String
1958
+ #
1959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas AWS API Documentation
1960
+ #
1961
+ # @overload list_schemas(params = {})
1962
+ # @param [Hash] params ({})
1963
+ def list_schemas(params = {}, options = {})
1964
+ req = build_request(:list_schemas, params)
1965
+ req.send_request(options)
1966
+ end
1967
+
1968
+ # Returns a list of solution versions for the given solution. When a
1969
+ # solution is not specified, all the solution versions associated with
1970
+ # the account are listed. The response provides the properties for each
1971
+ # solution version, including the Amazon Resource Name (ARN). For more
1972
+ # information on solutions, see CreateSolution.
1973
+ #
1974
+ # @option params [String] :solution_arn
1975
+ # The Amazon Resource Name (ARN) of the solution.
1976
+ #
1977
+ # @option params [String] :next_token
1978
+ # A token returned from the previous call to `ListSolutionVersions` for
1979
+ # getting the next set of solution versions (if they exist).
1980
+ #
1981
+ # @option params [Integer] :max_results
1982
+ # The maximum number of solution versions to return.
1983
+ #
1984
+ # @return [Types::ListSolutionVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1985
+ #
1986
+ # * {Types::ListSolutionVersionsResponse#solution_versions #solution_versions} => Array&lt;Types::SolutionVersionSummary&gt;
1987
+ # * {Types::ListSolutionVersionsResponse#next_token #next_token} => String
1988
+ #
1989
+ # @example Request syntax with placeholder values
1990
+ #
1991
+ # resp = client.list_solution_versions({
1992
+ # solution_arn: "Arn",
1993
+ # next_token: "NextToken",
1994
+ # max_results: 1,
1995
+ # })
1996
+ #
1997
+ # @example Response structure
1998
+ #
1999
+ # resp.solution_versions #=> Array
2000
+ # resp.solution_versions[0].solution_version_arn #=> String
2001
+ # resp.solution_versions[0].status #=> String
2002
+ # resp.solution_versions[0].creation_date_time #=> Time
2003
+ # resp.solution_versions[0].last_updated_date_time #=> Time
2004
+ # resp.solution_versions[0].failure_reason #=> String
2005
+ # resp.next_token #=> String
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersions AWS API Documentation
2008
+ #
2009
+ # @overload list_solution_versions(params = {})
2010
+ # @param [Hash] params ({})
2011
+ def list_solution_versions(params = {}, options = {})
2012
+ req = build_request(:list_solution_versions, params)
2013
+ req.send_request(options)
2014
+ end
2015
+
2016
+ # Returns a list of solutions that use the given dataset group. When a
2017
+ # dataset group is not specified, all the solutions associated with the
2018
+ # account are listed. The response provides the properties for each
2019
+ # solution, including the Amazon Resource Name (ARN). For more
2020
+ # information on solutions, see CreateSolution.
2021
+ #
2022
+ # @option params [String] :dataset_group_arn
2023
+ # The Amazon Resource Name (ARN) of the dataset group.
2024
+ #
2025
+ # @option params [String] :next_token
2026
+ # A token returned from the previous call to `ListSolutions` for getting
2027
+ # the next set of solutions (if they exist).
2028
+ #
2029
+ # @option params [Integer] :max_results
2030
+ # The maximum number of solutions to return.
2031
+ #
2032
+ # @return [Types::ListSolutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2033
+ #
2034
+ # * {Types::ListSolutionsResponse#solutions #solutions} => Array&lt;Types::SolutionSummary&gt;
2035
+ # * {Types::ListSolutionsResponse#next_token #next_token} => String
2036
+ #
2037
+ # @example Request syntax with placeholder values
2038
+ #
2039
+ # resp = client.list_solutions({
2040
+ # dataset_group_arn: "Arn",
2041
+ # next_token: "NextToken",
2042
+ # max_results: 1,
2043
+ # })
2044
+ #
2045
+ # @example Response structure
2046
+ #
2047
+ # resp.solutions #=> Array
2048
+ # resp.solutions[0].name #=> String
2049
+ # resp.solutions[0].solution_arn #=> String
2050
+ # resp.solutions[0].status #=> String
2051
+ # resp.solutions[0].creation_date_time #=> Time
2052
+ # resp.solutions[0].last_updated_date_time #=> Time
2053
+ # resp.next_token #=> String
2054
+ #
2055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutions AWS API Documentation
2056
+ #
2057
+ # @overload list_solutions(params = {})
2058
+ # @param [Hash] params ({})
2059
+ def list_solutions(params = {}, options = {})
2060
+ req = build_request(:list_solutions, params)
2061
+ req.send_request(options)
2062
+ end
2063
+
2064
+ # Updates a campaign by either deploying a new solution or changing the
2065
+ # value of the campaign's `minProvisionedTPS` parameter.
2066
+ #
2067
+ # To update a campaign, the campaign status must be ACTIVE or CREATE
2068
+ # FAILED. Check the campaign status using the DescribeCampaign API.
2069
+ #
2070
+ # <note markdown="1"> You must wait until the `status` of the updated campaign is `ACTIVE`
2071
+ # before asking the campaign for recommendations.
2072
+ #
2073
+ # </note>
2074
+ #
2075
+ # For more information on campaigns, see CreateCampaign.
2076
+ #
2077
+ # @option params [required, String] :campaign_arn
2078
+ # The Amazon Resource Name (ARN) of the campaign.
2079
+ #
2080
+ # @option params [String] :solution_version_arn
2081
+ # The ARN of a new solution version to deploy.
2082
+ #
2083
+ # @option params [Integer] :min_provisioned_tps
2084
+ # Specifies the requested minimum provisioned transactions
2085
+ # (recommendations) per second that Amazon Personalize will support.
2086
+ #
2087
+ # @return [Types::UpdateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2088
+ #
2089
+ # * {Types::UpdateCampaignResponse#campaign_arn #campaign_arn} => String
2090
+ #
2091
+ # @example Request syntax with placeholder values
2092
+ #
2093
+ # resp = client.update_campaign({
2094
+ # campaign_arn: "Arn", # required
2095
+ # solution_version_arn: "Arn",
2096
+ # min_provisioned_tps: 1,
2097
+ # })
2098
+ #
2099
+ # @example Response structure
2100
+ #
2101
+ # resp.campaign_arn #=> String
2102
+ #
2103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign AWS API Documentation
2104
+ #
2105
+ # @overload update_campaign(params = {})
2106
+ # @param [Hash] params ({})
2107
+ def update_campaign(params = {}, options = {})
2108
+ req = build_request(:update_campaign, params)
2109
+ req.send_request(options)
2110
+ end
2111
+
2112
+ # @!endgroup
2113
+
2114
+ # @param params ({})
2115
+ # @api private
2116
+ def build_request(operation_name, params = {})
2117
+ handlers = @handlers.for(operation_name)
2118
+ context = Seahorse::Client::RequestContext.new(
2119
+ operation_name: operation_name,
2120
+ operation: config.api.operation(operation_name),
2121
+ client: self,
2122
+ params: params,
2123
+ config: config)
2124
+ context[:gem_name] = 'aws-sdk-personalize'
2125
+ context[:gem_version] = '1.0.0'
2126
+ Seahorse::Client::Request.new(handlers, context)
2127
+ end
2128
+
2129
+ # @api private
2130
+ # @deprecated
2131
+ def waiter_names
2132
+ []
2133
+ end
2134
+
2135
+ class << self
2136
+
2137
+ # @api private
2138
+ attr_reader :identifier
2139
+
2140
+ # @api private
2141
+ def errors_module
2142
+ Errors
2143
+ end
2144
+
2145
+ end
2146
+ end
2147
+ end