aws-sdk-personalize 1.33.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +479 -13
- data/lib/aws-sdk-personalize/client_api.rb +261 -0
- data/lib/aws-sdk-personalize/types.rb +855 -32
- data/lib/aws-sdk-personalize.rb +1 -1
- metadata +2 -2
@@ -365,8 +365,195 @@ module Aws::Personalize
|
|
365
365
|
include Aws::Structure
|
366
366
|
end
|
367
367
|
|
368
|
-
#
|
369
|
-
#
|
368
|
+
# Contains information on a batch segment job.
|
369
|
+
#
|
370
|
+
# @!attribute [rw] job_name
|
371
|
+
# The name of the batch segment job.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] batch_segment_job_arn
|
375
|
+
# The Amazon Resource Name (ARN) of the batch segment job.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] filter_arn
|
379
|
+
# The ARN of the filter used on the batch segment job.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] failure_reason
|
383
|
+
# If the batch segment job failed, the reason for the failure.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] solution_version_arn
|
387
|
+
# The Amazon Resource Name (ARN) of the solution version used by the
|
388
|
+
# batch segment job to generate batch segments.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] num_results
|
392
|
+
# The number of predicted users generated by the batch segment job for
|
393
|
+
# each line of input data.
|
394
|
+
# @return [Integer]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] job_input
|
397
|
+
# The Amazon S3 path that leads to the input data used to generate the
|
398
|
+
# batch segment job.
|
399
|
+
# @return [Types::BatchSegmentJobInput]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] job_output
|
402
|
+
# The Amazon S3 bucket that contains the output data generated by the
|
403
|
+
# batch segment job.
|
404
|
+
# @return [Types::BatchSegmentJobOutput]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] role_arn
|
407
|
+
# The ARN of the Amazon Identity and Access Management (IAM) role that
|
408
|
+
# requested the batch segment job.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] status
|
412
|
+
# The status of the batch segment job. The status is one of the
|
413
|
+
# following values:
|
414
|
+
#
|
415
|
+
# * PENDING
|
416
|
+
#
|
417
|
+
# * IN PROGRESS
|
418
|
+
#
|
419
|
+
# * ACTIVE
|
420
|
+
#
|
421
|
+
# * CREATE FAILED
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] creation_date_time
|
425
|
+
# The time at which the batch segment job was created.
|
426
|
+
# @return [Time]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] last_updated_date_time
|
429
|
+
# The time at which the batch segment job last updated.
|
430
|
+
# @return [Time]
|
431
|
+
#
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJob AWS API Documentation
|
433
|
+
#
|
434
|
+
class BatchSegmentJob < Struct.new(
|
435
|
+
:job_name,
|
436
|
+
:batch_segment_job_arn,
|
437
|
+
:filter_arn,
|
438
|
+
:failure_reason,
|
439
|
+
:solution_version_arn,
|
440
|
+
:num_results,
|
441
|
+
:job_input,
|
442
|
+
:job_output,
|
443
|
+
:role_arn,
|
444
|
+
:status,
|
445
|
+
:creation_date_time,
|
446
|
+
:last_updated_date_time)
|
447
|
+
SENSITIVE = []
|
448
|
+
include Aws::Structure
|
449
|
+
end
|
450
|
+
|
451
|
+
# The input configuration of a batch segment job.
|
452
|
+
#
|
453
|
+
# @note When making an API call, you may pass BatchSegmentJobInput
|
454
|
+
# data as a hash:
|
455
|
+
#
|
456
|
+
# {
|
457
|
+
# s3_data_source: { # required
|
458
|
+
# path: "S3Location", # required
|
459
|
+
# kms_key_arn: "KmsKeyArn",
|
460
|
+
# },
|
461
|
+
# }
|
462
|
+
#
|
463
|
+
# @!attribute [rw] s3_data_source
|
464
|
+
# The configuration details of an Amazon S3 input or output bucket.
|
465
|
+
# @return [Types::S3DataConfig]
|
466
|
+
#
|
467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobInput AWS API Documentation
|
468
|
+
#
|
469
|
+
class BatchSegmentJobInput < Struct.new(
|
470
|
+
:s3_data_source)
|
471
|
+
SENSITIVE = []
|
472
|
+
include Aws::Structure
|
473
|
+
end
|
474
|
+
|
475
|
+
# The output configuration parameters of a batch segment job.
|
476
|
+
#
|
477
|
+
# @note When making an API call, you may pass BatchSegmentJobOutput
|
478
|
+
# data as a hash:
|
479
|
+
#
|
480
|
+
# {
|
481
|
+
# s3_data_destination: { # required
|
482
|
+
# path: "S3Location", # required
|
483
|
+
# kms_key_arn: "KmsKeyArn",
|
484
|
+
# },
|
485
|
+
# }
|
486
|
+
#
|
487
|
+
# @!attribute [rw] s3_data_destination
|
488
|
+
# The configuration details of an Amazon S3 input or output bucket.
|
489
|
+
# @return [Types::S3DataConfig]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobOutput AWS API Documentation
|
492
|
+
#
|
493
|
+
class BatchSegmentJobOutput < Struct.new(
|
494
|
+
:s3_data_destination)
|
495
|
+
SENSITIVE = []
|
496
|
+
include Aws::Structure
|
497
|
+
end
|
498
|
+
|
499
|
+
# A truncated version of the BatchSegmentJob datatype. The
|
500
|
+
# ListBatchSegmentJobs operation returns a list of batch segment job
|
501
|
+
# summaries.
|
502
|
+
#
|
503
|
+
# @!attribute [rw] batch_segment_job_arn
|
504
|
+
# The Amazon Resource Name (ARN) of the batch segment job.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] job_name
|
508
|
+
# The name of the batch segment job.
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] status
|
512
|
+
# The status of the batch segment job. The status is one of the
|
513
|
+
# following values:
|
514
|
+
#
|
515
|
+
# * PENDING
|
516
|
+
#
|
517
|
+
# * IN PROGRESS
|
518
|
+
#
|
519
|
+
# * ACTIVE
|
520
|
+
#
|
521
|
+
# * CREATE FAILED
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] creation_date_time
|
525
|
+
# The time at which the batch segment job was created.
|
526
|
+
# @return [Time]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] last_updated_date_time
|
529
|
+
# The time at which the batch segment job was last updated.
|
530
|
+
# @return [Time]
|
531
|
+
#
|
532
|
+
# @!attribute [rw] failure_reason
|
533
|
+
# If the batch segment job failed, the reason for the failure.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] solution_version_arn
|
537
|
+
# The Amazon Resource Name (ARN) of the solution version used by the
|
538
|
+
# batch segment job to generate batch segments.
|
539
|
+
# @return [String]
|
540
|
+
#
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobSummary AWS API Documentation
|
542
|
+
#
|
543
|
+
class BatchSegmentJobSummary < Struct.new(
|
544
|
+
:batch_segment_job_arn,
|
545
|
+
:job_name,
|
546
|
+
:status,
|
547
|
+
:creation_date_time,
|
548
|
+
:last_updated_date_time,
|
549
|
+
:failure_reason,
|
550
|
+
:solution_version_arn)
|
551
|
+
SENSITIVE = []
|
552
|
+
include Aws::Structure
|
553
|
+
end
|
554
|
+
|
555
|
+
# An object that describes the deployment of a solution version. For
|
556
|
+
# more information on campaigns, see CreateCampaign.
|
370
557
|
#
|
371
558
|
# @!attribute [rw] name
|
372
559
|
# The name of the campaign.
|
@@ -448,12 +635,11 @@ module Aws::Personalize
|
|
448
635
|
# }
|
449
636
|
#
|
450
637
|
# @!attribute [rw] item_exploration_config
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
# [User-Personalization][1] recipe.
|
638
|
+
# Specifies the exploration configuration hyperparameters, including
|
639
|
+
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
640
|
+
# to configure the amount of item exploration Amazon Personalize uses
|
641
|
+
# when recommending items. Provide `itemExplorationConfig` data only
|
642
|
+
# if your solution uses the [User-Personalization][1] recipe.
|
457
643
|
#
|
458
644
|
#
|
459
645
|
#
|
@@ -728,6 +914,90 @@ module Aws::Personalize
|
|
728
914
|
include Aws::Structure
|
729
915
|
end
|
730
916
|
|
917
|
+
# @note When making an API call, you may pass CreateBatchSegmentJobRequest
|
918
|
+
# data as a hash:
|
919
|
+
#
|
920
|
+
# {
|
921
|
+
# job_name: "Name", # required
|
922
|
+
# solution_version_arn: "Arn", # required
|
923
|
+
# filter_arn: "Arn",
|
924
|
+
# num_results: 1,
|
925
|
+
# job_input: { # required
|
926
|
+
# s3_data_source: { # required
|
927
|
+
# path: "S3Location", # required
|
928
|
+
# kms_key_arn: "KmsKeyArn",
|
929
|
+
# },
|
930
|
+
# },
|
931
|
+
# job_output: { # required
|
932
|
+
# s3_data_destination: { # required
|
933
|
+
# path: "S3Location", # required
|
934
|
+
# kms_key_arn: "KmsKeyArn",
|
935
|
+
# },
|
936
|
+
# },
|
937
|
+
# role_arn: "RoleArn", # required
|
938
|
+
# }
|
939
|
+
#
|
940
|
+
# @!attribute [rw] job_name
|
941
|
+
# The name of the batch segment job to create.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] solution_version_arn
|
945
|
+
# The Amazon Resource Name (ARN) of the solution version you want the
|
946
|
+
# batch segment job to use to generate batch segments.
|
947
|
+
# @return [String]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] filter_arn
|
950
|
+
# The ARN of the filter to apply to the batch segment job. For more
|
951
|
+
# information on using filters, see filter-batch.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @!attribute [rw] num_results
|
955
|
+
# The number of predicted users generated by the batch segment job for
|
956
|
+
# each line of input data.
|
957
|
+
# @return [Integer]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] job_input
|
960
|
+
# The Amazon S3 path for the input data used to generate the batch
|
961
|
+
# segment job.
|
962
|
+
# @return [Types::BatchSegmentJobInput]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] job_output
|
965
|
+
# The Amazon S3 path for the bucket where the job's output will be
|
966
|
+
# stored.
|
967
|
+
# @return [Types::BatchSegmentJobOutput]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] role_arn
|
970
|
+
# The ARN of the Amazon Identity and Access Management role that has
|
971
|
+
# permissions to read and write to your input and output Amazon S3
|
972
|
+
# buckets respectively.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobRequest AWS API Documentation
|
976
|
+
#
|
977
|
+
class CreateBatchSegmentJobRequest < Struct.new(
|
978
|
+
:job_name,
|
979
|
+
:solution_version_arn,
|
980
|
+
:filter_arn,
|
981
|
+
:num_results,
|
982
|
+
:job_input,
|
983
|
+
:job_output,
|
984
|
+
:role_arn)
|
985
|
+
SENSITIVE = []
|
986
|
+
include Aws::Structure
|
987
|
+
end
|
988
|
+
|
989
|
+
# @!attribute [rw] batch_segment_job_arn
|
990
|
+
# The ARN of the batch segment job.
|
991
|
+
# @return [String]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobResponse AWS API Documentation
|
994
|
+
#
|
995
|
+
class CreateBatchSegmentJobResponse < Struct.new(
|
996
|
+
:batch_segment_job_arn)
|
997
|
+
SENSITIVE = []
|
998
|
+
include Aws::Structure
|
999
|
+
end
|
1000
|
+
|
731
1001
|
# @note When making an API call, you may pass CreateCampaignRequest
|
732
1002
|
# data as a hash:
|
733
1003
|
#
|
@@ -856,6 +1126,7 @@ module Aws::Personalize
|
|
856
1126
|
# name: "Name", # required
|
857
1127
|
# role_arn: "RoleArn",
|
858
1128
|
# kms_key_arn: "KmsKeyArn",
|
1129
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
859
1130
|
# }
|
860
1131
|
#
|
861
1132
|
# @!attribute [rw] name
|
@@ -873,12 +1144,21 @@ module Aws::Personalize
|
|
873
1144
|
# used to encrypt the datasets.
|
874
1145
|
# @return [String]
|
875
1146
|
#
|
1147
|
+
# @!attribute [rw] domain
|
1148
|
+
# The domain of the dataset group. Specify a domain to create a Domain
|
1149
|
+
# dataset group. The domain you specify determines the default schemas
|
1150
|
+
# for datasets and the use cases available for recommenders. If you
|
1151
|
+
# don't specify a domain, you create a Custom dataset group with
|
1152
|
+
# solution versions that you deploy with a campaign.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
876
1155
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupRequest AWS API Documentation
|
877
1156
|
#
|
878
1157
|
class CreateDatasetGroupRequest < Struct.new(
|
879
1158
|
:name,
|
880
1159
|
:role_arn,
|
881
|
-
:kms_key_arn
|
1160
|
+
:kms_key_arn,
|
1161
|
+
:domain)
|
882
1162
|
SENSITIVE = []
|
883
1163
|
include Aws::Structure
|
884
1164
|
end
|
@@ -887,10 +1167,15 @@ module Aws::Personalize
|
|
887
1167
|
# The Amazon Resource Name (ARN) of the new dataset group.
|
888
1168
|
# @return [String]
|
889
1169
|
#
|
1170
|
+
# @!attribute [rw] domain
|
1171
|
+
# The domain for the new Domain dataset group.
|
1172
|
+
# @return [String]
|
1173
|
+
#
|
890
1174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupResponse AWS API Documentation
|
891
1175
|
#
|
892
1176
|
class CreateDatasetGroupResponse < Struct.new(
|
893
|
-
:dataset_group_arn
|
1177
|
+
:dataset_group_arn,
|
1178
|
+
:domain)
|
894
1179
|
SENSITIVE = []
|
895
1180
|
include Aws::Structure
|
896
1181
|
end
|
@@ -1100,12 +1385,75 @@ module Aws::Personalize
|
|
1100
1385
|
include Aws::Structure
|
1101
1386
|
end
|
1102
1387
|
|
1388
|
+
# @note When making an API call, you may pass CreateRecommenderRequest
|
1389
|
+
# data as a hash:
|
1390
|
+
#
|
1391
|
+
# {
|
1392
|
+
# name: "Name", # required
|
1393
|
+
# dataset_group_arn: "Arn", # required
|
1394
|
+
# recipe_arn: "Arn", # required
|
1395
|
+
# recommender_config: {
|
1396
|
+
# item_exploration_config: {
|
1397
|
+
# "ParameterName" => "ParameterValue",
|
1398
|
+
# },
|
1399
|
+
# },
|
1400
|
+
# }
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] name
|
1403
|
+
# The name of the recommender.
|
1404
|
+
# @return [String]
|
1405
|
+
#
|
1406
|
+
# @!attribute [rw] dataset_group_arn
|
1407
|
+
# The Amazon Resource Name (ARN) of the destination domain dataset
|
1408
|
+
# group for the recommender.
|
1409
|
+
# @return [String]
|
1410
|
+
#
|
1411
|
+
# @!attribute [rw] recipe_arn
|
1412
|
+
# The Amazon Resource Name (ARN) of the recipe that the recommender
|
1413
|
+
# will use. For a recommender, a recipe is a Domain dataset group use
|
1414
|
+
# case. Only Domain dataset group use cases can be used to create a
|
1415
|
+
# recommender. For information about use cases see [Choosing
|
1416
|
+
# recommender use cases][1].
|
1417
|
+
#
|
1418
|
+
#
|
1419
|
+
#
|
1420
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] recommender_config
|
1424
|
+
# The configuration details of the recommender.
|
1425
|
+
# @return [Types::RecommenderConfig]
|
1426
|
+
#
|
1427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderRequest AWS API Documentation
|
1428
|
+
#
|
1429
|
+
class CreateRecommenderRequest < Struct.new(
|
1430
|
+
:name,
|
1431
|
+
:dataset_group_arn,
|
1432
|
+
:recipe_arn,
|
1433
|
+
:recommender_config)
|
1434
|
+
SENSITIVE = []
|
1435
|
+
include Aws::Structure
|
1436
|
+
end
|
1437
|
+
|
1438
|
+
# @!attribute [rw] recommender_arn
|
1439
|
+
# The Amazon Resource Name (ARN) of the recommender.
|
1440
|
+
# @return [String]
|
1441
|
+
#
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderResponse AWS API Documentation
|
1443
|
+
#
|
1444
|
+
class CreateRecommenderResponse < Struct.new(
|
1445
|
+
:recommender_arn)
|
1446
|
+
SENSITIVE = []
|
1447
|
+
include Aws::Structure
|
1448
|
+
end
|
1449
|
+
|
1103
1450
|
# @note When making an API call, you may pass CreateSchemaRequest
|
1104
1451
|
# data as a hash:
|
1105
1452
|
#
|
1106
1453
|
# {
|
1107
1454
|
# name: "Name", # required
|
1108
1455
|
# schema: "AvroSchema", # required
|
1456
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
1109
1457
|
# }
|
1110
1458
|
#
|
1111
1459
|
# @!attribute [rw] name
|
@@ -1116,11 +1464,18 @@ module Aws::Personalize
|
|
1116
1464
|
# A schema in Avro JSON format.
|
1117
1465
|
# @return [String]
|
1118
1466
|
#
|
1467
|
+
# @!attribute [rw] domain
|
1468
|
+
# The domain for the schema. If you are creating a schema for a
|
1469
|
+
# dataset in a Domain dataset group, specify the domain you chose when
|
1470
|
+
# you created the Domain dataset group.
|
1471
|
+
# @return [String]
|
1472
|
+
#
|
1119
1473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchemaRequest AWS API Documentation
|
1120
1474
|
#
|
1121
1475
|
class CreateSchemaRequest < Struct.new(
|
1122
1476
|
:name,
|
1123
|
-
:schema
|
1477
|
+
:schema,
|
1478
|
+
:domain)
|
1124
1479
|
SENSITIVE = []
|
1125
1480
|
include Aws::Structure
|
1126
1481
|
end
|
@@ -1628,6 +1983,10 @@ module Aws::Personalize
|
|
1628
1983
|
# If creating a dataset group fails, provides the reason why.
|
1629
1984
|
# @return [String]
|
1630
1985
|
#
|
1986
|
+
# @!attribute [rw] domain
|
1987
|
+
# The domain of a Domain dataset group.
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1631
1990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroup AWS API Documentation
|
1632
1991
|
#
|
1633
1992
|
class DatasetGroup < Struct.new(
|
@@ -1638,7 +1997,8 @@ module Aws::Personalize
|
|
1638
1997
|
:kms_key_arn,
|
1639
1998
|
:creation_date_time,
|
1640
1999
|
:last_updated_date_time,
|
1641
|
-
:failure_reason
|
2000
|
+
:failure_reason,
|
2001
|
+
:domain)
|
1642
2002
|
SENSITIVE = []
|
1643
2003
|
include Aws::Structure
|
1644
2004
|
end
|
@@ -1678,6 +2038,10 @@ module Aws::Personalize
|
|
1678
2038
|
# If creating a dataset group fails, the reason behind the failure.
|
1679
2039
|
# @return [String]
|
1680
2040
|
#
|
2041
|
+
# @!attribute [rw] domain
|
2042
|
+
# The domain of a Domain dataset group.
|
2043
|
+
# @return [String]
|
2044
|
+
#
|
1681
2045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroupSummary AWS API Documentation
|
1682
2046
|
#
|
1683
2047
|
class DatasetGroupSummary < Struct.new(
|
@@ -1686,7 +2050,8 @@ module Aws::Personalize
|
|
1686
2050
|
:status,
|
1687
2051
|
:creation_date_time,
|
1688
2052
|
:last_updated_date_time,
|
1689
|
-
:failure_reason
|
2053
|
+
:failure_reason,
|
2054
|
+
:domain)
|
1690
2055
|
SENSITIVE = []
|
1691
2056
|
include Aws::Structure
|
1692
2057
|
end
|
@@ -1835,6 +2200,11 @@ module Aws::Personalize
|
|
1835
2200
|
# The date and time (in Unix time) that the schema was last updated.
|
1836
2201
|
# @return [Time]
|
1837
2202
|
#
|
2203
|
+
# @!attribute [rw] domain
|
2204
|
+
# The domain of a schema that you created for a dataset in a Domain
|
2205
|
+
# dataset group.
|
2206
|
+
# @return [String]
|
2207
|
+
#
|
1838
2208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchema AWS API Documentation
|
1839
2209
|
#
|
1840
2210
|
class DatasetSchema < Struct.new(
|
@@ -1842,7 +2212,8 @@ module Aws::Personalize
|
|
1842
2212
|
:schema_arn,
|
1843
2213
|
:schema,
|
1844
2214
|
:creation_date_time,
|
1845
|
-
:last_updated_date_time
|
2215
|
+
:last_updated_date_time,
|
2216
|
+
:domain)
|
1846
2217
|
SENSITIVE = []
|
1847
2218
|
include Aws::Structure
|
1848
2219
|
end
|
@@ -1866,13 +2237,19 @@ module Aws::Personalize
|
|
1866
2237
|
# The date and time (in Unix time) that the schema was last updated.
|
1867
2238
|
# @return [Time]
|
1868
2239
|
#
|
2240
|
+
# @!attribute [rw] domain
|
2241
|
+
# The domain of a schema that you created for a dataset in a Domain
|
2242
|
+
# dataset group.
|
2243
|
+
# @return [String]
|
2244
|
+
#
|
1869
2245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchemaSummary AWS API Documentation
|
1870
2246
|
#
|
1871
2247
|
class DatasetSchemaSummary < Struct.new(
|
1872
2248
|
:name,
|
1873
2249
|
:schema_arn,
|
1874
2250
|
:creation_date_time,
|
1875
|
-
:last_updated_date_time
|
2251
|
+
:last_updated_date_time,
|
2252
|
+
:domain)
|
1876
2253
|
SENSITIVE = []
|
1877
2254
|
include Aws::Structure
|
1878
2255
|
end
|
@@ -2142,6 +2519,25 @@ module Aws::Personalize
|
|
2142
2519
|
include Aws::Structure
|
2143
2520
|
end
|
2144
2521
|
|
2522
|
+
# @note When making an API call, you may pass DeleteRecommenderRequest
|
2523
|
+
# data as a hash:
|
2524
|
+
#
|
2525
|
+
# {
|
2526
|
+
# recommender_arn: "Arn", # required
|
2527
|
+
# }
|
2528
|
+
#
|
2529
|
+
# @!attribute [rw] recommender_arn
|
2530
|
+
# The Amazon Resource Name (ARN) of the recommender to delete.
|
2531
|
+
# @return [String]
|
2532
|
+
#
|
2533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommenderRequest AWS API Documentation
|
2534
|
+
#
|
2535
|
+
class DeleteRecommenderRequest < Struct.new(
|
2536
|
+
:recommender_arn)
|
2537
|
+
SENSITIVE = []
|
2538
|
+
include Aws::Structure
|
2539
|
+
end
|
2540
|
+
|
2145
2541
|
# @note When making an API call, you may pass DeleteSchemaRequest
|
2146
2542
|
# data as a hash:
|
2147
2543
|
#
|
@@ -2242,6 +2638,37 @@ module Aws::Personalize
|
|
2242
2638
|
include Aws::Structure
|
2243
2639
|
end
|
2244
2640
|
|
2641
|
+
# @note When making an API call, you may pass DescribeBatchSegmentJobRequest
|
2642
|
+
# data as a hash:
|
2643
|
+
#
|
2644
|
+
# {
|
2645
|
+
# batch_segment_job_arn: "Arn", # required
|
2646
|
+
# }
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] batch_segment_job_arn
|
2649
|
+
# The ARN of the batch segment job to describe.
|
2650
|
+
# @return [String]
|
2651
|
+
#
|
2652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobRequest AWS API Documentation
|
2653
|
+
#
|
2654
|
+
class DescribeBatchSegmentJobRequest < Struct.new(
|
2655
|
+
:batch_segment_job_arn)
|
2656
|
+
SENSITIVE = []
|
2657
|
+
include Aws::Structure
|
2658
|
+
end
|
2659
|
+
|
2660
|
+
# @!attribute [rw] batch_segment_job
|
2661
|
+
# Information on the specified batch segment job.
|
2662
|
+
# @return [Types::BatchSegmentJob]
|
2663
|
+
#
|
2664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobResponse AWS API Documentation
|
2665
|
+
#
|
2666
|
+
class DescribeBatchSegmentJobResponse < Struct.new(
|
2667
|
+
:batch_segment_job)
|
2668
|
+
SENSITIVE = []
|
2669
|
+
include Aws::Structure
|
2670
|
+
end
|
2671
|
+
|
2245
2672
|
# @note When making an API call, you may pass DescribeCampaignRequest
|
2246
2673
|
# data as a hash:
|
2247
2674
|
#
|
@@ -2507,39 +2934,70 @@ module Aws::Personalize
|
|
2507
2934
|
#
|
2508
2935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterResponse AWS API Documentation
|
2509
2936
|
#
|
2510
|
-
class DescribeFilterResponse < Struct.new(
|
2511
|
-
:filter)
|
2937
|
+
class DescribeFilterResponse < Struct.new(
|
2938
|
+
:filter)
|
2939
|
+
SENSITIVE = []
|
2940
|
+
include Aws::Structure
|
2941
|
+
end
|
2942
|
+
|
2943
|
+
# @note When making an API call, you may pass DescribeRecipeRequest
|
2944
|
+
# data as a hash:
|
2945
|
+
#
|
2946
|
+
# {
|
2947
|
+
# recipe_arn: "Arn", # required
|
2948
|
+
# }
|
2949
|
+
#
|
2950
|
+
# @!attribute [rw] recipe_arn
|
2951
|
+
# The Amazon Resource Name (ARN) of the recipe to describe.
|
2952
|
+
# @return [String]
|
2953
|
+
#
|
2954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
|
2955
|
+
#
|
2956
|
+
class DescribeRecipeRequest < Struct.new(
|
2957
|
+
:recipe_arn)
|
2958
|
+
SENSITIVE = []
|
2959
|
+
include Aws::Structure
|
2960
|
+
end
|
2961
|
+
|
2962
|
+
# @!attribute [rw] recipe
|
2963
|
+
# An object that describes the recipe.
|
2964
|
+
# @return [Types::Recipe]
|
2965
|
+
#
|
2966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
|
2967
|
+
#
|
2968
|
+
class DescribeRecipeResponse < Struct.new(
|
2969
|
+
:recipe)
|
2512
2970
|
SENSITIVE = []
|
2513
2971
|
include Aws::Structure
|
2514
2972
|
end
|
2515
2973
|
|
2516
|
-
# @note When making an API call, you may pass
|
2974
|
+
# @note When making an API call, you may pass DescribeRecommenderRequest
|
2517
2975
|
# data as a hash:
|
2518
2976
|
#
|
2519
2977
|
# {
|
2520
|
-
#
|
2978
|
+
# recommender_arn: "Arn", # required
|
2521
2979
|
# }
|
2522
2980
|
#
|
2523
|
-
# @!attribute [rw]
|
2524
|
-
# The Amazon Resource Name (ARN) of the
|
2981
|
+
# @!attribute [rw] recommender_arn
|
2982
|
+
# The Amazon Resource Name (ARN) of the recommender to describe.
|
2525
2983
|
# @return [String]
|
2526
2984
|
#
|
2527
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/
|
2985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderRequest AWS API Documentation
|
2528
2986
|
#
|
2529
|
-
class
|
2530
|
-
:
|
2987
|
+
class DescribeRecommenderRequest < Struct.new(
|
2988
|
+
:recommender_arn)
|
2531
2989
|
SENSITIVE = []
|
2532
2990
|
include Aws::Structure
|
2533
2991
|
end
|
2534
2992
|
|
2535
|
-
# @!attribute [rw]
|
2536
|
-
#
|
2537
|
-
# @return [Types::
|
2993
|
+
# @!attribute [rw] recommender
|
2994
|
+
# The properties of the recommender.
|
2995
|
+
# @return [Types::Recommender]
|
2538
2996
|
#
|
2539
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/
|
2997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderResponse AWS API Documentation
|
2540
2998
|
#
|
2541
|
-
class
|
2542
|
-
:
|
2999
|
+
class DescribeRecommenderResponse < Struct.new(
|
3000
|
+
:recommender)
|
2543
3001
|
SENSITIVE = []
|
2544
3002
|
include Aws::Structure
|
2545
3003
|
end
|
@@ -3238,6 +3696,57 @@ module Aws::Personalize
|
|
3238
3696
|
include Aws::Structure
|
3239
3697
|
end
|
3240
3698
|
|
3699
|
+
# @note When making an API call, you may pass ListBatchSegmentJobsRequest
|
3700
|
+
# data as a hash:
|
3701
|
+
#
|
3702
|
+
# {
|
3703
|
+
# solution_version_arn: "Arn",
|
3704
|
+
# next_token: "NextToken",
|
3705
|
+
# max_results: 1,
|
3706
|
+
# }
|
3707
|
+
#
|
3708
|
+
# @!attribute [rw] solution_version_arn
|
3709
|
+
# The Amazon Resource Name (ARN) of the solution version that the
|
3710
|
+
# batch segment jobs used to generate batch segments.
|
3711
|
+
# @return [String]
|
3712
|
+
#
|
3713
|
+
# @!attribute [rw] next_token
|
3714
|
+
# The token to request the next page of results.
|
3715
|
+
# @return [String]
|
3716
|
+
#
|
3717
|
+
# @!attribute [rw] max_results
|
3718
|
+
# The maximum number of batch segment job results to return in each
|
3719
|
+
# page. The default value is 100.
|
3720
|
+
# @return [Integer]
|
3721
|
+
#
|
3722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobsRequest AWS API Documentation
|
3723
|
+
#
|
3724
|
+
class ListBatchSegmentJobsRequest < Struct.new(
|
3725
|
+
:solution_version_arn,
|
3726
|
+
:next_token,
|
3727
|
+
:max_results)
|
3728
|
+
SENSITIVE = []
|
3729
|
+
include Aws::Structure
|
3730
|
+
end
|
3731
|
+
|
3732
|
+
# @!attribute [rw] batch_segment_jobs
|
3733
|
+
# A list containing information on each job that is returned.
|
3734
|
+
# @return [Array<Types::BatchSegmentJobSummary>]
|
3735
|
+
#
|
3736
|
+
# @!attribute [rw] next_token
|
3737
|
+
# The token to use to retrieve the next page of results. The value is
|
3738
|
+
# `null` when there are no more results to return.
|
3739
|
+
# @return [String]
|
3740
|
+
#
|
3741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobsResponse AWS API Documentation
|
3742
|
+
#
|
3743
|
+
class ListBatchSegmentJobsResponse < Struct.new(
|
3744
|
+
:batch_segment_jobs,
|
3745
|
+
:next_token)
|
3746
|
+
SENSITIVE = []
|
3747
|
+
include Aws::Structure
|
3748
|
+
end
|
3749
|
+
|
3241
3750
|
# @note When making an API call, you may pass ListCampaignsRequest
|
3242
3751
|
# data as a hash:
|
3243
3752
|
#
|
@@ -3590,6 +4099,7 @@ module Aws::Personalize
|
|
3590
4099
|
# recipe_provider: "SERVICE", # accepts SERVICE
|
3591
4100
|
# next_token: "NextToken",
|
3592
4101
|
# max_results: 1,
|
4102
|
+
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
3593
4103
|
# }
|
3594
4104
|
#
|
3595
4105
|
# @!attribute [rw] recipe_provider
|
@@ -3605,12 +4115,20 @@ module Aws::Personalize
|
|
3605
4115
|
# The maximum number of recipes to return.
|
3606
4116
|
# @return [Integer]
|
3607
4117
|
#
|
4118
|
+
# @!attribute [rw] domain
|
4119
|
+
# Filters returned recipes by domain for a Domain dataset group. Only
|
4120
|
+
# recipes (Domain dataset group use cases) for this domain are
|
4121
|
+
# included in the response. If you don't specify a domain, only
|
4122
|
+
# non-domain recipes are returned.
|
4123
|
+
# @return [String]
|
4124
|
+
#
|
3608
4125
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesRequest AWS API Documentation
|
3609
4126
|
#
|
3610
4127
|
class ListRecipesRequest < Struct.new(
|
3611
4128
|
:recipe_provider,
|
3612
4129
|
:next_token,
|
3613
|
-
:max_results
|
4130
|
+
:max_results,
|
4131
|
+
:domain)
|
3614
4132
|
SENSITIVE = []
|
3615
4133
|
include Aws::Structure
|
3616
4134
|
end
|
@@ -3632,6 +4150,57 @@ module Aws::Personalize
|
|
3632
4150
|
include Aws::Structure
|
3633
4151
|
end
|
3634
4152
|
|
4153
|
+
# @note When making an API call, you may pass ListRecommendersRequest
|
4154
|
+
# data as a hash:
|
4155
|
+
#
|
4156
|
+
# {
|
4157
|
+
# dataset_group_arn: "Arn",
|
4158
|
+
# next_token: "NextToken",
|
4159
|
+
# max_results: 1,
|
4160
|
+
# }
|
4161
|
+
#
|
4162
|
+
# @!attribute [rw] dataset_group_arn
|
4163
|
+
# The Amazon Resource Name (ARN) of the Domain dataset group to list
|
4164
|
+
# the recommenders for. When a Domain dataset group is not specified,
|
4165
|
+
# all the recommenders associated with the account are listed.
|
4166
|
+
# @return [String]
|
4167
|
+
#
|
4168
|
+
# @!attribute [rw] next_token
|
4169
|
+
# A token returned from the previous call to `ListRecommenders` for
|
4170
|
+
# getting the next set of recommenders (if they exist).
|
4171
|
+
# @return [String]
|
4172
|
+
#
|
4173
|
+
# @!attribute [rw] max_results
|
4174
|
+
# The maximum number of recommenders to return.
|
4175
|
+
# @return [Integer]
|
4176
|
+
#
|
4177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersRequest AWS API Documentation
|
4178
|
+
#
|
4179
|
+
class ListRecommendersRequest < Struct.new(
|
4180
|
+
:dataset_group_arn,
|
4181
|
+
:next_token,
|
4182
|
+
:max_results)
|
4183
|
+
SENSITIVE = []
|
4184
|
+
include Aws::Structure
|
4185
|
+
end
|
4186
|
+
|
4187
|
+
# @!attribute [rw] recommenders
|
4188
|
+
# A list of the recommenders.
|
4189
|
+
# @return [Array<Types::RecommenderSummary>]
|
4190
|
+
#
|
4191
|
+
# @!attribute [rw] next_token
|
4192
|
+
# A token for getting the next set of recommenders (if they exist).
|
4193
|
+
# @return [String]
|
4194
|
+
#
|
4195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersResponse AWS API Documentation
|
4196
|
+
#
|
4197
|
+
class ListRecommendersResponse < Struct.new(
|
4198
|
+
:recommenders,
|
4199
|
+
:next_token)
|
4200
|
+
SENSITIVE = []
|
4201
|
+
include Aws::Structure
|
4202
|
+
end
|
4203
|
+
|
3635
4204
|
# @note When making an API call, you may pass ListSchemasRequest
|
3636
4205
|
# data as a hash:
|
3637
4206
|
#
|
@@ -3896,6 +4465,11 @@ module Aws::Personalize
|
|
3896
4465
|
# The date and time (in Unix time) that the recipe was last updated.
|
3897
4466
|
# @return [Time]
|
3898
4467
|
#
|
4468
|
+
# @!attribute [rw] domain
|
4469
|
+
# The domain of the recipe (if the recipe is a Domain dataset group
|
4470
|
+
# use case).
|
4471
|
+
# @return [String]
|
4472
|
+
#
|
3899
4473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecipeSummary AWS API Documentation
|
3900
4474
|
#
|
3901
4475
|
class RecipeSummary < Struct.new(
|
@@ -3903,11 +4477,218 @@ module Aws::Personalize
|
|
3903
4477
|
:recipe_arn,
|
3904
4478
|
:status,
|
3905
4479
|
:creation_date_time,
|
4480
|
+
:last_updated_date_time,
|
4481
|
+
:domain)
|
4482
|
+
SENSITIVE = []
|
4483
|
+
include Aws::Structure
|
4484
|
+
end
|
4485
|
+
|
4486
|
+
# Describes a recommendation generator for a Domain dataset group. You
|
4487
|
+
# create a recommender in a Domain dataset group for a specific domain
|
4488
|
+
# use case (domain recipe), and specify the recommender in a
|
4489
|
+
# [GetRecommendations][1] request.
|
4490
|
+
#
|
4491
|
+
#
|
4492
|
+
#
|
4493
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
4494
|
+
#
|
4495
|
+
# @!attribute [rw] recommender_arn
|
4496
|
+
# The Amazon Resource Name (ARN) of the recommender.
|
4497
|
+
# @return [String]
|
4498
|
+
#
|
4499
|
+
# @!attribute [rw] dataset_group_arn
|
4500
|
+
# The Amazon Resource Name (ARN) of the Domain dataset group that
|
4501
|
+
# contains the recommender.
|
4502
|
+
# @return [String]
|
4503
|
+
#
|
4504
|
+
# @!attribute [rw] name
|
4505
|
+
# The name of the recommender.
|
4506
|
+
# @return [String]
|
4507
|
+
#
|
4508
|
+
# @!attribute [rw] recipe_arn
|
4509
|
+
# The Amazon Resource Name (ARN) of the recipe (Domain dataset group
|
4510
|
+
# use case) that the recommender was created for.
|
4511
|
+
# @return [String]
|
4512
|
+
#
|
4513
|
+
# @!attribute [rw] recommender_config
|
4514
|
+
# The configuration details of the recommender.
|
4515
|
+
# @return [Types::RecommenderConfig]
|
4516
|
+
#
|
4517
|
+
# @!attribute [rw] creation_date_time
|
4518
|
+
# The date and time (in Unix format) that the recommender was created.
|
4519
|
+
# @return [Time]
|
4520
|
+
#
|
4521
|
+
# @!attribute [rw] last_updated_date_time
|
4522
|
+
# The date and time (in Unix format) that the recommender was last
|
4523
|
+
# updated.
|
4524
|
+
# @return [Time]
|
4525
|
+
#
|
4526
|
+
# @!attribute [rw] status
|
4527
|
+
# The status of the recommender.
|
4528
|
+
#
|
4529
|
+
# A recommender can be in one of the following states:
|
4530
|
+
#
|
4531
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
4532
|
+
# FAILED
|
4533
|
+
#
|
4534
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
4535
|
+
# @return [String]
|
4536
|
+
#
|
4537
|
+
# @!attribute [rw] failure_reason
|
4538
|
+
# If a recommender fails, the reason behind the failure.
|
4539
|
+
# @return [String]
|
4540
|
+
#
|
4541
|
+
# @!attribute [rw] latest_recommender_update
|
4542
|
+
# Provides a summary of the latest updates to the recommender.
|
4543
|
+
# @return [Types::RecommenderUpdateSummary]
|
4544
|
+
#
|
4545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Recommender AWS API Documentation
|
4546
|
+
#
|
4547
|
+
class Recommender < Struct.new(
|
4548
|
+
:recommender_arn,
|
4549
|
+
:dataset_group_arn,
|
4550
|
+
:name,
|
4551
|
+
:recipe_arn,
|
4552
|
+
:recommender_config,
|
4553
|
+
:creation_date_time,
|
4554
|
+
:last_updated_date_time,
|
4555
|
+
:status,
|
4556
|
+
:failure_reason,
|
4557
|
+
:latest_recommender_update)
|
4558
|
+
SENSITIVE = []
|
4559
|
+
include Aws::Structure
|
4560
|
+
end
|
4561
|
+
|
4562
|
+
# The configuration details of the recommender.
|
4563
|
+
#
|
4564
|
+
# @note When making an API call, you may pass RecommenderConfig
|
4565
|
+
# data as a hash:
|
4566
|
+
#
|
4567
|
+
# {
|
4568
|
+
# item_exploration_config: {
|
4569
|
+
# "ParameterName" => "ParameterValue",
|
4570
|
+
# },
|
4571
|
+
# }
|
4572
|
+
#
|
4573
|
+
# @!attribute [rw] item_exploration_config
|
4574
|
+
# Specifies the exploration configuration hyperparameters, including
|
4575
|
+
# `explorationWeight` and `explorationItemAgeCutOff`, you want to use
|
4576
|
+
# to configure the amount of item exploration Amazon Personalize uses
|
4577
|
+
# when recommending items. Provide `itemExplorationConfig` data only
|
4578
|
+
# if your recommenders generate personalized recommendations for a
|
4579
|
+
# user (not popular items or similar items).
|
4580
|
+
# @return [Hash<String,String>]
|
4581
|
+
#
|
4582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
|
4583
|
+
#
|
4584
|
+
class RecommenderConfig < Struct.new(
|
4585
|
+
:item_exploration_config)
|
4586
|
+
SENSITIVE = []
|
4587
|
+
include Aws::Structure
|
4588
|
+
end
|
4589
|
+
|
4590
|
+
# Provides a summary of the properties of the recommender.
|
4591
|
+
#
|
4592
|
+
# @!attribute [rw] name
|
4593
|
+
# The name of the recommender.
|
4594
|
+
# @return [String]
|
4595
|
+
#
|
4596
|
+
# @!attribute [rw] recommender_arn
|
4597
|
+
# The Amazon Resource Name (ARN) of the recommender.
|
4598
|
+
# @return [String]
|
4599
|
+
#
|
4600
|
+
# @!attribute [rw] dataset_group_arn
|
4601
|
+
# The Amazon Resource Name (ARN) of the Domain dataset group that
|
4602
|
+
# contains the recommender.
|
4603
|
+
# @return [String]
|
4604
|
+
#
|
4605
|
+
# @!attribute [rw] recipe_arn
|
4606
|
+
# The Amazon Resource Name (ARN) of the recipe (Domain dataset group
|
4607
|
+
# use case) that the recommender was created for.
|
4608
|
+
# @return [String]
|
4609
|
+
#
|
4610
|
+
# @!attribute [rw] recommender_config
|
4611
|
+
# The configuration details of the recommender.
|
4612
|
+
# @return [Types::RecommenderConfig]
|
4613
|
+
#
|
4614
|
+
# @!attribute [rw] status
|
4615
|
+
# The status of the recommender. A recommender can be in one of the
|
4616
|
+
# following states:
|
4617
|
+
#
|
4618
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
4619
|
+
# FAILED
|
4620
|
+
#
|
4621
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
4622
|
+
# @return [String]
|
4623
|
+
#
|
4624
|
+
# @!attribute [rw] creation_date_time
|
4625
|
+
# The date and time (in Unix format) that the recommender was created.
|
4626
|
+
# @return [Time]
|
4627
|
+
#
|
4628
|
+
# @!attribute [rw] last_updated_date_time
|
4629
|
+
# The date and time (in Unix format) that the recommender was last
|
4630
|
+
# updated.
|
4631
|
+
# @return [Time]
|
4632
|
+
#
|
4633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderSummary AWS API Documentation
|
4634
|
+
#
|
4635
|
+
class RecommenderSummary < Struct.new(
|
4636
|
+
:name,
|
4637
|
+
:recommender_arn,
|
4638
|
+
:dataset_group_arn,
|
4639
|
+
:recipe_arn,
|
4640
|
+
:recommender_config,
|
4641
|
+
:status,
|
4642
|
+
:creation_date_time,
|
3906
4643
|
:last_updated_date_time)
|
3907
4644
|
SENSITIVE = []
|
3908
4645
|
include Aws::Structure
|
3909
4646
|
end
|
3910
4647
|
|
4648
|
+
# Provides a summary of the properties of a recommender update. For a
|
4649
|
+
# complete listing, call the DescribeRecommender API.
|
4650
|
+
#
|
4651
|
+
# @!attribute [rw] recommender_config
|
4652
|
+
# The configuration details of the recommender update.
|
4653
|
+
# @return [Types::RecommenderConfig]
|
4654
|
+
#
|
4655
|
+
# @!attribute [rw] creation_date_time
|
4656
|
+
# The date and time (in Unix format) that the recommender update was
|
4657
|
+
# created.
|
4658
|
+
# @return [Time]
|
4659
|
+
#
|
4660
|
+
# @!attribute [rw] last_updated_date_time
|
4661
|
+
# The date and time (in Unix time) that the recommender update was
|
4662
|
+
# last updated.
|
4663
|
+
# @return [Time]
|
4664
|
+
#
|
4665
|
+
# @!attribute [rw] status
|
4666
|
+
# The status of the recommender update.
|
4667
|
+
#
|
4668
|
+
# A recommender can be in one of the following states:
|
4669
|
+
#
|
4670
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
4671
|
+
# FAILED
|
4672
|
+
#
|
4673
|
+
# * DELETE PENDING > DELETE IN\_PROGRESS
|
4674
|
+
# @return [String]
|
4675
|
+
#
|
4676
|
+
# @!attribute [rw] failure_reason
|
4677
|
+
# If a recommender update fails, the reason behind the failure.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderUpdateSummary AWS API Documentation
|
4681
|
+
#
|
4682
|
+
class RecommenderUpdateSummary < Struct.new(
|
4683
|
+
:recommender_config,
|
4684
|
+
:creation_date_time,
|
4685
|
+
:last_updated_date_time,
|
4686
|
+
:status,
|
4687
|
+
:failure_reason)
|
4688
|
+
SENSITIVE = []
|
4689
|
+
include Aws::Structure
|
4690
|
+
end
|
4691
|
+
|
3911
4692
|
# The specified resource already exists.
|
3912
4693
|
#
|
3913
4694
|
# @!attribute [rw] message
|
@@ -4211,7 +4992,7 @@ module Aws::Personalize
|
|
4211
4992
|
end
|
4212
4993
|
|
4213
4994
|
# An object that provides information about a specific version of a
|
4214
|
-
# Solution.
|
4995
|
+
# Solution in a Custom dataset group.
|
4215
4996
|
#
|
4216
4997
|
# @!attribute [rw] solution_version_arn
|
4217
4998
|
# The ARN of the solution version.
|
@@ -4467,5 +5248,47 @@ module Aws::Personalize
|
|
4467
5248
|
include Aws::Structure
|
4468
5249
|
end
|
4469
5250
|
|
5251
|
+
# @note When making an API call, you may pass UpdateRecommenderRequest
|
5252
|
+
# data as a hash:
|
5253
|
+
#
|
5254
|
+
# {
|
5255
|
+
# recommender_arn: "Arn", # required
|
5256
|
+
# recommender_config: { # required
|
5257
|
+
# item_exploration_config: {
|
5258
|
+
# "ParameterName" => "ParameterValue",
|
5259
|
+
# },
|
5260
|
+
# },
|
5261
|
+
# }
|
5262
|
+
#
|
5263
|
+
# @!attribute [rw] recommender_arn
|
5264
|
+
# The Amazon Resource Name (ARN) of the recommender to modify.
|
5265
|
+
# @return [String]
|
5266
|
+
#
|
5267
|
+
# @!attribute [rw] recommender_config
|
5268
|
+
# The configuration details of the recommender.
|
5269
|
+
# @return [Types::RecommenderConfig]
|
5270
|
+
#
|
5271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderRequest AWS API Documentation
|
5272
|
+
#
|
5273
|
+
class UpdateRecommenderRequest < Struct.new(
|
5274
|
+
:recommender_arn,
|
5275
|
+
:recommender_config)
|
5276
|
+
SENSITIVE = []
|
5277
|
+
include Aws::Structure
|
5278
|
+
end
|
5279
|
+
|
5280
|
+
# @!attribute [rw] recommender_arn
|
5281
|
+
# The same recommender Amazon Resource Name (ARN) as given in the
|
5282
|
+
# request.
|
5283
|
+
# @return [String]
|
5284
|
+
#
|
5285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderResponse AWS API Documentation
|
5286
|
+
#
|
5287
|
+
class UpdateRecommenderResponse < Struct.new(
|
5288
|
+
:recommender_arn)
|
5289
|
+
SENSITIVE = []
|
5290
|
+
include Aws::Structure
|
5291
|
+
end
|
5292
|
+
|
4470
5293
|
end
|
4471
5294
|
end
|