aws-sdk-personalize 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
File without changes
@@ -0,0 +1,110 @@
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
+ module Aws::Personalize
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ class InvalidInputException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::Personalize::Types::InvalidInputException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def message
24
+ @message || @data[:message]
25
+ end
26
+
27
+ end
28
+
29
+ class InvalidNextTokenException < ServiceError
30
+
31
+ # @param [Seahorse::Client::RequestContext] context
32
+ # @param [String] message
33
+ # @param [Aws::Personalize::Types::InvalidNextTokenException] data
34
+ def initialize(context, message, data = Aws::EmptyStructure.new)
35
+ super(context, message, data)
36
+ end
37
+
38
+ # @return [String]
39
+ def message
40
+ @message || @data[:message]
41
+ end
42
+
43
+ end
44
+
45
+ class LimitExceededException < ServiceError
46
+
47
+ # @param [Seahorse::Client::RequestContext] context
48
+ # @param [String] message
49
+ # @param [Aws::Personalize::Types::LimitExceededException] data
50
+ def initialize(context, message, data = Aws::EmptyStructure.new)
51
+ super(context, message, data)
52
+ end
53
+
54
+ # @return [String]
55
+ def message
56
+ @message || @data[:message]
57
+ end
58
+
59
+ end
60
+
61
+ class ResourceAlreadyExistsException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::Personalize::Types::ResourceAlreadyExistsException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
77
+ class ResourceInUseException < ServiceError
78
+
79
+ # @param [Seahorse::Client::RequestContext] context
80
+ # @param [String] message
81
+ # @param [Aws::Personalize::Types::ResourceInUseException] data
82
+ def initialize(context, message, data = Aws::EmptyStructure.new)
83
+ super(context, message, data)
84
+ end
85
+
86
+ # @return [String]
87
+ def message
88
+ @message || @data[:message]
89
+ end
90
+
91
+ end
92
+
93
+ class ResourceNotFoundException < ServiceError
94
+
95
+ # @param [Seahorse::Client::RequestContext] context
96
+ # @param [String] message
97
+ # @param [Aws::Personalize::Types::ResourceNotFoundException] data
98
+ def initialize(context, message, data = Aws::EmptyStructure.new)
99
+ super(context, message, data)
100
+ end
101
+
102
+ # @return [String]
103
+ def message
104
+ @message || @data[:message]
105
+ end
106
+
107
+ end
108
+
109
+ end
110
+ end
@@ -0,0 +1,23 @@
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
+ module Aws::Personalize
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,3131 @@
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
+ module Aws::Personalize
9
+ module Types
10
+
11
+ # Describes a custom algorithm.
12
+ #
13
+ # @!attribute [rw] name
14
+ # The name of the algorithm.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] algorithm_arn
18
+ # The Amazon Resource Name (ARN) of the algorithm.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] algorithm_image
22
+ # The URI of the Docker container for the algorithm image.
23
+ # @return [Types::AlgorithmImage]
24
+ #
25
+ # @!attribute [rw] default_hyper_parameters
26
+ # Specifies the default hyperparameters.
27
+ # @return [Hash<String,String>]
28
+ #
29
+ # @!attribute [rw] default_hyper_parameter_ranges
30
+ # Specifies the default hyperparameters, their ranges, and whether
31
+ # they are tunable. A tunable hyperparameter can have its value
32
+ # determined during hyperparameter optimization (HPO).
33
+ # @return [Types::DefaultHyperParameterRanges]
34
+ #
35
+ # @!attribute [rw] default_resource_config
36
+ # Specifies the default maximum number of training jobs and parallel
37
+ # training jobs.
38
+ # @return [Hash<String,String>]
39
+ #
40
+ # @!attribute [rw] training_input_mode
41
+ # The training input mode.
42
+ # @return [String]
43
+ #
44
+ # @!attribute [rw] role_arn
45
+ # The Amazon Resource Name (ARN) of the role.
46
+ # @return [String]
47
+ #
48
+ # @!attribute [rw] creation_date_time
49
+ # The date and time (in Unix time) that the algorithm was created.
50
+ # @return [Time]
51
+ #
52
+ # @!attribute [rw] last_updated_date_time
53
+ # The date and time (in Unix time) that the algorithm was last
54
+ # updated.
55
+ # @return [Time]
56
+ #
57
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Algorithm AWS API Documentation
58
+ #
59
+ class Algorithm < Struct.new(
60
+ :name,
61
+ :algorithm_arn,
62
+ :algorithm_image,
63
+ :default_hyper_parameters,
64
+ :default_hyper_parameter_ranges,
65
+ :default_resource_config,
66
+ :training_input_mode,
67
+ :role_arn,
68
+ :creation_date_time,
69
+ :last_updated_date_time)
70
+ include Aws::Structure
71
+ end
72
+
73
+ # Describes an algorithm image.
74
+ #
75
+ # @!attribute [rw] name
76
+ # The name of the algorithm image.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] docker_uri
80
+ # The URI of the Docker container for the algorithm image.
81
+ # @return [String]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/AlgorithmImage AWS API Documentation
84
+ #
85
+ class AlgorithmImage < Struct.new(
86
+ :name,
87
+ :docker_uri)
88
+ include Aws::Structure
89
+ end
90
+
91
+ # When the solution performs AutoML (`performAutoML` is true in
92
+ # CreateSolution), Amazon Personalize determines which recipe, from the
93
+ # specified list, optimizes the given metric. Amazon Personalize then
94
+ # uses that recipe for the solution.
95
+ #
96
+ # @note When making an API call, you may pass AutoMLConfig
97
+ # data as a hash:
98
+ #
99
+ # {
100
+ # metric_name: "MetricName",
101
+ # recipe_list: ["Arn"],
102
+ # }
103
+ #
104
+ # @!attribute [rw] metric_name
105
+ # The metric to optimize.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] recipe_list
109
+ # The list of candidate recipes.
110
+ # @return [Array<String>]
111
+ #
112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/AutoMLConfig AWS API Documentation
113
+ #
114
+ class AutoMLConfig < Struct.new(
115
+ :metric_name,
116
+ :recipe_list)
117
+ include Aws::Structure
118
+ end
119
+
120
+ # When the solution performs AutoML (`performAutoML` is true in
121
+ # CreateSolution), specifies the recipe that best optimized the
122
+ # specified metric.
123
+ #
124
+ # @!attribute [rw] best_recipe_arn
125
+ # The Amazon Resource Name (ARN) of the best recipe.
126
+ # @return [String]
127
+ #
128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/AutoMLResult AWS API Documentation
129
+ #
130
+ class AutoMLResult < Struct.new(
131
+ :best_recipe_arn)
132
+ include Aws::Structure
133
+ end
134
+
135
+ # Describes a deployed solution version, otherwise known as a campaign.
136
+ # For more information on campaigns, see CreateCampaign.
137
+ #
138
+ # @!attribute [rw] name
139
+ # The name of the campaign.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] campaign_arn
143
+ # The Amazon Resource Name (ARN) of the campaign.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] solution_version_arn
147
+ # The Amazon Resource Name (ARN) of a specific version of the
148
+ # solution.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] min_provisioned_tps
152
+ # Specifies the requested minimum provisioned transactions
153
+ # (recommendations) per second.
154
+ # @return [Integer]
155
+ #
156
+ # @!attribute [rw] status
157
+ # The status of the campaign.
158
+ #
159
+ # A campaign can be in one of the following states:
160
+ #
161
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
162
+ # FAILED
163
+ #
164
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] failure_reason
168
+ # If a campaign fails, the reason behind the failure.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] creation_date_time
172
+ # The date and time (in Unix format) that the campaign was created.
173
+ # @return [Time]
174
+ #
175
+ # @!attribute [rw] last_updated_date_time
176
+ # The date and time (in Unix format) that the campaign was last
177
+ # updated.
178
+ # @return [Time]
179
+ #
180
+ # @!attribute [rw] latest_campaign_update
181
+ # Provides a summary of the properties of a campaign update. For a
182
+ # complete listing, call the DescribeCampaign API.
183
+ # @return [Types::CampaignUpdateSummary]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Campaign AWS API Documentation
186
+ #
187
+ class Campaign < Struct.new(
188
+ :name,
189
+ :campaign_arn,
190
+ :solution_version_arn,
191
+ :min_provisioned_tps,
192
+ :status,
193
+ :failure_reason,
194
+ :creation_date_time,
195
+ :last_updated_date_time,
196
+ :latest_campaign_update)
197
+ include Aws::Structure
198
+ end
199
+
200
+ # Provides a summary of the properties of a campaign. For a complete
201
+ # listing, call the DescribeCampaign API.
202
+ #
203
+ # @!attribute [rw] name
204
+ # The name of the campaign.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] campaign_arn
208
+ # The Amazon Resource Name (ARN) of the campaign.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] status
212
+ # The status of the campaign.
213
+ #
214
+ # A campaign can be in one of the following states:
215
+ #
216
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
217
+ # FAILED
218
+ #
219
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] creation_date_time
223
+ # The date and time (in Unix time) that the campaign was created.
224
+ # @return [Time]
225
+ #
226
+ # @!attribute [rw] last_updated_date_time
227
+ # The date and time (in Unix time) that the campaign was last updated.
228
+ # @return [Time]
229
+ #
230
+ # @!attribute [rw] failure_reason
231
+ # If a campaign fails, the reason behind the failure.
232
+ # @return [String]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignSummary AWS API Documentation
235
+ #
236
+ class CampaignSummary < Struct.new(
237
+ :name,
238
+ :campaign_arn,
239
+ :status,
240
+ :creation_date_time,
241
+ :last_updated_date_time,
242
+ :failure_reason)
243
+ include Aws::Structure
244
+ end
245
+
246
+ # Provides a summary of the properties of a campaign update. For a
247
+ # complete listing, call the DescribeCampaign API.
248
+ #
249
+ # @!attribute [rw] solution_version_arn
250
+ # The Amazon Resource Name (ARN) of the deployed solution version.
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] min_provisioned_tps
254
+ # Specifies the requested minimum provisioned transactions
255
+ # (recommendations) per second that Amazon Personalize will support.
256
+ # @return [Integer]
257
+ #
258
+ # @!attribute [rw] status
259
+ # The status of the campaign update.
260
+ #
261
+ # A campaign update can be in one of the following states:
262
+ #
263
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
264
+ # FAILED
265
+ #
266
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
267
+ # @return [String]
268
+ #
269
+ # @!attribute [rw] failure_reason
270
+ # If a campaign update fails, the reason behind the failure.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] creation_date_time
274
+ # The date and time (in Unix time) that the campaign update was
275
+ # created.
276
+ # @return [Time]
277
+ #
278
+ # @!attribute [rw] last_updated_date_time
279
+ # The date and time (in Unix time) that the campaign update was last
280
+ # updated.
281
+ # @return [Time]
282
+ #
283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignUpdateSummary AWS API Documentation
284
+ #
285
+ class CampaignUpdateSummary < Struct.new(
286
+ :solution_version_arn,
287
+ :min_provisioned_tps,
288
+ :status,
289
+ :failure_reason,
290
+ :creation_date_time,
291
+ :last_updated_date_time)
292
+ include Aws::Structure
293
+ end
294
+
295
+ # Provides the name and range of a categorical hyperparameter.
296
+ #
297
+ # @note When making an API call, you may pass CategoricalHyperParameterRange
298
+ # data as a hash:
299
+ #
300
+ # {
301
+ # name: "ParameterName",
302
+ # values: ["CategoricalValue"],
303
+ # }
304
+ #
305
+ # @!attribute [rw] name
306
+ # The name of the hyperparameter.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] values
310
+ # A list of the categories for the hyperparameter.
311
+ # @return [Array<String>]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CategoricalHyperParameterRange AWS API Documentation
314
+ #
315
+ class CategoricalHyperParameterRange < Struct.new(
316
+ :name,
317
+ :values)
318
+ include Aws::Structure
319
+ end
320
+
321
+ # Provides the name and range of a continuous hyperparameter.
322
+ #
323
+ # @note When making an API call, you may pass ContinuousHyperParameterRange
324
+ # data as a hash:
325
+ #
326
+ # {
327
+ # name: "ParameterName",
328
+ # min_value: 1.0,
329
+ # max_value: 1.0,
330
+ # }
331
+ #
332
+ # @!attribute [rw] name
333
+ # The name of the hyperparameter.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] min_value
337
+ # The minimum allowable value for the hyperparameter.
338
+ # @return [Float]
339
+ #
340
+ # @!attribute [rw] max_value
341
+ # The maximum allowable value for the hyperparameter.
342
+ # @return [Float]
343
+ #
344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ContinuousHyperParameterRange AWS API Documentation
345
+ #
346
+ class ContinuousHyperParameterRange < Struct.new(
347
+ :name,
348
+ :min_value,
349
+ :max_value)
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @note When making an API call, you may pass CreateCampaignRequest
354
+ # data as a hash:
355
+ #
356
+ # {
357
+ # name: "Name", # required
358
+ # solution_version_arn: "Arn", # required
359
+ # min_provisioned_tps: 1, # required
360
+ # }
361
+ #
362
+ # @!attribute [rw] name
363
+ # A name for the new campaign. The campaign name must be unique within
364
+ # your account.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] solution_version_arn
368
+ # The Amazon Resource Name (ARN) of the solution version to deploy.
369
+ # @return [String]
370
+ #
371
+ # @!attribute [rw] min_provisioned_tps
372
+ # Specifies the requested minimum provisioned transactions
373
+ # (recommendations) per second that Amazon Personalize will support.
374
+ # @return [Integer]
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaignRequest AWS API Documentation
377
+ #
378
+ class CreateCampaignRequest < Struct.new(
379
+ :name,
380
+ :solution_version_arn,
381
+ :min_provisioned_tps)
382
+ include Aws::Structure
383
+ end
384
+
385
+ # @!attribute [rw] campaign_arn
386
+ # The Amazon Resource Name (ARN) of the campaign.
387
+ # @return [String]
388
+ #
389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaignResponse AWS API Documentation
390
+ #
391
+ class CreateCampaignResponse < Struct.new(
392
+ :campaign_arn)
393
+ include Aws::Structure
394
+ end
395
+
396
+ # @note When making an API call, you may pass CreateDatasetGroupRequest
397
+ # data as a hash:
398
+ #
399
+ # {
400
+ # name: "Name", # required
401
+ # role_arn: "RoleArn",
402
+ # kms_key_arn: "KmsKeyArn",
403
+ # }
404
+ #
405
+ # @!attribute [rw] name
406
+ # The name for the new dataset group.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] role_arn
410
+ # The ARN of the IAM role that has permissions to access the KMS key.
411
+ # Supplying an IAM role is only valid when also specifying a KMS key.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] kms_key_arn
415
+ # The Amazon Resource Name (ARN) of a KMS key used to encrypt the
416
+ # datasets.
417
+ # @return [String]
418
+ #
419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupRequest AWS API Documentation
420
+ #
421
+ class CreateDatasetGroupRequest < Struct.new(
422
+ :name,
423
+ :role_arn,
424
+ :kms_key_arn)
425
+ include Aws::Structure
426
+ end
427
+
428
+ # @!attribute [rw] dataset_group_arn
429
+ # The Amazon Resource Name (ARN) of the new dataset group.
430
+ # @return [String]
431
+ #
432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupResponse AWS API Documentation
433
+ #
434
+ class CreateDatasetGroupResponse < Struct.new(
435
+ :dataset_group_arn)
436
+ include Aws::Structure
437
+ end
438
+
439
+ # @note When making an API call, you may pass CreateDatasetImportJobRequest
440
+ # data as a hash:
441
+ #
442
+ # {
443
+ # job_name: "Name", # required
444
+ # dataset_arn: "Arn", # required
445
+ # data_source: { # required
446
+ # data_location: "S3Location",
447
+ # },
448
+ # role_arn: "RoleArn", # required
449
+ # }
450
+ #
451
+ # @!attribute [rw] job_name
452
+ # The name for the dataset import job.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] dataset_arn
456
+ # The ARN of the dataset that receives the imported data.
457
+ # @return [String]
458
+ #
459
+ # @!attribute [rw] data_source
460
+ # The Amazon S3 bucket that contains the training data to import.
461
+ # @return [Types::DataSource]
462
+ #
463
+ # @!attribute [rw] role_arn
464
+ # The ARN of the IAM role that has permissions to read from the Amazon
465
+ # S3 data source.
466
+ # @return [String]
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJobRequest AWS API Documentation
469
+ #
470
+ class CreateDatasetImportJobRequest < Struct.new(
471
+ :job_name,
472
+ :dataset_arn,
473
+ :data_source,
474
+ :role_arn)
475
+ include Aws::Structure
476
+ end
477
+
478
+ # @!attribute [rw] dataset_import_job_arn
479
+ # The ARN of the dataset import job.
480
+ # @return [String]
481
+ #
482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJobResponse AWS API Documentation
483
+ #
484
+ class CreateDatasetImportJobResponse < Struct.new(
485
+ :dataset_import_job_arn)
486
+ include Aws::Structure
487
+ end
488
+
489
+ # @note When making an API call, you may pass CreateDatasetRequest
490
+ # data as a hash:
491
+ #
492
+ # {
493
+ # name: "Name", # required
494
+ # schema_arn: "Arn", # required
495
+ # dataset_group_arn: "Arn", # required
496
+ # dataset_type: "DatasetType", # required
497
+ # }
498
+ #
499
+ # @!attribute [rw] name
500
+ # The name for the dataset.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] schema_arn
504
+ # The ARN of the schema to associate with the dataset. The schema
505
+ # defines the dataset fields.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] dataset_group_arn
509
+ # The Amazon Resource Name (ARN) of the dataset group to add the
510
+ # dataset to.
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] dataset_type
514
+ # The type of dataset.
515
+ #
516
+ # One of the following (case insensitive) values:
517
+ #
518
+ # * Interactions
519
+ #
520
+ # * Items
521
+ #
522
+ # * Users
523
+ # @return [String]
524
+ #
525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetRequest AWS API Documentation
526
+ #
527
+ class CreateDatasetRequest < Struct.new(
528
+ :name,
529
+ :schema_arn,
530
+ :dataset_group_arn,
531
+ :dataset_type)
532
+ include Aws::Structure
533
+ end
534
+
535
+ # @!attribute [rw] dataset_arn
536
+ # The ARN of the dataset.
537
+ # @return [String]
538
+ #
539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetResponse AWS API Documentation
540
+ #
541
+ class CreateDatasetResponse < Struct.new(
542
+ :dataset_arn)
543
+ include Aws::Structure
544
+ end
545
+
546
+ # @note When making an API call, you may pass CreateEventTrackerRequest
547
+ # data as a hash:
548
+ #
549
+ # {
550
+ # name: "Name", # required
551
+ # dataset_group_arn: "Arn", # required
552
+ # }
553
+ #
554
+ # @!attribute [rw] name
555
+ # The name for the event tracker.
556
+ # @return [String]
557
+ #
558
+ # @!attribute [rw] dataset_group_arn
559
+ # The Amazon Resource Name (ARN) of the dataset group that receives
560
+ # the event data.
561
+ # @return [String]
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTrackerRequest AWS API Documentation
564
+ #
565
+ class CreateEventTrackerRequest < Struct.new(
566
+ :name,
567
+ :dataset_group_arn)
568
+ include Aws::Structure
569
+ end
570
+
571
+ # @!attribute [rw] event_tracker_arn
572
+ # The ARN of the event tracker.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] tracking_id
576
+ # The ID of the event tracker. Include this ID in requests to the
577
+ # [PutEvents][1] API.
578
+ #
579
+ #
580
+ #
581
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html
582
+ # @return [String]
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTrackerResponse AWS API Documentation
585
+ #
586
+ class CreateEventTrackerResponse < Struct.new(
587
+ :event_tracker_arn,
588
+ :tracking_id)
589
+ include Aws::Structure
590
+ end
591
+
592
+ # @note When making an API call, you may pass CreateSchemaRequest
593
+ # data as a hash:
594
+ #
595
+ # {
596
+ # name: "Name", # required
597
+ # schema: "AvroSchema", # required
598
+ # }
599
+ #
600
+ # @!attribute [rw] name
601
+ # The name for the schema.
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] schema
605
+ # A schema in Avro JSON format.
606
+ # @return [String]
607
+ #
608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchemaRequest AWS API Documentation
609
+ #
610
+ class CreateSchemaRequest < Struct.new(
611
+ :name,
612
+ :schema)
613
+ include Aws::Structure
614
+ end
615
+
616
+ # @!attribute [rw] schema_arn
617
+ # The Amazon Resource Name (ARN) of the created schema.
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchemaResponse AWS API Documentation
621
+ #
622
+ class CreateSchemaResponse < Struct.new(
623
+ :schema_arn)
624
+ include Aws::Structure
625
+ end
626
+
627
+ # @note When making an API call, you may pass CreateSolutionRequest
628
+ # data as a hash:
629
+ #
630
+ # {
631
+ # name: "Name", # required
632
+ # perform_hpo: false,
633
+ # perform_auto_ml: false,
634
+ # recipe_arn: "Arn",
635
+ # dataset_group_arn: "Arn", # required
636
+ # event_type: "EventType",
637
+ # solution_config: {
638
+ # event_value_threshold: "EventValueThreshold",
639
+ # hpo_config: {
640
+ # hpo_objective: {
641
+ # type: "HPOObjectiveType",
642
+ # metric_name: "MetricName",
643
+ # metric_regex: "MetricRegex",
644
+ # },
645
+ # hpo_resource_config: {
646
+ # max_number_of_training_jobs: "HPOResource",
647
+ # max_parallel_training_jobs: "HPOResource",
648
+ # },
649
+ # algorithm_hyper_parameter_ranges: {
650
+ # integer_hyper_parameter_ranges: [
651
+ # {
652
+ # name: "ParameterName",
653
+ # min_value: 1,
654
+ # max_value: 1,
655
+ # },
656
+ # ],
657
+ # continuous_hyper_parameter_ranges: [
658
+ # {
659
+ # name: "ParameterName",
660
+ # min_value: 1.0,
661
+ # max_value: 1.0,
662
+ # },
663
+ # ],
664
+ # categorical_hyper_parameter_ranges: [
665
+ # {
666
+ # name: "ParameterName",
667
+ # values: ["CategoricalValue"],
668
+ # },
669
+ # ],
670
+ # },
671
+ # },
672
+ # algorithm_hyper_parameters: {
673
+ # "ParameterName" => "ParameterValue",
674
+ # },
675
+ # feature_transformation_parameters: {
676
+ # "ParameterName" => "ParameterValue",
677
+ # },
678
+ # auto_ml_config: {
679
+ # metric_name: "MetricName",
680
+ # recipe_list: ["Arn"],
681
+ # },
682
+ # },
683
+ # }
684
+ #
685
+ # @!attribute [rw] name
686
+ # The name for the solution.
687
+ # @return [String]
688
+ #
689
+ # @!attribute [rw] perform_hpo
690
+ # Whether to perform hyperparameter optimization (HPO) on the
691
+ # specified or selected recipe. The default is `false`.
692
+ #
693
+ # When performing AutoML, this parameter is always `true` and you
694
+ # should not set it to `false`.
695
+ # @return [Boolean]
696
+ #
697
+ # @!attribute [rw] perform_auto_ml
698
+ # Whether to perform automated machine learning (AutoML). The default
699
+ # is `false`. For this case, you must specify `recipeArn`.
700
+ #
701
+ # When set to `true`, Amazon Personalize analyzes your training data
702
+ # and selects the optimal USER\_PERSONALIZATION recipe and
703
+ # hyperparameters. In this case, you must omit `recipeArn`. Amazon
704
+ # Personalize determines the optimal recipe by running tests with
705
+ # different values for the hyperparameters. AutoML lengthens the
706
+ # training process as compared to selecting a specific recipe.
707
+ # @return [Boolean]
708
+ #
709
+ # @!attribute [rw] recipe_arn
710
+ # The ARN of the recipe to use for model training. Only specified when
711
+ # `performAutoML` is false.
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] dataset_group_arn
715
+ # The Amazon Resource Name (ARN) of the dataset group that provides
716
+ # the training data.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] event_type
720
+ # When your have multiple event types (using an `EVENT_TYPE` schema
721
+ # field), this parameter specifies which event type (for example,
722
+ # 'click' or 'like') is used for training the model.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] solution_config
726
+ # The configuration to use with the solution. When `performAutoML` is
727
+ # set to true, Amazon Personalize only evaluates the `autoMLConfig`
728
+ # section of the solution configuration.
729
+ # @return [Types::SolutionConfig]
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
732
+ #
733
+ class CreateSolutionRequest < Struct.new(
734
+ :name,
735
+ :perform_hpo,
736
+ :perform_auto_ml,
737
+ :recipe_arn,
738
+ :dataset_group_arn,
739
+ :event_type,
740
+ :solution_config)
741
+ include Aws::Structure
742
+ end
743
+
744
+ # @!attribute [rw] solution_arn
745
+ # The ARN of the solution.
746
+ # @return [String]
747
+ #
748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionResponse AWS API Documentation
749
+ #
750
+ class CreateSolutionResponse < Struct.new(
751
+ :solution_arn)
752
+ include Aws::Structure
753
+ end
754
+
755
+ # @note When making an API call, you may pass CreateSolutionVersionRequest
756
+ # data as a hash:
757
+ #
758
+ # {
759
+ # solution_arn: "Arn", # required
760
+ # }
761
+ #
762
+ # @!attribute [rw] solution_arn
763
+ # The Amazon Resource Name (ARN) of the solution containing the
764
+ # training configuration information.
765
+ # @return [String]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
768
+ #
769
+ class CreateSolutionVersionRequest < Struct.new(
770
+ :solution_arn)
771
+ include Aws::Structure
772
+ end
773
+
774
+ # @!attribute [rw] solution_version_arn
775
+ # The ARN of the new solution version.
776
+ # @return [String]
777
+ #
778
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionResponse AWS API Documentation
779
+ #
780
+ class CreateSolutionVersionResponse < Struct.new(
781
+ :solution_version_arn)
782
+ include Aws::Structure
783
+ end
784
+
785
+ # Describes the data source that contains the data to upload to a
786
+ # dataset.
787
+ #
788
+ # @note When making an API call, you may pass DataSource
789
+ # data as a hash:
790
+ #
791
+ # {
792
+ # data_location: "S3Location",
793
+ # }
794
+ #
795
+ # @!attribute [rw] data_location
796
+ # The path to the Amazon S3 bucket where the data that you want to
797
+ # upload to your dataset is stored. For example:
798
+ #
799
+ # `s3://bucket-name/training-data.csv`
800
+ # @return [String]
801
+ #
802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DataSource AWS API Documentation
803
+ #
804
+ class DataSource < Struct.new(
805
+ :data_location)
806
+ include Aws::Structure
807
+ end
808
+
809
+ # Provides metadata for a dataset.
810
+ #
811
+ # @!attribute [rw] name
812
+ # The name of the dataset.
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] dataset_arn
816
+ # The Amazon Resource Name (ARN) of the dataset that you want metadata
817
+ # for.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] dataset_group_arn
821
+ # The Amazon Resource Name (ARN) of the dataset group.
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] dataset_type
825
+ # One of the following values:
826
+ #
827
+ # * Interactions
828
+ #
829
+ # * Items
830
+ #
831
+ # * Users
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] schema_arn
835
+ # The ARN of the associated schema.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] status
839
+ # The status of the dataset.
840
+ #
841
+ # A dataset can be in one of the following states:
842
+ #
843
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
844
+ # FAILED
845
+ #
846
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] creation_date_time
850
+ # The creation date and time (in Unix time) of the dataset.
851
+ # @return [Time]
852
+ #
853
+ # @!attribute [rw] last_updated_date_time
854
+ # A time stamp that shows when the dataset was updated.
855
+ # @return [Time]
856
+ #
857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Dataset AWS API Documentation
858
+ #
859
+ class Dataset < Struct.new(
860
+ :name,
861
+ :dataset_arn,
862
+ :dataset_group_arn,
863
+ :dataset_type,
864
+ :schema_arn,
865
+ :status,
866
+ :creation_date_time,
867
+ :last_updated_date_time)
868
+ include Aws::Structure
869
+ end
870
+
871
+ # A dataset group is a collection of related datasets (Interactions,
872
+ # User, and Item). You create a dataset group by calling
873
+ # CreateDatasetGroup. You then create a dataset and add it to a dataset
874
+ # group by calling CreateDataset. The dataset group is used to create
875
+ # and train a solution by calling CreateSolution. A dataset group can
876
+ # contain only one of each type of dataset.
877
+ #
878
+ # You can specify an AWS Key Management Service (KMS) key to encrypt the
879
+ # datasets in the group.
880
+ #
881
+ # @!attribute [rw] name
882
+ # The name of the dataset group.
883
+ # @return [String]
884
+ #
885
+ # @!attribute [rw] dataset_group_arn
886
+ # The Amazon Resource Name (ARN) of the dataset group.
887
+ # @return [String]
888
+ #
889
+ # @!attribute [rw] status
890
+ # The current status of the dataset group.
891
+ #
892
+ # A dataset group can be in one of the following states:
893
+ #
894
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
895
+ # FAILED
896
+ #
897
+ # * DELETE PENDING
898
+ # @return [String]
899
+ #
900
+ # @!attribute [rw] role_arn
901
+ # The ARN of the IAM role that has permissions to create the dataset
902
+ # group.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] kms_key_arn
906
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
907
+ # datasets.
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] creation_date_time
911
+ # The creation date and time (in Unix time) of the dataset group.
912
+ # @return [Time]
913
+ #
914
+ # @!attribute [rw] last_updated_date_time
915
+ # The last update date and time (in Unix time) of the dataset group.
916
+ # @return [Time]
917
+ #
918
+ # @!attribute [rw] failure_reason
919
+ # If creating a dataset group fails, provides the reason why.
920
+ # @return [String]
921
+ #
922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroup AWS API Documentation
923
+ #
924
+ class DatasetGroup < Struct.new(
925
+ :name,
926
+ :dataset_group_arn,
927
+ :status,
928
+ :role_arn,
929
+ :kms_key_arn,
930
+ :creation_date_time,
931
+ :last_updated_date_time,
932
+ :failure_reason)
933
+ include Aws::Structure
934
+ end
935
+
936
+ # Provides a summary of the properties of a dataset group. For a
937
+ # complete listing, call the DescribeDatasetGroup API.
938
+ #
939
+ # @!attribute [rw] name
940
+ # The name of the dataset group.
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] dataset_group_arn
944
+ # The Amazon Resource Name (ARN) of the dataset group.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] status
948
+ # The status of the dataset group.
949
+ #
950
+ # A dataset group can be in one of the following states:
951
+ #
952
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
953
+ # FAILED
954
+ #
955
+ # * DELETE PENDING
956
+ # @return [String]
957
+ #
958
+ # @!attribute [rw] creation_date_time
959
+ # The date and time (in Unix time) that the dataset group was created.
960
+ # @return [Time]
961
+ #
962
+ # @!attribute [rw] last_updated_date_time
963
+ # The date and time (in Unix time) that the dataset group was last
964
+ # updated.
965
+ # @return [Time]
966
+ #
967
+ # @!attribute [rw] failure_reason
968
+ # If creating a dataset group fails, the reason behind the failure.
969
+ # @return [String]
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroupSummary AWS API Documentation
972
+ #
973
+ class DatasetGroupSummary < Struct.new(
974
+ :name,
975
+ :dataset_group_arn,
976
+ :status,
977
+ :creation_date_time,
978
+ :last_updated_date_time,
979
+ :failure_reason)
980
+ include Aws::Structure
981
+ end
982
+
983
+ # Describes a job that imports training data from a data source (Amazon
984
+ # S3 bucket) to an Amazon Personalize dataset. For more information, see
985
+ # CreateDatasetImportJob.
986
+ #
987
+ # A dataset import job can be in one of the following states:
988
+ #
989
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
990
+ # FAILED
991
+ #
992
+ # ^
993
+ #
994
+ # @!attribute [rw] job_name
995
+ # The name of the import job.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] dataset_import_job_arn
999
+ # The ARN of the dataset import job.
1000
+ # @return [String]
1001
+ #
1002
+ # @!attribute [rw] dataset_arn
1003
+ # The Amazon Resource Name (ARN) of the dataset that receives the
1004
+ # imported data.
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] data_source
1008
+ # The Amazon S3 bucket that contains the training data to import.
1009
+ # @return [Types::DataSource]
1010
+ #
1011
+ # @!attribute [rw] role_arn
1012
+ # The ARN of the AWS Identity and Access Management (IAM) role that
1013
+ # has permissions to read from the Amazon S3 data source.
1014
+ # @return [String]
1015
+ #
1016
+ # @!attribute [rw] status
1017
+ # The status of the dataset import job.
1018
+ #
1019
+ # A dataset import job can be in one of the following states:
1020
+ #
1021
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1022
+ # FAILED
1023
+ #
1024
+ # ^
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] creation_date_time
1028
+ # The creation date and time (in Unix time) of the dataset import job.
1029
+ # @return [Time]
1030
+ #
1031
+ # @!attribute [rw] last_updated_date_time
1032
+ # The date and time (in Unix time) the dataset was last updated.
1033
+ # @return [Time]
1034
+ #
1035
+ # @!attribute [rw] failure_reason
1036
+ # If a dataset import job fails, provides the reason why.
1037
+ # @return [String]
1038
+ #
1039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetImportJob AWS API Documentation
1040
+ #
1041
+ class DatasetImportJob < Struct.new(
1042
+ :job_name,
1043
+ :dataset_import_job_arn,
1044
+ :dataset_arn,
1045
+ :data_source,
1046
+ :role_arn,
1047
+ :status,
1048
+ :creation_date_time,
1049
+ :last_updated_date_time,
1050
+ :failure_reason)
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # Provides a summary of the properties of a dataset import job. For a
1055
+ # complete listing, call the DescribeDatasetImportJob API.
1056
+ #
1057
+ # @!attribute [rw] dataset_import_job_arn
1058
+ # The Amazon Resource Name (ARN) of the dataset import job.
1059
+ # @return [String]
1060
+ #
1061
+ # @!attribute [rw] job_name
1062
+ # The name of the dataset import job.
1063
+ # @return [String]
1064
+ #
1065
+ # @!attribute [rw] status
1066
+ # The status of the dataset import job.
1067
+ #
1068
+ # A dataset import job can be in one of the following states:
1069
+ #
1070
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1071
+ # FAILED
1072
+ #
1073
+ # ^
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] creation_date_time
1077
+ # The date and time (in Unix time) that the dataset import job was
1078
+ # created.
1079
+ # @return [Time]
1080
+ #
1081
+ # @!attribute [rw] last_updated_date_time
1082
+ # The date and time (in Unix time) that the dataset was last updated.
1083
+ # @return [Time]
1084
+ #
1085
+ # @!attribute [rw] failure_reason
1086
+ # If a dataset import job fails, the reason behind the failure.
1087
+ # @return [String]
1088
+ #
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetImportJobSummary AWS API Documentation
1090
+ #
1091
+ class DatasetImportJobSummary < Struct.new(
1092
+ :dataset_import_job_arn,
1093
+ :job_name,
1094
+ :status,
1095
+ :creation_date_time,
1096
+ :last_updated_date_time,
1097
+ :failure_reason)
1098
+ include Aws::Structure
1099
+ end
1100
+
1101
+ # Describes the schema for a dataset. For more information on schemas,
1102
+ # see CreateSchema.
1103
+ #
1104
+ # @!attribute [rw] name
1105
+ # The name of the schema.
1106
+ # @return [String]
1107
+ #
1108
+ # @!attribute [rw] schema_arn
1109
+ # The Amazon Resource Name (ARN) of the schema.
1110
+ # @return [String]
1111
+ #
1112
+ # @!attribute [rw] schema
1113
+ # The schema.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] creation_date_time
1117
+ # The date and time (in Unix time) that the schema was created.
1118
+ # @return [Time]
1119
+ #
1120
+ # @!attribute [rw] last_updated_date_time
1121
+ # The date and time (in Unix time) that the schema was last updated.
1122
+ # @return [Time]
1123
+ #
1124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchema AWS API Documentation
1125
+ #
1126
+ class DatasetSchema < Struct.new(
1127
+ :name,
1128
+ :schema_arn,
1129
+ :schema,
1130
+ :creation_date_time,
1131
+ :last_updated_date_time)
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # Provides a summary of the properties of a dataset schema. For a
1136
+ # complete listing, call the DescribeSchema API.
1137
+ #
1138
+ # @!attribute [rw] name
1139
+ # The name of the schema.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] schema_arn
1143
+ # The Amazon Resource Name (ARN) of the schema.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] creation_date_time
1147
+ # The date and time (in Unix time) that the schema was created.
1148
+ # @return [Time]
1149
+ #
1150
+ # @!attribute [rw] last_updated_date_time
1151
+ # The date and time (in Unix time) that the schema was last updated.
1152
+ # @return [Time]
1153
+ #
1154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchemaSummary AWS API Documentation
1155
+ #
1156
+ class DatasetSchemaSummary < Struct.new(
1157
+ :name,
1158
+ :schema_arn,
1159
+ :creation_date_time,
1160
+ :last_updated_date_time)
1161
+ include Aws::Structure
1162
+ end
1163
+
1164
+ # Provides a summary of the properties of a dataset. For a complete
1165
+ # listing, call the DescribeDataset API.
1166
+ #
1167
+ # @!attribute [rw] name
1168
+ # The name of the dataset.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] dataset_arn
1172
+ # The Amazon Resource Name (ARN) of the dataset.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] dataset_type
1176
+ # The dataset type. One of the following values:
1177
+ #
1178
+ # * Interactions
1179
+ #
1180
+ # * Items
1181
+ #
1182
+ # * Users
1183
+ #
1184
+ # * Event-Interactions
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] status
1188
+ # The status of the dataset.
1189
+ #
1190
+ # A dataset can be in one of the following states:
1191
+ #
1192
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1193
+ # FAILED
1194
+ #
1195
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] creation_date_time
1199
+ # The date and time (in Unix time) that the dataset was created.
1200
+ # @return [Time]
1201
+ #
1202
+ # @!attribute [rw] last_updated_date_time
1203
+ # The date and time (in Unix time) that the dataset was last updated.
1204
+ # @return [Time]
1205
+ #
1206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSummary AWS API Documentation
1207
+ #
1208
+ class DatasetSummary < Struct.new(
1209
+ :name,
1210
+ :dataset_arn,
1211
+ :dataset_type,
1212
+ :status,
1213
+ :creation_date_time,
1214
+ :last_updated_date_time)
1215
+ include Aws::Structure
1216
+ end
1217
+
1218
+ # Provides the name and default range of a categorical hyperparameter
1219
+ # and whether the hyperparameter is tunable. A tunable hyperparameter
1220
+ # can have its value determined during hyperparameter optimization
1221
+ # (HPO).
1222
+ #
1223
+ # @!attribute [rw] name
1224
+ # The name of the hyperparameter.
1225
+ # @return [String]
1226
+ #
1227
+ # @!attribute [rw] values
1228
+ # A list of the categories for the hyperparameter.
1229
+ # @return [Array<String>]
1230
+ #
1231
+ # @!attribute [rw] is_tunable
1232
+ # Whether the hyperparameter is tunable.
1233
+ # @return [Boolean]
1234
+ #
1235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DefaultCategoricalHyperParameterRange AWS API Documentation
1236
+ #
1237
+ class DefaultCategoricalHyperParameterRange < Struct.new(
1238
+ :name,
1239
+ :values,
1240
+ :is_tunable)
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # Provides the name and default range of a continuous hyperparameter and
1245
+ # whether the hyperparameter is tunable. A tunable hyperparameter can
1246
+ # have its value determined during hyperparameter optimization (HPO).
1247
+ #
1248
+ # @!attribute [rw] name
1249
+ # The name of the hyperparameter.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] min_value
1253
+ # The minimum allowable value for the hyperparameter.
1254
+ # @return [Float]
1255
+ #
1256
+ # @!attribute [rw] max_value
1257
+ # The maximum allowable value for the hyperparameter.
1258
+ # @return [Float]
1259
+ #
1260
+ # @!attribute [rw] is_tunable
1261
+ # Whether the hyperparameter is tunable.
1262
+ # @return [Boolean]
1263
+ #
1264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DefaultContinuousHyperParameterRange AWS API Documentation
1265
+ #
1266
+ class DefaultContinuousHyperParameterRange < Struct.new(
1267
+ :name,
1268
+ :min_value,
1269
+ :max_value,
1270
+ :is_tunable)
1271
+ include Aws::Structure
1272
+ end
1273
+
1274
+ # Specifies the hyperparameters and their default ranges.
1275
+ # Hyperparameters can be categorical, continuous, or integer-valued.
1276
+ #
1277
+ # @!attribute [rw] integer_hyper_parameter_ranges
1278
+ # The integer-valued hyperparameters and their default ranges.
1279
+ # @return [Array<Types::DefaultIntegerHyperParameterRange>]
1280
+ #
1281
+ # @!attribute [rw] continuous_hyper_parameter_ranges
1282
+ # The continuous hyperparameters and their default ranges.
1283
+ # @return [Array<Types::DefaultContinuousHyperParameterRange>]
1284
+ #
1285
+ # @!attribute [rw] categorical_hyper_parameter_ranges
1286
+ # The categorical hyperparameters and their default ranges.
1287
+ # @return [Array<Types::DefaultCategoricalHyperParameterRange>]
1288
+ #
1289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DefaultHyperParameterRanges AWS API Documentation
1290
+ #
1291
+ class DefaultHyperParameterRanges < Struct.new(
1292
+ :integer_hyper_parameter_ranges,
1293
+ :continuous_hyper_parameter_ranges,
1294
+ :categorical_hyper_parameter_ranges)
1295
+ include Aws::Structure
1296
+ end
1297
+
1298
+ # Provides the name and default range of a integer-valued hyperparameter
1299
+ # and whether the hyperparameter is tunable. A tunable hyperparameter
1300
+ # can have its value determined during hyperparameter optimization
1301
+ # (HPO).
1302
+ #
1303
+ # @!attribute [rw] name
1304
+ # The name of the hyperparameter.
1305
+ # @return [String]
1306
+ #
1307
+ # @!attribute [rw] min_value
1308
+ # The minimum allowable value for the hyperparameter.
1309
+ # @return [Integer]
1310
+ #
1311
+ # @!attribute [rw] max_value
1312
+ # The maximum allowable value for the hyperparameter.
1313
+ # @return [Integer]
1314
+ #
1315
+ # @!attribute [rw] is_tunable
1316
+ # Indicates whether the hyperparameter is tunable.
1317
+ # @return [Boolean]
1318
+ #
1319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DefaultIntegerHyperParameterRange AWS API Documentation
1320
+ #
1321
+ class DefaultIntegerHyperParameterRange < Struct.new(
1322
+ :name,
1323
+ :min_value,
1324
+ :max_value,
1325
+ :is_tunable)
1326
+ include Aws::Structure
1327
+ end
1328
+
1329
+ # @note When making an API call, you may pass DeleteCampaignRequest
1330
+ # data as a hash:
1331
+ #
1332
+ # {
1333
+ # campaign_arn: "Arn", # required
1334
+ # }
1335
+ #
1336
+ # @!attribute [rw] campaign_arn
1337
+ # The Amazon Resource Name (ARN) of the campaign to delete.
1338
+ # @return [String]
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteCampaignRequest AWS API Documentation
1341
+ #
1342
+ class DeleteCampaignRequest < Struct.new(
1343
+ :campaign_arn)
1344
+ include Aws::Structure
1345
+ end
1346
+
1347
+ # @note When making an API call, you may pass DeleteDatasetGroupRequest
1348
+ # data as a hash:
1349
+ #
1350
+ # {
1351
+ # dataset_group_arn: "Arn", # required
1352
+ # }
1353
+ #
1354
+ # @!attribute [rw] dataset_group_arn
1355
+ # The ARN of the dataset group to delete.
1356
+ # @return [String]
1357
+ #
1358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetGroupRequest AWS API Documentation
1359
+ #
1360
+ class DeleteDatasetGroupRequest < Struct.new(
1361
+ :dataset_group_arn)
1362
+ include Aws::Structure
1363
+ end
1364
+
1365
+ # @note When making an API call, you may pass DeleteDatasetRequest
1366
+ # data as a hash:
1367
+ #
1368
+ # {
1369
+ # dataset_arn: "Arn", # required
1370
+ # }
1371
+ #
1372
+ # @!attribute [rw] dataset_arn
1373
+ # The Amazon Resource Name (ARN) of the dataset to delete.
1374
+ # @return [String]
1375
+ #
1376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetRequest AWS API Documentation
1377
+ #
1378
+ class DeleteDatasetRequest < Struct.new(
1379
+ :dataset_arn)
1380
+ include Aws::Structure
1381
+ end
1382
+
1383
+ # @note When making an API call, you may pass DeleteEventTrackerRequest
1384
+ # data as a hash:
1385
+ #
1386
+ # {
1387
+ # event_tracker_arn: "Arn", # required
1388
+ # }
1389
+ #
1390
+ # @!attribute [rw] event_tracker_arn
1391
+ # The Amazon Resource Name (ARN) of the event tracker to delete.
1392
+ # @return [String]
1393
+ #
1394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteEventTrackerRequest AWS API Documentation
1395
+ #
1396
+ class DeleteEventTrackerRequest < Struct.new(
1397
+ :event_tracker_arn)
1398
+ include Aws::Structure
1399
+ end
1400
+
1401
+ # @note When making an API call, you may pass DeleteSchemaRequest
1402
+ # data as a hash:
1403
+ #
1404
+ # {
1405
+ # schema_arn: "Arn", # required
1406
+ # }
1407
+ #
1408
+ # @!attribute [rw] schema_arn
1409
+ # The Amazon Resource Name (ARN) of the schema to delete.
1410
+ # @return [String]
1411
+ #
1412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSchemaRequest AWS API Documentation
1413
+ #
1414
+ class DeleteSchemaRequest < Struct.new(
1415
+ :schema_arn)
1416
+ include Aws::Structure
1417
+ end
1418
+
1419
+ # @note When making an API call, you may pass DeleteSolutionRequest
1420
+ # data as a hash:
1421
+ #
1422
+ # {
1423
+ # solution_arn: "Arn", # required
1424
+ # }
1425
+ #
1426
+ # @!attribute [rw] solution_arn
1427
+ # The ARN of the solution to delete.
1428
+ # @return [String]
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSolutionRequest AWS API Documentation
1431
+ #
1432
+ class DeleteSolutionRequest < Struct.new(
1433
+ :solution_arn)
1434
+ include Aws::Structure
1435
+ end
1436
+
1437
+ # @note When making an API call, you may pass DescribeAlgorithmRequest
1438
+ # data as a hash:
1439
+ #
1440
+ # {
1441
+ # algorithm_arn: "Arn", # required
1442
+ # }
1443
+ #
1444
+ # @!attribute [rw] algorithm_arn
1445
+ # The Amazon Resource Name (ARN) of the algorithm to describe.
1446
+ # @return [String]
1447
+ #
1448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithmRequest AWS API Documentation
1449
+ #
1450
+ class DescribeAlgorithmRequest < Struct.new(
1451
+ :algorithm_arn)
1452
+ include Aws::Structure
1453
+ end
1454
+
1455
+ # @!attribute [rw] algorithm
1456
+ # A listing of the properties of the algorithm.
1457
+ # @return [Types::Algorithm]
1458
+ #
1459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithmResponse AWS API Documentation
1460
+ #
1461
+ class DescribeAlgorithmResponse < Struct.new(
1462
+ :algorithm)
1463
+ include Aws::Structure
1464
+ end
1465
+
1466
+ # @note When making an API call, you may pass DescribeCampaignRequest
1467
+ # data as a hash:
1468
+ #
1469
+ # {
1470
+ # campaign_arn: "Arn", # required
1471
+ # }
1472
+ #
1473
+ # @!attribute [rw] campaign_arn
1474
+ # The Amazon Resource Name (ARN) of the campaign.
1475
+ # @return [String]
1476
+ #
1477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaignRequest AWS API Documentation
1478
+ #
1479
+ class DescribeCampaignRequest < Struct.new(
1480
+ :campaign_arn)
1481
+ include Aws::Structure
1482
+ end
1483
+
1484
+ # @!attribute [rw] campaign
1485
+ # The properties of the campaign.
1486
+ # @return [Types::Campaign]
1487
+ #
1488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaignResponse AWS API Documentation
1489
+ #
1490
+ class DescribeCampaignResponse < Struct.new(
1491
+ :campaign)
1492
+ include Aws::Structure
1493
+ end
1494
+
1495
+ # @note When making an API call, you may pass DescribeDatasetGroupRequest
1496
+ # data as a hash:
1497
+ #
1498
+ # {
1499
+ # dataset_group_arn: "Arn", # required
1500
+ # }
1501
+ #
1502
+ # @!attribute [rw] dataset_group_arn
1503
+ # The Amazon Resource Name (ARN) of the dataset group to describe.
1504
+ # @return [String]
1505
+ #
1506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroupRequest AWS API Documentation
1507
+ #
1508
+ class DescribeDatasetGroupRequest < Struct.new(
1509
+ :dataset_group_arn)
1510
+ include Aws::Structure
1511
+ end
1512
+
1513
+ # @!attribute [rw] dataset_group
1514
+ # A listing of the dataset group's properties.
1515
+ # @return [Types::DatasetGroup]
1516
+ #
1517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroupResponse AWS API Documentation
1518
+ #
1519
+ class DescribeDatasetGroupResponse < Struct.new(
1520
+ :dataset_group)
1521
+ include Aws::Structure
1522
+ end
1523
+
1524
+ # @note When making an API call, you may pass DescribeDatasetImportJobRequest
1525
+ # data as a hash:
1526
+ #
1527
+ # {
1528
+ # dataset_import_job_arn: "Arn", # required
1529
+ # }
1530
+ #
1531
+ # @!attribute [rw] dataset_import_job_arn
1532
+ # The Amazon Resource Name (ARN) of the dataset import job to
1533
+ # describe.
1534
+ # @return [String]
1535
+ #
1536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJobRequest AWS API Documentation
1537
+ #
1538
+ class DescribeDatasetImportJobRequest < Struct.new(
1539
+ :dataset_import_job_arn)
1540
+ include Aws::Structure
1541
+ end
1542
+
1543
+ # @!attribute [rw] dataset_import_job
1544
+ # Information about the dataset import job, including the status.
1545
+ #
1546
+ # The status is one of the following values:
1547
+ #
1548
+ # * CREATE PENDING
1549
+ #
1550
+ # * CREATE IN\_PROGRESS
1551
+ #
1552
+ # * ACTIVE
1553
+ #
1554
+ # * CREATE FAILED
1555
+ # @return [Types::DatasetImportJob]
1556
+ #
1557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJobResponse AWS API Documentation
1558
+ #
1559
+ class DescribeDatasetImportJobResponse < Struct.new(
1560
+ :dataset_import_job)
1561
+ include Aws::Structure
1562
+ end
1563
+
1564
+ # @note When making an API call, you may pass DescribeDatasetRequest
1565
+ # data as a hash:
1566
+ #
1567
+ # {
1568
+ # dataset_arn: "Arn", # required
1569
+ # }
1570
+ #
1571
+ # @!attribute [rw] dataset_arn
1572
+ # The Amazon Resource Name (ARN) of the dataset to describe.
1573
+ # @return [String]
1574
+ #
1575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetRequest AWS API Documentation
1576
+ #
1577
+ class DescribeDatasetRequest < Struct.new(
1578
+ :dataset_arn)
1579
+ include Aws::Structure
1580
+ end
1581
+
1582
+ # @!attribute [rw] dataset
1583
+ # A listing of the dataset's properties.
1584
+ # @return [Types::Dataset]
1585
+ #
1586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetResponse AWS API Documentation
1587
+ #
1588
+ class DescribeDatasetResponse < Struct.new(
1589
+ :dataset)
1590
+ include Aws::Structure
1591
+ end
1592
+
1593
+ # @note When making an API call, you may pass DescribeEventTrackerRequest
1594
+ # data as a hash:
1595
+ #
1596
+ # {
1597
+ # event_tracker_arn: "Arn", # required
1598
+ # }
1599
+ #
1600
+ # @!attribute [rw] event_tracker_arn
1601
+ # The Amazon Resource Name (ARN) of the event tracker to describe.
1602
+ # @return [String]
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTrackerRequest AWS API Documentation
1605
+ #
1606
+ class DescribeEventTrackerRequest < Struct.new(
1607
+ :event_tracker_arn)
1608
+ include Aws::Structure
1609
+ end
1610
+
1611
+ # @!attribute [rw] event_tracker
1612
+ # An object that describes the event tracker.
1613
+ # @return [Types::EventTracker]
1614
+ #
1615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTrackerResponse AWS API Documentation
1616
+ #
1617
+ class DescribeEventTrackerResponse < Struct.new(
1618
+ :event_tracker)
1619
+ include Aws::Structure
1620
+ end
1621
+
1622
+ # @note When making an API call, you may pass DescribeFeatureTransformationRequest
1623
+ # data as a hash:
1624
+ #
1625
+ # {
1626
+ # feature_transformation_arn: "Arn", # required
1627
+ # }
1628
+ #
1629
+ # @!attribute [rw] feature_transformation_arn
1630
+ # The Amazon Resource Name (ARN) of the feature transformation to
1631
+ # describe.
1632
+ # @return [String]
1633
+ #
1634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformationRequest AWS API Documentation
1635
+ #
1636
+ class DescribeFeatureTransformationRequest < Struct.new(
1637
+ :feature_transformation_arn)
1638
+ include Aws::Structure
1639
+ end
1640
+
1641
+ # @!attribute [rw] feature_transformation
1642
+ # A listing of the FeatureTransformation properties.
1643
+ # @return [Types::FeatureTransformation]
1644
+ #
1645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformationResponse AWS API Documentation
1646
+ #
1647
+ class DescribeFeatureTransformationResponse < Struct.new(
1648
+ :feature_transformation)
1649
+ include Aws::Structure
1650
+ end
1651
+
1652
+ # @note When making an API call, you may pass DescribeRecipeRequest
1653
+ # data as a hash:
1654
+ #
1655
+ # {
1656
+ # recipe_arn: "Arn", # required
1657
+ # }
1658
+ #
1659
+ # @!attribute [rw] recipe_arn
1660
+ # The Amazon Resource Name (ARN) of the recipe to describe.
1661
+ # @return [String]
1662
+ #
1663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
1664
+ #
1665
+ class DescribeRecipeRequest < Struct.new(
1666
+ :recipe_arn)
1667
+ include Aws::Structure
1668
+ end
1669
+
1670
+ # @!attribute [rw] recipe
1671
+ # An object that describes the recipe.
1672
+ # @return [Types::Recipe]
1673
+ #
1674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
1675
+ #
1676
+ class DescribeRecipeResponse < Struct.new(
1677
+ :recipe)
1678
+ include Aws::Structure
1679
+ end
1680
+
1681
+ # @note When making an API call, you may pass DescribeSchemaRequest
1682
+ # data as a hash:
1683
+ #
1684
+ # {
1685
+ # schema_arn: "Arn", # required
1686
+ # }
1687
+ #
1688
+ # @!attribute [rw] schema_arn
1689
+ # The Amazon Resource Name (ARN) of the schema to retrieve.
1690
+ # @return [String]
1691
+ #
1692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchemaRequest AWS API Documentation
1693
+ #
1694
+ class DescribeSchemaRequest < Struct.new(
1695
+ :schema_arn)
1696
+ include Aws::Structure
1697
+ end
1698
+
1699
+ # @!attribute [rw] schema
1700
+ # The requested schema.
1701
+ # @return [Types::DatasetSchema]
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchemaResponse AWS API Documentation
1704
+ #
1705
+ class DescribeSchemaResponse < Struct.new(
1706
+ :schema)
1707
+ include Aws::Structure
1708
+ end
1709
+
1710
+ # @note When making an API call, you may pass DescribeSolutionRequest
1711
+ # data as a hash:
1712
+ #
1713
+ # {
1714
+ # solution_arn: "Arn", # required
1715
+ # }
1716
+ #
1717
+ # @!attribute [rw] solution_arn
1718
+ # The Amazon Resource Name (ARN) of the solution to describe.
1719
+ # @return [String]
1720
+ #
1721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionRequest AWS API Documentation
1722
+ #
1723
+ class DescribeSolutionRequest < Struct.new(
1724
+ :solution_arn)
1725
+ include Aws::Structure
1726
+ end
1727
+
1728
+ # @!attribute [rw] solution
1729
+ # An object that describes the solution.
1730
+ # @return [Types::Solution]
1731
+ #
1732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionResponse AWS API Documentation
1733
+ #
1734
+ class DescribeSolutionResponse < Struct.new(
1735
+ :solution)
1736
+ include Aws::Structure
1737
+ end
1738
+
1739
+ # @note When making an API call, you may pass DescribeSolutionVersionRequest
1740
+ # data as a hash:
1741
+ #
1742
+ # {
1743
+ # solution_version_arn: "Arn", # required
1744
+ # }
1745
+ #
1746
+ # @!attribute [rw] solution_version_arn
1747
+ # The Amazon Resource Name (ARN) of the solution version.
1748
+ # @return [String]
1749
+ #
1750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersionRequest AWS API Documentation
1751
+ #
1752
+ class DescribeSolutionVersionRequest < Struct.new(
1753
+ :solution_version_arn)
1754
+ include Aws::Structure
1755
+ end
1756
+
1757
+ # @!attribute [rw] solution_version
1758
+ # The solution version.
1759
+ # @return [Types::SolutionVersion]
1760
+ #
1761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersionResponse AWS API Documentation
1762
+ #
1763
+ class DescribeSolutionVersionResponse < Struct.new(
1764
+ :solution_version)
1765
+ include Aws::Structure
1766
+ end
1767
+
1768
+ # Provides information about an event tracker.
1769
+ #
1770
+ # @!attribute [rw] name
1771
+ # The name of the event tracker.
1772
+ # @return [String]
1773
+ #
1774
+ # @!attribute [rw] event_tracker_arn
1775
+ # The ARN of the event tracker.
1776
+ # @return [String]
1777
+ #
1778
+ # @!attribute [rw] account_id
1779
+ # The Amazon AWS account that owns the event tracker.
1780
+ # @return [String]
1781
+ #
1782
+ # @!attribute [rw] tracking_id
1783
+ # The ID of the event tracker. Include this ID in requests to the
1784
+ # [PutEvents][1] API.
1785
+ #
1786
+ #
1787
+ #
1788
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html
1789
+ # @return [String]
1790
+ #
1791
+ # @!attribute [rw] dataset_group_arn
1792
+ # The Amazon Resource Name (ARN) of the dataset group that receives
1793
+ # the event data.
1794
+ # @return [String]
1795
+ #
1796
+ # @!attribute [rw] status
1797
+ # The status of the event tracker.
1798
+ #
1799
+ # An event tracker can be in one of the following states:
1800
+ #
1801
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1802
+ # FAILED
1803
+ #
1804
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] creation_date_time
1808
+ # The date and time (in Unix format) that the event tracker was
1809
+ # created.
1810
+ # @return [Time]
1811
+ #
1812
+ # @!attribute [rw] last_updated_date_time
1813
+ # The date and time (in Unix time) that the event tracker was last
1814
+ # updated.
1815
+ # @return [Time]
1816
+ #
1817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/EventTracker AWS API Documentation
1818
+ #
1819
+ class EventTracker < Struct.new(
1820
+ :name,
1821
+ :event_tracker_arn,
1822
+ :account_id,
1823
+ :tracking_id,
1824
+ :dataset_group_arn,
1825
+ :status,
1826
+ :creation_date_time,
1827
+ :last_updated_date_time)
1828
+ include Aws::Structure
1829
+ end
1830
+
1831
+ # Provides a summary of the properties of an event tracker. For a
1832
+ # complete listing, call the DescribeEventTracker API.
1833
+ #
1834
+ # @!attribute [rw] name
1835
+ # The name of the event tracker.
1836
+ # @return [String]
1837
+ #
1838
+ # @!attribute [rw] event_tracker_arn
1839
+ # The Amazon Resource Name (ARN) of the event tracker.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] status
1843
+ # The status of the event tracker.
1844
+ #
1845
+ # An event tracker can be in one of the following states:
1846
+ #
1847
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1848
+ # FAILED
1849
+ #
1850
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1851
+ # @return [String]
1852
+ #
1853
+ # @!attribute [rw] creation_date_time
1854
+ # The date and time (in Unix time) that the event tracker was created.
1855
+ # @return [Time]
1856
+ #
1857
+ # @!attribute [rw] last_updated_date_time
1858
+ # The date and time (in Unix time) that the event tracker was last
1859
+ # updated.
1860
+ # @return [Time]
1861
+ #
1862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/EventTrackerSummary AWS API Documentation
1863
+ #
1864
+ class EventTrackerSummary < Struct.new(
1865
+ :name,
1866
+ :event_tracker_arn,
1867
+ :status,
1868
+ :creation_date_time,
1869
+ :last_updated_date_time)
1870
+ include Aws::Structure
1871
+ end
1872
+
1873
+ # Provides feature transformation information. Feature transformation is
1874
+ # the process of modifying raw input data into a form more suitable for
1875
+ # model training.
1876
+ #
1877
+ # @!attribute [rw] name
1878
+ # The name of the feature transformation.
1879
+ # @return [String]
1880
+ #
1881
+ # @!attribute [rw] feature_transformation_arn
1882
+ # The Amazon Resource Name (ARN) of the FeatureTransformation object.
1883
+ # @return [String]
1884
+ #
1885
+ # @!attribute [rw] default_parameters
1886
+ # Provides the default parameters for feature transformation.
1887
+ # @return [Hash<String,String>]
1888
+ #
1889
+ # @!attribute [rw] creation_date_time
1890
+ # The creation date and time (in Unix time) of the feature
1891
+ # transformation.
1892
+ # @return [Time]
1893
+ #
1894
+ # @!attribute [rw] last_updated_date_time
1895
+ # The last update date and time (in Unix time) of the feature
1896
+ # transformation.
1897
+ # @return [Time]
1898
+ #
1899
+ # @!attribute [rw] status
1900
+ # The status of the feature transformation.
1901
+ #
1902
+ # A feature transformation can be in one of the following states:
1903
+ #
1904
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1905
+ # FAILED
1906
+ #
1907
+ # ^
1908
+ # @return [String]
1909
+ #
1910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FeatureTransformation AWS API Documentation
1911
+ #
1912
+ class FeatureTransformation < Struct.new(
1913
+ :name,
1914
+ :feature_transformation_arn,
1915
+ :default_parameters,
1916
+ :creation_date_time,
1917
+ :last_updated_date_time,
1918
+ :status)
1919
+ include Aws::Structure
1920
+ end
1921
+
1922
+ # @note When making an API call, you may pass GetSolutionMetricsRequest
1923
+ # data as a hash:
1924
+ #
1925
+ # {
1926
+ # solution_version_arn: "Arn", # required
1927
+ # }
1928
+ #
1929
+ # @!attribute [rw] solution_version_arn
1930
+ # The Amazon Resource Name (ARN) of the solution version for which to
1931
+ # get metrics.
1932
+ # @return [String]
1933
+ #
1934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetricsRequest AWS API Documentation
1935
+ #
1936
+ class GetSolutionMetricsRequest < Struct.new(
1937
+ :solution_version_arn)
1938
+ include Aws::Structure
1939
+ end
1940
+
1941
+ # @!attribute [rw] solution_version_arn
1942
+ # The same solution version ARN as specified in the request.
1943
+ # @return [String]
1944
+ #
1945
+ # @!attribute [rw] metrics
1946
+ # The metrics for the solution version.
1947
+ # @return [Hash<String,Float>]
1948
+ #
1949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetricsResponse AWS API Documentation
1950
+ #
1951
+ class GetSolutionMetricsResponse < Struct.new(
1952
+ :solution_version_arn,
1953
+ :metrics)
1954
+ include Aws::Structure
1955
+ end
1956
+
1957
+ # Describes the properties for hyperparameter optimization (HPO). For
1958
+ # use with the bring-your-own-recipe feature. Do not use for Amazon
1959
+ # Personalize native recipes.
1960
+ #
1961
+ # @note When making an API call, you may pass HPOConfig
1962
+ # data as a hash:
1963
+ #
1964
+ # {
1965
+ # hpo_objective: {
1966
+ # type: "HPOObjectiveType",
1967
+ # metric_name: "MetricName",
1968
+ # metric_regex: "MetricRegex",
1969
+ # },
1970
+ # hpo_resource_config: {
1971
+ # max_number_of_training_jobs: "HPOResource",
1972
+ # max_parallel_training_jobs: "HPOResource",
1973
+ # },
1974
+ # algorithm_hyper_parameter_ranges: {
1975
+ # integer_hyper_parameter_ranges: [
1976
+ # {
1977
+ # name: "ParameterName",
1978
+ # min_value: 1,
1979
+ # max_value: 1,
1980
+ # },
1981
+ # ],
1982
+ # continuous_hyper_parameter_ranges: [
1983
+ # {
1984
+ # name: "ParameterName",
1985
+ # min_value: 1.0,
1986
+ # max_value: 1.0,
1987
+ # },
1988
+ # ],
1989
+ # categorical_hyper_parameter_ranges: [
1990
+ # {
1991
+ # name: "ParameterName",
1992
+ # values: ["CategoricalValue"],
1993
+ # },
1994
+ # ],
1995
+ # },
1996
+ # }
1997
+ #
1998
+ # @!attribute [rw] hpo_objective
1999
+ # The metric to optimize during HPO.
2000
+ # @return [Types::HPOObjective]
2001
+ #
2002
+ # @!attribute [rw] hpo_resource_config
2003
+ # Describes the resource configuration for HPO.
2004
+ # @return [Types::HPOResourceConfig]
2005
+ #
2006
+ # @!attribute [rw] algorithm_hyper_parameter_ranges
2007
+ # The hyperparameters and their allowable ranges.
2008
+ # @return [Types::HyperParameterRanges]
2009
+ #
2010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/HPOConfig AWS API Documentation
2011
+ #
2012
+ class HPOConfig < Struct.new(
2013
+ :hpo_objective,
2014
+ :hpo_resource_config,
2015
+ :algorithm_hyper_parameter_ranges)
2016
+ include Aws::Structure
2017
+ end
2018
+
2019
+ # The metric to optimize during hyperparameter optimization (HPO).
2020
+ #
2021
+ # @note When making an API call, you may pass HPOObjective
2022
+ # data as a hash:
2023
+ #
2024
+ # {
2025
+ # type: "HPOObjectiveType",
2026
+ # metric_name: "MetricName",
2027
+ # metric_regex: "MetricRegex",
2028
+ # }
2029
+ #
2030
+ # @!attribute [rw] type
2031
+ # The data type of the metric.
2032
+ # @return [String]
2033
+ #
2034
+ # @!attribute [rw] metric_name
2035
+ # The name of the metric.
2036
+ # @return [String]
2037
+ #
2038
+ # @!attribute [rw] metric_regex
2039
+ # A regular expression for finding the metric in the training job
2040
+ # logs.
2041
+ # @return [String]
2042
+ #
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/HPOObjective AWS API Documentation
2044
+ #
2045
+ class HPOObjective < Struct.new(
2046
+ :type,
2047
+ :metric_name,
2048
+ :metric_regex)
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # Describes the resource configuration for hyperparameter optimization
2053
+ # (HPO).
2054
+ #
2055
+ # @note When making an API call, you may pass HPOResourceConfig
2056
+ # data as a hash:
2057
+ #
2058
+ # {
2059
+ # max_number_of_training_jobs: "HPOResource",
2060
+ # max_parallel_training_jobs: "HPOResource",
2061
+ # }
2062
+ #
2063
+ # @!attribute [rw] max_number_of_training_jobs
2064
+ # The maximum number of training jobs.
2065
+ # @return [String]
2066
+ #
2067
+ # @!attribute [rw] max_parallel_training_jobs
2068
+ # The maximum number of parallel training jobs.
2069
+ # @return [String]
2070
+ #
2071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/HPOResourceConfig AWS API Documentation
2072
+ #
2073
+ class HPOResourceConfig < Struct.new(
2074
+ :max_number_of_training_jobs,
2075
+ :max_parallel_training_jobs)
2076
+ include Aws::Structure
2077
+ end
2078
+
2079
+ # Specifies the hyperparameters and their ranges. Hyperparameters can be
2080
+ # categorical, continuous, or integer-valued.
2081
+ #
2082
+ # @note When making an API call, you may pass HyperParameterRanges
2083
+ # data as a hash:
2084
+ #
2085
+ # {
2086
+ # integer_hyper_parameter_ranges: [
2087
+ # {
2088
+ # name: "ParameterName",
2089
+ # min_value: 1,
2090
+ # max_value: 1,
2091
+ # },
2092
+ # ],
2093
+ # continuous_hyper_parameter_ranges: [
2094
+ # {
2095
+ # name: "ParameterName",
2096
+ # min_value: 1.0,
2097
+ # max_value: 1.0,
2098
+ # },
2099
+ # ],
2100
+ # categorical_hyper_parameter_ranges: [
2101
+ # {
2102
+ # name: "ParameterName",
2103
+ # values: ["CategoricalValue"],
2104
+ # },
2105
+ # ],
2106
+ # }
2107
+ #
2108
+ # @!attribute [rw] integer_hyper_parameter_ranges
2109
+ # The integer-valued hyperparameters and their ranges.
2110
+ # @return [Array<Types::IntegerHyperParameterRange>]
2111
+ #
2112
+ # @!attribute [rw] continuous_hyper_parameter_ranges
2113
+ # The continuous hyperparameters and their ranges.
2114
+ # @return [Array<Types::ContinuousHyperParameterRange>]
2115
+ #
2116
+ # @!attribute [rw] categorical_hyper_parameter_ranges
2117
+ # The categorical hyperparameters and their ranges.
2118
+ # @return [Array<Types::CategoricalHyperParameterRange>]
2119
+ #
2120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/HyperParameterRanges AWS API Documentation
2121
+ #
2122
+ class HyperParameterRanges < Struct.new(
2123
+ :integer_hyper_parameter_ranges,
2124
+ :continuous_hyper_parameter_ranges,
2125
+ :categorical_hyper_parameter_ranges)
2126
+ include Aws::Structure
2127
+ end
2128
+
2129
+ # Provides the name and range of an integer-valued hyperparameter.
2130
+ #
2131
+ # @note When making an API call, you may pass IntegerHyperParameterRange
2132
+ # data as a hash:
2133
+ #
2134
+ # {
2135
+ # name: "ParameterName",
2136
+ # min_value: 1,
2137
+ # max_value: 1,
2138
+ # }
2139
+ #
2140
+ # @!attribute [rw] name
2141
+ # The name of the hyperparameter.
2142
+ # @return [String]
2143
+ #
2144
+ # @!attribute [rw] min_value
2145
+ # The minimum allowable value for the hyperparameter.
2146
+ # @return [Integer]
2147
+ #
2148
+ # @!attribute [rw] max_value
2149
+ # The maximum allowable value for the hyperparameter.
2150
+ # @return [Integer]
2151
+ #
2152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/IntegerHyperParameterRange AWS API Documentation
2153
+ #
2154
+ class IntegerHyperParameterRange < Struct.new(
2155
+ :name,
2156
+ :min_value,
2157
+ :max_value)
2158
+ include Aws::Structure
2159
+ end
2160
+
2161
+ # Provide a valid value for the field or parameter.
2162
+ #
2163
+ # @!attribute [rw] message
2164
+ # @return [String]
2165
+ #
2166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/InvalidInputException AWS API Documentation
2167
+ #
2168
+ class InvalidInputException < Struct.new(
2169
+ :message)
2170
+ include Aws::Structure
2171
+ end
2172
+
2173
+ # The token is not valid.
2174
+ #
2175
+ # @!attribute [rw] message
2176
+ # @return [String]
2177
+ #
2178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/InvalidNextTokenException AWS API Documentation
2179
+ #
2180
+ class InvalidNextTokenException < Struct.new(
2181
+ :message)
2182
+ include Aws::Structure
2183
+ end
2184
+
2185
+ # The limit on the number of requests per second has been exceeded.
2186
+ #
2187
+ # @!attribute [rw] message
2188
+ # @return [String]
2189
+ #
2190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/LimitExceededException AWS API Documentation
2191
+ #
2192
+ class LimitExceededException < Struct.new(
2193
+ :message)
2194
+ include Aws::Structure
2195
+ end
2196
+
2197
+ # @note When making an API call, you may pass ListCampaignsRequest
2198
+ # data as a hash:
2199
+ #
2200
+ # {
2201
+ # solution_arn: "Arn",
2202
+ # next_token: "NextToken",
2203
+ # max_results: 1,
2204
+ # }
2205
+ #
2206
+ # @!attribute [rw] solution_arn
2207
+ # The Amazon Resource Name (ARN) of the solution to list the campaigns
2208
+ # for. When a solution is not specified, all the campaigns associated
2209
+ # with the account are listed.
2210
+ # @return [String]
2211
+ #
2212
+ # @!attribute [rw] next_token
2213
+ # A token returned from the previous call to `ListCampaigns` for
2214
+ # getting the next set of campaigns (if they exist).
2215
+ # @return [String]
2216
+ #
2217
+ # @!attribute [rw] max_results
2218
+ # The maximum number of campaigns to return.
2219
+ # @return [Integer]
2220
+ #
2221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaignsRequest AWS API Documentation
2222
+ #
2223
+ class ListCampaignsRequest < Struct.new(
2224
+ :solution_arn,
2225
+ :next_token,
2226
+ :max_results)
2227
+ include Aws::Structure
2228
+ end
2229
+
2230
+ # @!attribute [rw] campaigns
2231
+ # A list of the campaigns.
2232
+ # @return [Array<Types::CampaignSummary>]
2233
+ #
2234
+ # @!attribute [rw] next_token
2235
+ # A token for getting the next set of campaigns (if they exist).
2236
+ # @return [String]
2237
+ #
2238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaignsResponse AWS API Documentation
2239
+ #
2240
+ class ListCampaignsResponse < Struct.new(
2241
+ :campaigns,
2242
+ :next_token)
2243
+ include Aws::Structure
2244
+ end
2245
+
2246
+ # @note When making an API call, you may pass ListDatasetGroupsRequest
2247
+ # data as a hash:
2248
+ #
2249
+ # {
2250
+ # next_token: "NextToken",
2251
+ # max_results: 1,
2252
+ # }
2253
+ #
2254
+ # @!attribute [rw] next_token
2255
+ # A token returned from the previous call to `ListDatasetGroups` for
2256
+ # getting the next set of dataset groups (if they exist).
2257
+ # @return [String]
2258
+ #
2259
+ # @!attribute [rw] max_results
2260
+ # The maximum number of dataset groups to return.
2261
+ # @return [Integer]
2262
+ #
2263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroupsRequest AWS API Documentation
2264
+ #
2265
+ class ListDatasetGroupsRequest < Struct.new(
2266
+ :next_token,
2267
+ :max_results)
2268
+ include Aws::Structure
2269
+ end
2270
+
2271
+ # @!attribute [rw] dataset_groups
2272
+ # The list of your dataset groups.
2273
+ # @return [Array<Types::DatasetGroupSummary>]
2274
+ #
2275
+ # @!attribute [rw] next_token
2276
+ # A token for getting the next set of dataset groups (if they exist).
2277
+ # @return [String]
2278
+ #
2279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroupsResponse AWS API Documentation
2280
+ #
2281
+ class ListDatasetGroupsResponse < Struct.new(
2282
+ :dataset_groups,
2283
+ :next_token)
2284
+ include Aws::Structure
2285
+ end
2286
+
2287
+ # @note When making an API call, you may pass ListDatasetImportJobsRequest
2288
+ # data as a hash:
2289
+ #
2290
+ # {
2291
+ # dataset_arn: "Arn",
2292
+ # next_token: "NextToken",
2293
+ # max_results: 1,
2294
+ # }
2295
+ #
2296
+ # @!attribute [rw] dataset_arn
2297
+ # The Amazon Resource Name (ARN) of the dataset to list the dataset
2298
+ # import jobs for.
2299
+ # @return [String]
2300
+ #
2301
+ # @!attribute [rw] next_token
2302
+ # A token returned from the previous call to `ListDatasetImportJobs`
2303
+ # for getting the next set of dataset import jobs (if they exist).
2304
+ # @return [String]
2305
+ #
2306
+ # @!attribute [rw] max_results
2307
+ # The maximum number of dataset import jobs to return.
2308
+ # @return [Integer]
2309
+ #
2310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobsRequest AWS API Documentation
2311
+ #
2312
+ class ListDatasetImportJobsRequest < Struct.new(
2313
+ :dataset_arn,
2314
+ :next_token,
2315
+ :max_results)
2316
+ include Aws::Structure
2317
+ end
2318
+
2319
+ # @!attribute [rw] dataset_import_jobs
2320
+ # The list of dataset import jobs.
2321
+ # @return [Array<Types::DatasetImportJobSummary>]
2322
+ #
2323
+ # @!attribute [rw] next_token
2324
+ # A token for getting the next set of dataset import jobs (if they
2325
+ # exist).
2326
+ # @return [String]
2327
+ #
2328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobsResponse AWS API Documentation
2329
+ #
2330
+ class ListDatasetImportJobsResponse < Struct.new(
2331
+ :dataset_import_jobs,
2332
+ :next_token)
2333
+ include Aws::Structure
2334
+ end
2335
+
2336
+ # @note When making an API call, you may pass ListDatasetsRequest
2337
+ # data as a hash:
2338
+ #
2339
+ # {
2340
+ # dataset_group_arn: "Arn",
2341
+ # next_token: "NextToken",
2342
+ # max_results: 1,
2343
+ # }
2344
+ #
2345
+ # @!attribute [rw] dataset_group_arn
2346
+ # The Amazon Resource Name (ARN) of the dataset group that contains
2347
+ # the datasets to list.
2348
+ # @return [String]
2349
+ #
2350
+ # @!attribute [rw] next_token
2351
+ # A token returned from the previous call to `ListDatasetImportJobs`
2352
+ # for getting the next set of dataset import jobs (if they exist).
2353
+ # @return [String]
2354
+ #
2355
+ # @!attribute [rw] max_results
2356
+ # The maximum number of datasets to return.
2357
+ # @return [Integer]
2358
+ #
2359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetsRequest AWS API Documentation
2360
+ #
2361
+ class ListDatasetsRequest < Struct.new(
2362
+ :dataset_group_arn,
2363
+ :next_token,
2364
+ :max_results)
2365
+ include Aws::Structure
2366
+ end
2367
+
2368
+ # @!attribute [rw] datasets
2369
+ # An array of `Dataset` objects. Each object provides metadata
2370
+ # information.
2371
+ # @return [Array<Types::DatasetSummary>]
2372
+ #
2373
+ # @!attribute [rw] next_token
2374
+ # A token for getting the next set of datasets (if they exist).
2375
+ # @return [String]
2376
+ #
2377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetsResponse AWS API Documentation
2378
+ #
2379
+ class ListDatasetsResponse < Struct.new(
2380
+ :datasets,
2381
+ :next_token)
2382
+ include Aws::Structure
2383
+ end
2384
+
2385
+ # @note When making an API call, you may pass ListEventTrackersRequest
2386
+ # data as a hash:
2387
+ #
2388
+ # {
2389
+ # dataset_group_arn: "Arn",
2390
+ # next_token: "NextToken",
2391
+ # max_results: 1,
2392
+ # }
2393
+ #
2394
+ # @!attribute [rw] dataset_group_arn
2395
+ # The ARN of a dataset group used to filter the response.
2396
+ # @return [String]
2397
+ #
2398
+ # @!attribute [rw] next_token
2399
+ # A token returned from the previous call to `ListEventTrackers` for
2400
+ # getting the next set of event trackers (if they exist).
2401
+ # @return [String]
2402
+ #
2403
+ # @!attribute [rw] max_results
2404
+ # The maximum number of event trackers to return.
2405
+ # @return [Integer]
2406
+ #
2407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackersRequest AWS API Documentation
2408
+ #
2409
+ class ListEventTrackersRequest < Struct.new(
2410
+ :dataset_group_arn,
2411
+ :next_token,
2412
+ :max_results)
2413
+ include Aws::Structure
2414
+ end
2415
+
2416
+ # @!attribute [rw] event_trackers
2417
+ # A list of event trackers.
2418
+ # @return [Array<Types::EventTrackerSummary>]
2419
+ #
2420
+ # @!attribute [rw] next_token
2421
+ # A token for getting the next set of event trackers (if they exist).
2422
+ # @return [String]
2423
+ #
2424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackersResponse AWS API Documentation
2425
+ #
2426
+ class ListEventTrackersResponse < Struct.new(
2427
+ :event_trackers,
2428
+ :next_token)
2429
+ include Aws::Structure
2430
+ end
2431
+
2432
+ # @note When making an API call, you may pass ListRecipesRequest
2433
+ # data as a hash:
2434
+ #
2435
+ # {
2436
+ # recipe_provider: "SERVICE", # accepts SERVICE
2437
+ # next_token: "NextToken",
2438
+ # max_results: 1,
2439
+ # }
2440
+ #
2441
+ # @!attribute [rw] recipe_provider
2442
+ # The default is `SERVICE`.
2443
+ # @return [String]
2444
+ #
2445
+ # @!attribute [rw] next_token
2446
+ # A token returned from the previous call to `ListRecipes` for getting
2447
+ # the next set of recipes (if they exist).
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] max_results
2451
+ # The maximum number of recipes to return.
2452
+ # @return [Integer]
2453
+ #
2454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesRequest AWS API Documentation
2455
+ #
2456
+ class ListRecipesRequest < Struct.new(
2457
+ :recipe_provider,
2458
+ :next_token,
2459
+ :max_results)
2460
+ include Aws::Structure
2461
+ end
2462
+
2463
+ # @!attribute [rw] recipes
2464
+ # The list of available recipes.
2465
+ # @return [Array<Types::RecipeSummary>]
2466
+ #
2467
+ # @!attribute [rw] next_token
2468
+ # A token for getting the next set of recipes.
2469
+ # @return [String]
2470
+ #
2471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesResponse AWS API Documentation
2472
+ #
2473
+ class ListRecipesResponse < Struct.new(
2474
+ :recipes,
2475
+ :next_token)
2476
+ include Aws::Structure
2477
+ end
2478
+
2479
+ # @note When making an API call, you may pass ListSchemasRequest
2480
+ # data as a hash:
2481
+ #
2482
+ # {
2483
+ # next_token: "NextToken",
2484
+ # max_results: 1,
2485
+ # }
2486
+ #
2487
+ # @!attribute [rw] next_token
2488
+ # A token returned from the previous call to `ListSchemas` for getting
2489
+ # the next set of schemas (if they exist).
2490
+ # @return [String]
2491
+ #
2492
+ # @!attribute [rw] max_results
2493
+ # The maximum number of schemas to return.
2494
+ # @return [Integer]
2495
+ #
2496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemasRequest AWS API Documentation
2497
+ #
2498
+ class ListSchemasRequest < Struct.new(
2499
+ :next_token,
2500
+ :max_results)
2501
+ include Aws::Structure
2502
+ end
2503
+
2504
+ # @!attribute [rw] schemas
2505
+ # A list of schemas.
2506
+ # @return [Array<Types::DatasetSchemaSummary>]
2507
+ #
2508
+ # @!attribute [rw] next_token
2509
+ # A token used to get the next set of schemas (if they exist).
2510
+ # @return [String]
2511
+ #
2512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemasResponse AWS API Documentation
2513
+ #
2514
+ class ListSchemasResponse < Struct.new(
2515
+ :schemas,
2516
+ :next_token)
2517
+ include Aws::Structure
2518
+ end
2519
+
2520
+ # @note When making an API call, you may pass ListSolutionVersionsRequest
2521
+ # data as a hash:
2522
+ #
2523
+ # {
2524
+ # solution_arn: "Arn",
2525
+ # next_token: "NextToken",
2526
+ # max_results: 1,
2527
+ # }
2528
+ #
2529
+ # @!attribute [rw] solution_arn
2530
+ # The Amazon Resource Name (ARN) of the solution.
2531
+ # @return [String]
2532
+ #
2533
+ # @!attribute [rw] next_token
2534
+ # A token returned from the previous call to `ListSolutionVersions`
2535
+ # for getting the next set of solution versions (if they exist).
2536
+ # @return [String]
2537
+ #
2538
+ # @!attribute [rw] max_results
2539
+ # The maximum number of solution versions to return.
2540
+ # @return [Integer]
2541
+ #
2542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersionsRequest AWS API Documentation
2543
+ #
2544
+ class ListSolutionVersionsRequest < Struct.new(
2545
+ :solution_arn,
2546
+ :next_token,
2547
+ :max_results)
2548
+ include Aws::Structure
2549
+ end
2550
+
2551
+ # @!attribute [rw] solution_versions
2552
+ # A list of solution versions describing the version properties.
2553
+ # @return [Array<Types::SolutionVersionSummary>]
2554
+ #
2555
+ # @!attribute [rw] next_token
2556
+ # A token for getting the next set of solution versions (if they
2557
+ # exist).
2558
+ # @return [String]
2559
+ #
2560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersionsResponse AWS API Documentation
2561
+ #
2562
+ class ListSolutionVersionsResponse < Struct.new(
2563
+ :solution_versions,
2564
+ :next_token)
2565
+ include Aws::Structure
2566
+ end
2567
+
2568
+ # @note When making an API call, you may pass ListSolutionsRequest
2569
+ # data as a hash:
2570
+ #
2571
+ # {
2572
+ # dataset_group_arn: "Arn",
2573
+ # next_token: "NextToken",
2574
+ # max_results: 1,
2575
+ # }
2576
+ #
2577
+ # @!attribute [rw] dataset_group_arn
2578
+ # The Amazon Resource Name (ARN) of the dataset group.
2579
+ # @return [String]
2580
+ #
2581
+ # @!attribute [rw] next_token
2582
+ # A token returned from the previous call to `ListSolutions` for
2583
+ # getting the next set of solutions (if they exist).
2584
+ # @return [String]
2585
+ #
2586
+ # @!attribute [rw] max_results
2587
+ # The maximum number of solutions to return.
2588
+ # @return [Integer]
2589
+ #
2590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionsRequest AWS API Documentation
2591
+ #
2592
+ class ListSolutionsRequest < Struct.new(
2593
+ :dataset_group_arn,
2594
+ :next_token,
2595
+ :max_results)
2596
+ include Aws::Structure
2597
+ end
2598
+
2599
+ # @!attribute [rw] solutions
2600
+ # A list of the current solutions.
2601
+ # @return [Array<Types::SolutionSummary>]
2602
+ #
2603
+ # @!attribute [rw] next_token
2604
+ # A token for getting the next set of solutions (if they exist).
2605
+ # @return [String]
2606
+ #
2607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionsResponse AWS API Documentation
2608
+ #
2609
+ class ListSolutionsResponse < Struct.new(
2610
+ :solutions,
2611
+ :next_token)
2612
+ include Aws::Structure
2613
+ end
2614
+
2615
+ # Provides information about a recipe. Each recipe provides an algorithm
2616
+ # that Amazon Personalize uses in model training when you use the
2617
+ # CreateSolution operation.
2618
+ #
2619
+ # @!attribute [rw] name
2620
+ # The name of the recipe.
2621
+ # @return [String]
2622
+ #
2623
+ # @!attribute [rw] recipe_arn
2624
+ # The Amazon Resource Name (ARN) of the recipe.
2625
+ # @return [String]
2626
+ #
2627
+ # @!attribute [rw] algorithm_arn
2628
+ # The Amazon Resource Name (ARN) of the algorithm that Amazon
2629
+ # Personalize uses to train the model.
2630
+ # @return [String]
2631
+ #
2632
+ # @!attribute [rw] feature_transformation_arn
2633
+ # The ARN of the FeatureTransformation object.
2634
+ # @return [String]
2635
+ #
2636
+ # @!attribute [rw] status
2637
+ # The status of the recipe.
2638
+ # @return [String]
2639
+ #
2640
+ # @!attribute [rw] description
2641
+ # The description of the recipe.
2642
+ # @return [String]
2643
+ #
2644
+ # @!attribute [rw] creation_date_time
2645
+ # The date and time (in Unix format) that the recipe was created.
2646
+ # @return [Time]
2647
+ #
2648
+ # @!attribute [rw] recipe_type
2649
+ # One of the following values:
2650
+ #
2651
+ # * SEARCH\_PERSONALIZATION
2652
+ #
2653
+ # * RELATED\_ITEMS
2654
+ #
2655
+ # * USER\_PERSONALIZATION
2656
+ # @return [String]
2657
+ #
2658
+ # @!attribute [rw] last_updated_date_time
2659
+ # The date and time (in Unix format) that the recipe was last updated.
2660
+ # @return [Time]
2661
+ #
2662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Recipe AWS API Documentation
2663
+ #
2664
+ class Recipe < Struct.new(
2665
+ :name,
2666
+ :recipe_arn,
2667
+ :algorithm_arn,
2668
+ :feature_transformation_arn,
2669
+ :status,
2670
+ :description,
2671
+ :creation_date_time,
2672
+ :recipe_type,
2673
+ :last_updated_date_time)
2674
+ include Aws::Structure
2675
+ end
2676
+
2677
+ # Provides a summary of the properties of a recipe. For a complete
2678
+ # listing, call the DescribeRecipe API.
2679
+ #
2680
+ # @!attribute [rw] name
2681
+ # The name of the recipe.
2682
+ # @return [String]
2683
+ #
2684
+ # @!attribute [rw] recipe_arn
2685
+ # The Amazon Resource Name (ARN) of the recipe.
2686
+ # @return [String]
2687
+ #
2688
+ # @!attribute [rw] status
2689
+ # The status of the recipe.
2690
+ # @return [String]
2691
+ #
2692
+ # @!attribute [rw] creation_date_time
2693
+ # The date and time (in Unix time) that the recipe was created.
2694
+ # @return [Time]
2695
+ #
2696
+ # @!attribute [rw] last_updated_date_time
2697
+ # The date and time (in Unix time) that the recipe was last updated.
2698
+ # @return [Time]
2699
+ #
2700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecipeSummary AWS API Documentation
2701
+ #
2702
+ class RecipeSummary < Struct.new(
2703
+ :name,
2704
+ :recipe_arn,
2705
+ :status,
2706
+ :creation_date_time,
2707
+ :last_updated_date_time)
2708
+ include Aws::Structure
2709
+ end
2710
+
2711
+ # The specified resource already exists.
2712
+ #
2713
+ # @!attribute [rw] message
2714
+ # @return [String]
2715
+ #
2716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ResourceAlreadyExistsException AWS API Documentation
2717
+ #
2718
+ class ResourceAlreadyExistsException < Struct.new(
2719
+ :message)
2720
+ include Aws::Structure
2721
+ end
2722
+
2723
+ # The specified resource is in use.
2724
+ #
2725
+ # @!attribute [rw] message
2726
+ # @return [String]
2727
+ #
2728
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ResourceInUseException AWS API Documentation
2729
+ #
2730
+ class ResourceInUseException < Struct.new(
2731
+ :message)
2732
+ include Aws::Structure
2733
+ end
2734
+
2735
+ # Could not find the specified resource.
2736
+ #
2737
+ # @!attribute [rw] message
2738
+ # @return [String]
2739
+ #
2740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ResourceNotFoundException AWS API Documentation
2741
+ #
2742
+ class ResourceNotFoundException < Struct.new(
2743
+ :message)
2744
+ include Aws::Structure
2745
+ end
2746
+
2747
+ # An object that provides information about a solution. A solution is a
2748
+ # trained model that can be deployed as a campaign.
2749
+ #
2750
+ # @!attribute [rw] name
2751
+ # The name of the solution.
2752
+ # @return [String]
2753
+ #
2754
+ # @!attribute [rw] solution_arn
2755
+ # The ARN of the solution.
2756
+ # @return [String]
2757
+ #
2758
+ # @!attribute [rw] perform_hpo
2759
+ # Whether to perform hyperparameter optimization (HPO) on the chosen
2760
+ # recipe. The default is `false`.
2761
+ # @return [Boolean]
2762
+ #
2763
+ # @!attribute [rw] perform_auto_ml
2764
+ # When true, Amazon Personalize performs a search for the best
2765
+ # USER\_PERSONALIZATION recipe from the list specified in the solution
2766
+ # configuration (`recipeArn` must not be specified). When false (the
2767
+ # default), Amazon Personalize uses `recipeArn` for training.
2768
+ # @return [Boolean]
2769
+ #
2770
+ # @!attribute [rw] recipe_arn
2771
+ # The ARN of the recipe used to create the solution.
2772
+ # @return [String]
2773
+ #
2774
+ # @!attribute [rw] dataset_group_arn
2775
+ # The Amazon Resource Name (ARN) of the dataset group that provides
2776
+ # the training data.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] event_type
2780
+ # The event type (for example, 'click' or 'like') that is used for
2781
+ # training the model.
2782
+ # @return [String]
2783
+ #
2784
+ # @!attribute [rw] solution_config
2785
+ # Describes the configuration properties for the solution.
2786
+ # @return [Types::SolutionConfig]
2787
+ #
2788
+ # @!attribute [rw] auto_ml_result
2789
+ # When `performAutoML` is true, specifies the best recipe found.
2790
+ # @return [Types::AutoMLResult]
2791
+ #
2792
+ # @!attribute [rw] status
2793
+ # The status of the solution.
2794
+ #
2795
+ # A solution can be in one of the following states:
2796
+ #
2797
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
2798
+ # FAILED
2799
+ #
2800
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
2801
+ # @return [String]
2802
+ #
2803
+ # @!attribute [rw] creation_date_time
2804
+ # The creation date and time (in Unix time) of the solution.
2805
+ # @return [Time]
2806
+ #
2807
+ # @!attribute [rw] last_updated_date_time
2808
+ # The date and time (in Unix time) that the solution was last updated.
2809
+ # @return [Time]
2810
+ #
2811
+ # @!attribute [rw] latest_solution_version
2812
+ # Describes the latest version of the solution, including the status
2813
+ # and the ARN.
2814
+ # @return [Types::SolutionVersionSummary]
2815
+ #
2816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Solution AWS API Documentation
2817
+ #
2818
+ class Solution < Struct.new(
2819
+ :name,
2820
+ :solution_arn,
2821
+ :perform_hpo,
2822
+ :perform_auto_ml,
2823
+ :recipe_arn,
2824
+ :dataset_group_arn,
2825
+ :event_type,
2826
+ :solution_config,
2827
+ :auto_ml_result,
2828
+ :status,
2829
+ :creation_date_time,
2830
+ :last_updated_date_time,
2831
+ :latest_solution_version)
2832
+ include Aws::Structure
2833
+ end
2834
+
2835
+ # Describes the configuration properties for the solution.
2836
+ #
2837
+ # @note When making an API call, you may pass SolutionConfig
2838
+ # data as a hash:
2839
+ #
2840
+ # {
2841
+ # event_value_threshold: "EventValueThreshold",
2842
+ # hpo_config: {
2843
+ # hpo_objective: {
2844
+ # type: "HPOObjectiveType",
2845
+ # metric_name: "MetricName",
2846
+ # metric_regex: "MetricRegex",
2847
+ # },
2848
+ # hpo_resource_config: {
2849
+ # max_number_of_training_jobs: "HPOResource",
2850
+ # max_parallel_training_jobs: "HPOResource",
2851
+ # },
2852
+ # algorithm_hyper_parameter_ranges: {
2853
+ # integer_hyper_parameter_ranges: [
2854
+ # {
2855
+ # name: "ParameterName",
2856
+ # min_value: 1,
2857
+ # max_value: 1,
2858
+ # },
2859
+ # ],
2860
+ # continuous_hyper_parameter_ranges: [
2861
+ # {
2862
+ # name: "ParameterName",
2863
+ # min_value: 1.0,
2864
+ # max_value: 1.0,
2865
+ # },
2866
+ # ],
2867
+ # categorical_hyper_parameter_ranges: [
2868
+ # {
2869
+ # name: "ParameterName",
2870
+ # values: ["CategoricalValue"],
2871
+ # },
2872
+ # ],
2873
+ # },
2874
+ # },
2875
+ # algorithm_hyper_parameters: {
2876
+ # "ParameterName" => "ParameterValue",
2877
+ # },
2878
+ # feature_transformation_parameters: {
2879
+ # "ParameterName" => "ParameterValue",
2880
+ # },
2881
+ # auto_ml_config: {
2882
+ # metric_name: "MetricName",
2883
+ # recipe_list: ["Arn"],
2884
+ # },
2885
+ # }
2886
+ #
2887
+ # @!attribute [rw] event_value_threshold
2888
+ # Only events with a value greater than or equal to this threshold are
2889
+ # used for training a model.
2890
+ # @return [String]
2891
+ #
2892
+ # @!attribute [rw] hpo_config
2893
+ # Describes the properties for hyperparameter optimization (HPO). For
2894
+ # use with the bring-your-own-recipe feature. Not used with Amazon
2895
+ # Personalize predefined recipes.
2896
+ # @return [Types::HPOConfig]
2897
+ #
2898
+ # @!attribute [rw] algorithm_hyper_parameters
2899
+ # Lists the hyperparameter names and ranges.
2900
+ # @return [Hash<String,String>]
2901
+ #
2902
+ # @!attribute [rw] feature_transformation_parameters
2903
+ # Lists the feature transformation parameters.
2904
+ # @return [Hash<String,String>]
2905
+ #
2906
+ # @!attribute [rw] auto_ml_config
2907
+ # The AutoMLConfig object containing a list of recipes to search when
2908
+ # AutoML is performed.
2909
+ # @return [Types::AutoMLConfig]
2910
+ #
2911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionConfig AWS API Documentation
2912
+ #
2913
+ class SolutionConfig < Struct.new(
2914
+ :event_value_threshold,
2915
+ :hpo_config,
2916
+ :algorithm_hyper_parameters,
2917
+ :feature_transformation_parameters,
2918
+ :auto_ml_config)
2919
+ include Aws::Structure
2920
+ end
2921
+
2922
+ # Provides a summary of the properties of a solution. For a complete
2923
+ # listing, call the DescribeSolution API.
2924
+ #
2925
+ # @!attribute [rw] name
2926
+ # The name of the solution.
2927
+ # @return [String]
2928
+ #
2929
+ # @!attribute [rw] solution_arn
2930
+ # The Amazon Resource Name (ARN) of the solution.
2931
+ # @return [String]
2932
+ #
2933
+ # @!attribute [rw] status
2934
+ # The status of the solution.
2935
+ #
2936
+ # A solution can be in one of the following states:
2937
+ #
2938
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
2939
+ # FAILED
2940
+ #
2941
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
2942
+ # @return [String]
2943
+ #
2944
+ # @!attribute [rw] creation_date_time
2945
+ # The date and time (in Unix time) that the solution was created.
2946
+ # @return [Time]
2947
+ #
2948
+ # @!attribute [rw] last_updated_date_time
2949
+ # The date and time (in Unix time) that the solution was last updated.
2950
+ # @return [Time]
2951
+ #
2952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionSummary AWS API Documentation
2953
+ #
2954
+ class SolutionSummary < Struct.new(
2955
+ :name,
2956
+ :solution_arn,
2957
+ :status,
2958
+ :creation_date_time,
2959
+ :last_updated_date_time)
2960
+ include Aws::Structure
2961
+ end
2962
+
2963
+ # An object that provides information about a specific version of a
2964
+ # Solution.
2965
+ #
2966
+ # @!attribute [rw] solution_version_arn
2967
+ # The ARN of the solution version.
2968
+ # @return [String]
2969
+ #
2970
+ # @!attribute [rw] solution_arn
2971
+ # The ARN of the solution.
2972
+ # @return [String]
2973
+ #
2974
+ # @!attribute [rw] perform_hpo
2975
+ # Whether to perform hyperparameter optimization (HPO) on the chosen
2976
+ # recipe. The default is `false`.
2977
+ # @return [Boolean]
2978
+ #
2979
+ # @!attribute [rw] perform_auto_ml
2980
+ # When true, Amazon Personalize performs a search for the most optimal
2981
+ # recipe according to the solution configuration. When false (the
2982
+ # default), Amazon Personalize uses `recipeArn`.
2983
+ # @return [Boolean]
2984
+ #
2985
+ # @!attribute [rw] recipe_arn
2986
+ # The ARN of the recipe used in the solution.
2987
+ # @return [String]
2988
+ #
2989
+ # @!attribute [rw] event_type
2990
+ # The event type (for example, 'click' or 'like') that is used for
2991
+ # training the model.
2992
+ # @return [String]
2993
+ #
2994
+ # @!attribute [rw] dataset_group_arn
2995
+ # The Amazon Resource Name (ARN) of the dataset group providing the
2996
+ # training data.
2997
+ # @return [String]
2998
+ #
2999
+ # @!attribute [rw] solution_config
3000
+ # Describes the configuration properties for the solution.
3001
+ # @return [Types::SolutionConfig]
3002
+ #
3003
+ # @!attribute [rw] status
3004
+ # The status of the solution version.
3005
+ #
3006
+ # A solution version can be in one of the following states:
3007
+ #
3008
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
3009
+ # FAILED
3010
+ #
3011
+ # ^
3012
+ # @return [String]
3013
+ #
3014
+ # @!attribute [rw] failure_reason
3015
+ # If training a solution version fails, the reason behind the failure.
3016
+ # @return [String]
3017
+ #
3018
+ # @!attribute [rw] creation_date_time
3019
+ # The date and time (in Unix time) that this version of the solution
3020
+ # was created.
3021
+ # @return [Time]
3022
+ #
3023
+ # @!attribute [rw] last_updated_date_time
3024
+ # The date and time (in Unix time) that the solution was last updated.
3025
+ # @return [Time]
3026
+ #
3027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionVersion AWS API Documentation
3028
+ #
3029
+ class SolutionVersion < Struct.new(
3030
+ :solution_version_arn,
3031
+ :solution_arn,
3032
+ :perform_hpo,
3033
+ :perform_auto_ml,
3034
+ :recipe_arn,
3035
+ :event_type,
3036
+ :dataset_group_arn,
3037
+ :solution_config,
3038
+ :status,
3039
+ :failure_reason,
3040
+ :creation_date_time,
3041
+ :last_updated_date_time)
3042
+ include Aws::Structure
3043
+ end
3044
+
3045
+ # Provides a summary of the properties of a solution version. For a
3046
+ # complete listing, call the DescribeSolutionVersion API.
3047
+ #
3048
+ # @!attribute [rw] solution_version_arn
3049
+ # The Amazon Resource Name (ARN) of the solution version.
3050
+ # @return [String]
3051
+ #
3052
+ # @!attribute [rw] status
3053
+ # The status of the solution version.
3054
+ #
3055
+ # A solution version can be in one of the following states:
3056
+ #
3057
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
3058
+ # FAILED
3059
+ #
3060
+ # ^
3061
+ # @return [String]
3062
+ #
3063
+ # @!attribute [rw] creation_date_time
3064
+ # The date and time (in Unix time) that this version of a solution was
3065
+ # created.
3066
+ # @return [Time]
3067
+ #
3068
+ # @!attribute [rw] last_updated_date_time
3069
+ # The date and time (in Unix time) that the solution version was last
3070
+ # updated.
3071
+ # @return [Time]
3072
+ #
3073
+ # @!attribute [rw] failure_reason
3074
+ # If a solution version fails, the reason behind the failure.
3075
+ # @return [String]
3076
+ #
3077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionVersionSummary AWS API Documentation
3078
+ #
3079
+ class SolutionVersionSummary < Struct.new(
3080
+ :solution_version_arn,
3081
+ :status,
3082
+ :creation_date_time,
3083
+ :last_updated_date_time,
3084
+ :failure_reason)
3085
+ include Aws::Structure
3086
+ end
3087
+
3088
+ # @note When making an API call, you may pass UpdateCampaignRequest
3089
+ # data as a hash:
3090
+ #
3091
+ # {
3092
+ # campaign_arn: "Arn", # required
3093
+ # solution_version_arn: "Arn",
3094
+ # min_provisioned_tps: 1,
3095
+ # }
3096
+ #
3097
+ # @!attribute [rw] campaign_arn
3098
+ # The Amazon Resource Name (ARN) of the campaign.
3099
+ # @return [String]
3100
+ #
3101
+ # @!attribute [rw] solution_version_arn
3102
+ # The ARN of a new solution version to deploy.
3103
+ # @return [String]
3104
+ #
3105
+ # @!attribute [rw] min_provisioned_tps
3106
+ # Specifies the requested minimum provisioned transactions
3107
+ # (recommendations) per second that Amazon Personalize will support.
3108
+ # @return [Integer]
3109
+ #
3110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaignRequest AWS API Documentation
3111
+ #
3112
+ class UpdateCampaignRequest < Struct.new(
3113
+ :campaign_arn,
3114
+ :solution_version_arn,
3115
+ :min_provisioned_tps)
3116
+ include Aws::Structure
3117
+ end
3118
+
3119
+ # @!attribute [rw] campaign_arn
3120
+ # The same campaign ARN as given in the request.
3121
+ # @return [String]
3122
+ #
3123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaignResponse AWS API Documentation
3124
+ #
3125
+ class UpdateCampaignResponse < Struct.new(
3126
+ :campaign_arn)
3127
+ include Aws::Structure
3128
+ end
3129
+
3130
+ end
3131
+ end