aws-sdk-personalize 1.33.0 → 1.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -365,8 +365,195 @@ module Aws::Personalize
365
365
  include Aws::Structure
366
366
  end
367
367
 
368
- # Describes a deployed solution version, otherwise known as a campaign.
369
- # For more information on campaigns, see CreateCampaign.
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
- # A string to string map specifying the exploration configuration
452
- # hyperparameters, including `explorationWeight` and
453
- # `explorationItemAgeCutOff`, you want to use to configure the amount
454
- # of item exploration Amazon Personalize uses when recommending items.
455
- # Provide `itemExplorationConfig` data only if your solution uses the
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,76 @@ 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
+ # min_recommendation_requests_per_second: 1,
1400
+ # },
1401
+ # }
1402
+ #
1403
+ # @!attribute [rw] name
1404
+ # The name of the recommender.
1405
+ # @return [String]
1406
+ #
1407
+ # @!attribute [rw] dataset_group_arn
1408
+ # The Amazon Resource Name (ARN) of the destination domain dataset
1409
+ # group for the recommender.
1410
+ # @return [String]
1411
+ #
1412
+ # @!attribute [rw] recipe_arn
1413
+ # The Amazon Resource Name (ARN) of the recipe that the recommender
1414
+ # will use. For a recommender, a recipe is a Domain dataset group use
1415
+ # case. Only Domain dataset group use cases can be used to create a
1416
+ # recommender. For information about use cases see [Choosing
1417
+ # recommender use cases][1].
1418
+ #
1419
+ #
1420
+ #
1421
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
1422
+ # @return [String]
1423
+ #
1424
+ # @!attribute [rw] recommender_config
1425
+ # The configuration details of the recommender.
1426
+ # @return [Types::RecommenderConfig]
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderRequest AWS API Documentation
1429
+ #
1430
+ class CreateRecommenderRequest < Struct.new(
1431
+ :name,
1432
+ :dataset_group_arn,
1433
+ :recipe_arn,
1434
+ :recommender_config)
1435
+ SENSITIVE = []
1436
+ include Aws::Structure
1437
+ end
1438
+
1439
+ # @!attribute [rw] recommender_arn
1440
+ # The Amazon Resource Name (ARN) of the recommender.
1441
+ # @return [String]
1442
+ #
1443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderResponse AWS API Documentation
1444
+ #
1445
+ class CreateRecommenderResponse < Struct.new(
1446
+ :recommender_arn)
1447
+ SENSITIVE = []
1448
+ include Aws::Structure
1449
+ end
1450
+
1103
1451
  # @note When making an API call, you may pass CreateSchemaRequest
1104
1452
  # data as a hash:
1105
1453
  #
1106
1454
  # {
1107
1455
  # name: "Name", # required
1108
1456
  # schema: "AvroSchema", # required
1457
+ # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
1109
1458
  # }
1110
1459
  #
1111
1460
  # @!attribute [rw] name
@@ -1116,11 +1465,18 @@ module Aws::Personalize
1116
1465
  # A schema in Avro JSON format.
1117
1466
  # @return [String]
1118
1467
  #
1468
+ # @!attribute [rw] domain
1469
+ # The domain for the schema. If you are creating a schema for a
1470
+ # dataset in a Domain dataset group, specify the domain you chose when
1471
+ # you created the Domain dataset group.
1472
+ # @return [String]
1473
+ #
1119
1474
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchemaRequest AWS API Documentation
1120
1475
  #
1121
1476
  class CreateSchemaRequest < Struct.new(
1122
1477
  :name,
1123
- :schema)
1478
+ :schema,
1479
+ :domain)
1124
1480
  SENSITIVE = []
1125
1481
  include Aws::Structure
1126
1482
  end
@@ -1628,6 +1984,10 @@ module Aws::Personalize
1628
1984
  # If creating a dataset group fails, provides the reason why.
1629
1985
  # @return [String]
1630
1986
  #
1987
+ # @!attribute [rw] domain
1988
+ # The domain of a Domain dataset group.
1989
+ # @return [String]
1990
+ #
1631
1991
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroup AWS API Documentation
1632
1992
  #
1633
1993
  class DatasetGroup < Struct.new(
@@ -1638,7 +1998,8 @@ module Aws::Personalize
1638
1998
  :kms_key_arn,
1639
1999
  :creation_date_time,
1640
2000
  :last_updated_date_time,
1641
- :failure_reason)
2001
+ :failure_reason,
2002
+ :domain)
1642
2003
  SENSITIVE = []
1643
2004
  include Aws::Structure
1644
2005
  end
@@ -1678,6 +2039,10 @@ module Aws::Personalize
1678
2039
  # If creating a dataset group fails, the reason behind the failure.
1679
2040
  # @return [String]
1680
2041
  #
2042
+ # @!attribute [rw] domain
2043
+ # The domain of a Domain dataset group.
2044
+ # @return [String]
2045
+ #
1681
2046
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroupSummary AWS API Documentation
1682
2047
  #
1683
2048
  class DatasetGroupSummary < Struct.new(
@@ -1686,7 +2051,8 @@ module Aws::Personalize
1686
2051
  :status,
1687
2052
  :creation_date_time,
1688
2053
  :last_updated_date_time,
1689
- :failure_reason)
2054
+ :failure_reason,
2055
+ :domain)
1690
2056
  SENSITIVE = []
1691
2057
  include Aws::Structure
1692
2058
  end
@@ -1835,6 +2201,11 @@ module Aws::Personalize
1835
2201
  # The date and time (in Unix time) that the schema was last updated.
1836
2202
  # @return [Time]
1837
2203
  #
2204
+ # @!attribute [rw] domain
2205
+ # The domain of a schema that you created for a dataset in a Domain
2206
+ # dataset group.
2207
+ # @return [String]
2208
+ #
1838
2209
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchema AWS API Documentation
1839
2210
  #
1840
2211
  class DatasetSchema < Struct.new(
@@ -1842,7 +2213,8 @@ module Aws::Personalize
1842
2213
  :schema_arn,
1843
2214
  :schema,
1844
2215
  :creation_date_time,
1845
- :last_updated_date_time)
2216
+ :last_updated_date_time,
2217
+ :domain)
1846
2218
  SENSITIVE = []
1847
2219
  include Aws::Structure
1848
2220
  end
@@ -1866,13 +2238,19 @@ module Aws::Personalize
1866
2238
  # The date and time (in Unix time) that the schema was last updated.
1867
2239
  # @return [Time]
1868
2240
  #
2241
+ # @!attribute [rw] domain
2242
+ # The domain of a schema that you created for a dataset in a Domain
2243
+ # dataset group.
2244
+ # @return [String]
2245
+ #
1869
2246
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchemaSummary AWS API Documentation
1870
2247
  #
1871
2248
  class DatasetSchemaSummary < Struct.new(
1872
2249
  :name,
1873
2250
  :schema_arn,
1874
2251
  :creation_date_time,
1875
- :last_updated_date_time)
2252
+ :last_updated_date_time,
2253
+ :domain)
1876
2254
  SENSITIVE = []
1877
2255
  include Aws::Structure
1878
2256
  end
@@ -2142,6 +2520,25 @@ module Aws::Personalize
2142
2520
  include Aws::Structure
2143
2521
  end
2144
2522
 
2523
+ # @note When making an API call, you may pass DeleteRecommenderRequest
2524
+ # data as a hash:
2525
+ #
2526
+ # {
2527
+ # recommender_arn: "Arn", # required
2528
+ # }
2529
+ #
2530
+ # @!attribute [rw] recommender_arn
2531
+ # The Amazon Resource Name (ARN) of the recommender to delete.
2532
+ # @return [String]
2533
+ #
2534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommenderRequest AWS API Documentation
2535
+ #
2536
+ class DeleteRecommenderRequest < Struct.new(
2537
+ :recommender_arn)
2538
+ SENSITIVE = []
2539
+ include Aws::Structure
2540
+ end
2541
+
2145
2542
  # @note When making an API call, you may pass DeleteSchemaRequest
2146
2543
  # data as a hash:
2147
2544
  #
@@ -2242,6 +2639,37 @@ module Aws::Personalize
2242
2639
  include Aws::Structure
2243
2640
  end
2244
2641
 
2642
+ # @note When making an API call, you may pass DescribeBatchSegmentJobRequest
2643
+ # data as a hash:
2644
+ #
2645
+ # {
2646
+ # batch_segment_job_arn: "Arn", # required
2647
+ # }
2648
+ #
2649
+ # @!attribute [rw] batch_segment_job_arn
2650
+ # The ARN of the batch segment job to describe.
2651
+ # @return [String]
2652
+ #
2653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobRequest AWS API Documentation
2654
+ #
2655
+ class DescribeBatchSegmentJobRequest < Struct.new(
2656
+ :batch_segment_job_arn)
2657
+ SENSITIVE = []
2658
+ include Aws::Structure
2659
+ end
2660
+
2661
+ # @!attribute [rw] batch_segment_job
2662
+ # Information on the specified batch segment job.
2663
+ # @return [Types::BatchSegmentJob]
2664
+ #
2665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobResponse AWS API Documentation
2666
+ #
2667
+ class DescribeBatchSegmentJobResponse < Struct.new(
2668
+ :batch_segment_job)
2669
+ SENSITIVE = []
2670
+ include Aws::Structure
2671
+ end
2672
+
2245
2673
  # @note When making an API call, you may pass DescribeCampaignRequest
2246
2674
  # data as a hash:
2247
2675
  #
@@ -2513,33 +2941,64 @@ module Aws::Personalize
2513
2941
  include Aws::Structure
2514
2942
  end
2515
2943
 
2516
- # @note When making an API call, you may pass DescribeRecipeRequest
2944
+ # @note When making an API call, you may pass DescribeRecipeRequest
2945
+ # data as a hash:
2946
+ #
2947
+ # {
2948
+ # recipe_arn: "Arn", # required
2949
+ # }
2950
+ #
2951
+ # @!attribute [rw] recipe_arn
2952
+ # The Amazon Resource Name (ARN) of the recipe to describe.
2953
+ # @return [String]
2954
+ #
2955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
2956
+ #
2957
+ class DescribeRecipeRequest < Struct.new(
2958
+ :recipe_arn)
2959
+ SENSITIVE = []
2960
+ include Aws::Structure
2961
+ end
2962
+
2963
+ # @!attribute [rw] recipe
2964
+ # An object that describes the recipe.
2965
+ # @return [Types::Recipe]
2966
+ #
2967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
2968
+ #
2969
+ class DescribeRecipeResponse < Struct.new(
2970
+ :recipe)
2971
+ SENSITIVE = []
2972
+ include Aws::Structure
2973
+ end
2974
+
2975
+ # @note When making an API call, you may pass DescribeRecommenderRequest
2517
2976
  # data as a hash:
2518
2977
  #
2519
2978
  # {
2520
- # recipe_arn: "Arn", # required
2979
+ # recommender_arn: "Arn", # required
2521
2980
  # }
2522
2981
  #
2523
- # @!attribute [rw] recipe_arn
2524
- # The Amazon Resource Name (ARN) of the recipe to describe.
2982
+ # @!attribute [rw] recommender_arn
2983
+ # The Amazon Resource Name (ARN) of the recommender to describe.
2525
2984
  # @return [String]
2526
2985
  #
2527
- # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
2986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderRequest AWS API Documentation
2528
2987
  #
2529
- class DescribeRecipeRequest < Struct.new(
2530
- :recipe_arn)
2988
+ class DescribeRecommenderRequest < Struct.new(
2989
+ :recommender_arn)
2531
2990
  SENSITIVE = []
2532
2991
  include Aws::Structure
2533
2992
  end
2534
2993
 
2535
- # @!attribute [rw] recipe
2536
- # An object that describes the recipe.
2537
- # @return [Types::Recipe]
2994
+ # @!attribute [rw] recommender
2995
+ # The properties of the recommender.
2996
+ # @return [Types::Recommender]
2538
2997
  #
2539
- # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
2998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderResponse AWS API Documentation
2540
2999
  #
2541
- class DescribeRecipeResponse < Struct.new(
2542
- :recipe)
3000
+ class DescribeRecommenderResponse < Struct.new(
3001
+ :recommender)
2543
3002
  SENSITIVE = []
2544
3003
  include Aws::Structure
2545
3004
  end
@@ -3238,6 +3697,57 @@ module Aws::Personalize
3238
3697
  include Aws::Structure
3239
3698
  end
3240
3699
 
3700
+ # @note When making an API call, you may pass ListBatchSegmentJobsRequest
3701
+ # data as a hash:
3702
+ #
3703
+ # {
3704
+ # solution_version_arn: "Arn",
3705
+ # next_token: "NextToken",
3706
+ # max_results: 1,
3707
+ # }
3708
+ #
3709
+ # @!attribute [rw] solution_version_arn
3710
+ # The Amazon Resource Name (ARN) of the solution version that the
3711
+ # batch segment jobs used to generate batch segments.
3712
+ # @return [String]
3713
+ #
3714
+ # @!attribute [rw] next_token
3715
+ # The token to request the next page of results.
3716
+ # @return [String]
3717
+ #
3718
+ # @!attribute [rw] max_results
3719
+ # The maximum number of batch segment job results to return in each
3720
+ # page. The default value is 100.
3721
+ # @return [Integer]
3722
+ #
3723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobsRequest AWS API Documentation
3724
+ #
3725
+ class ListBatchSegmentJobsRequest < Struct.new(
3726
+ :solution_version_arn,
3727
+ :next_token,
3728
+ :max_results)
3729
+ SENSITIVE = []
3730
+ include Aws::Structure
3731
+ end
3732
+
3733
+ # @!attribute [rw] batch_segment_jobs
3734
+ # A list containing information on each job that is returned.
3735
+ # @return [Array<Types::BatchSegmentJobSummary>]
3736
+ #
3737
+ # @!attribute [rw] next_token
3738
+ # The token to use to retrieve the next page of results. The value is
3739
+ # `null` when there are no more results to return.
3740
+ # @return [String]
3741
+ #
3742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobsResponse AWS API Documentation
3743
+ #
3744
+ class ListBatchSegmentJobsResponse < Struct.new(
3745
+ :batch_segment_jobs,
3746
+ :next_token)
3747
+ SENSITIVE = []
3748
+ include Aws::Structure
3749
+ end
3750
+
3241
3751
  # @note When making an API call, you may pass ListCampaignsRequest
3242
3752
  # data as a hash:
3243
3753
  #
@@ -3590,6 +4100,7 @@ module Aws::Personalize
3590
4100
  # recipe_provider: "SERVICE", # accepts SERVICE
3591
4101
  # next_token: "NextToken",
3592
4102
  # max_results: 1,
4103
+ # domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
3593
4104
  # }
3594
4105
  #
3595
4106
  # @!attribute [rw] recipe_provider
@@ -3605,12 +4116,20 @@ module Aws::Personalize
3605
4116
  # The maximum number of recipes to return.
3606
4117
  # @return [Integer]
3607
4118
  #
4119
+ # @!attribute [rw] domain
4120
+ # Filters returned recipes by domain for a Domain dataset group. Only
4121
+ # recipes (Domain dataset group use cases) for this domain are
4122
+ # included in the response. If you don't specify a domain, only
4123
+ # non-domain recipes are returned.
4124
+ # @return [String]
4125
+ #
3608
4126
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesRequest AWS API Documentation
3609
4127
  #
3610
4128
  class ListRecipesRequest < Struct.new(
3611
4129
  :recipe_provider,
3612
4130
  :next_token,
3613
- :max_results)
4131
+ :max_results,
4132
+ :domain)
3614
4133
  SENSITIVE = []
3615
4134
  include Aws::Structure
3616
4135
  end
@@ -3632,6 +4151,57 @@ module Aws::Personalize
3632
4151
  include Aws::Structure
3633
4152
  end
3634
4153
 
4154
+ # @note When making an API call, you may pass ListRecommendersRequest
4155
+ # data as a hash:
4156
+ #
4157
+ # {
4158
+ # dataset_group_arn: "Arn",
4159
+ # next_token: "NextToken",
4160
+ # max_results: 1,
4161
+ # }
4162
+ #
4163
+ # @!attribute [rw] dataset_group_arn
4164
+ # The Amazon Resource Name (ARN) of the Domain dataset group to list
4165
+ # the recommenders for. When a Domain dataset group is not specified,
4166
+ # all the recommenders associated with the account are listed.
4167
+ # @return [String]
4168
+ #
4169
+ # @!attribute [rw] next_token
4170
+ # A token returned from the previous call to `ListRecommenders` for
4171
+ # getting the next set of recommenders (if they exist).
4172
+ # @return [String]
4173
+ #
4174
+ # @!attribute [rw] max_results
4175
+ # The maximum number of recommenders to return.
4176
+ # @return [Integer]
4177
+ #
4178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersRequest AWS API Documentation
4179
+ #
4180
+ class ListRecommendersRequest < Struct.new(
4181
+ :dataset_group_arn,
4182
+ :next_token,
4183
+ :max_results)
4184
+ SENSITIVE = []
4185
+ include Aws::Structure
4186
+ end
4187
+
4188
+ # @!attribute [rw] recommenders
4189
+ # A list of the recommenders.
4190
+ # @return [Array<Types::RecommenderSummary>]
4191
+ #
4192
+ # @!attribute [rw] next_token
4193
+ # A token for getting the next set of recommenders (if they exist).
4194
+ # @return [String]
4195
+ #
4196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersResponse AWS API Documentation
4197
+ #
4198
+ class ListRecommendersResponse < Struct.new(
4199
+ :recommenders,
4200
+ :next_token)
4201
+ SENSITIVE = []
4202
+ include Aws::Structure
4203
+ end
4204
+
3635
4205
  # @note When making an API call, you may pass ListSchemasRequest
3636
4206
  # data as a hash:
3637
4207
  #
@@ -3896,6 +4466,11 @@ module Aws::Personalize
3896
4466
  # The date and time (in Unix time) that the recipe was last updated.
3897
4467
  # @return [Time]
3898
4468
  #
4469
+ # @!attribute [rw] domain
4470
+ # The domain of the recipe (if the recipe is a Domain dataset group
4471
+ # use case).
4472
+ # @return [String]
4473
+ #
3899
4474
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecipeSummary AWS API Documentation
3900
4475
  #
3901
4476
  class RecipeSummary < Struct.new(
@@ -3903,11 +4478,225 @@ module Aws::Personalize
3903
4478
  :recipe_arn,
3904
4479
  :status,
3905
4480
  :creation_date_time,
4481
+ :last_updated_date_time,
4482
+ :domain)
4483
+ SENSITIVE = []
4484
+ include Aws::Structure
4485
+ end
4486
+
4487
+ # Describes a recommendation generator for a Domain dataset group. You
4488
+ # create a recommender in a Domain dataset group for a specific domain
4489
+ # use case (domain recipe), and specify the recommender in a
4490
+ # [GetRecommendations][1] request.
4491
+ #
4492
+ #
4493
+ #
4494
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
4495
+ #
4496
+ # @!attribute [rw] recommender_arn
4497
+ # The Amazon Resource Name (ARN) of the recommender.
4498
+ # @return [String]
4499
+ #
4500
+ # @!attribute [rw] dataset_group_arn
4501
+ # The Amazon Resource Name (ARN) of the Domain dataset group that
4502
+ # contains the recommender.
4503
+ # @return [String]
4504
+ #
4505
+ # @!attribute [rw] name
4506
+ # The name of the recommender.
4507
+ # @return [String]
4508
+ #
4509
+ # @!attribute [rw] recipe_arn
4510
+ # The Amazon Resource Name (ARN) of the recipe (Domain dataset group
4511
+ # use case) that the recommender was created for.
4512
+ # @return [String]
4513
+ #
4514
+ # @!attribute [rw] recommender_config
4515
+ # The configuration details of the recommender.
4516
+ # @return [Types::RecommenderConfig]
4517
+ #
4518
+ # @!attribute [rw] creation_date_time
4519
+ # The date and time (in Unix format) that the recommender was created.
4520
+ # @return [Time]
4521
+ #
4522
+ # @!attribute [rw] last_updated_date_time
4523
+ # The date and time (in Unix format) that the recommender was last
4524
+ # updated.
4525
+ # @return [Time]
4526
+ #
4527
+ # @!attribute [rw] status
4528
+ # The status of the recommender.
4529
+ #
4530
+ # A recommender can be in one of the following states:
4531
+ #
4532
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
4533
+ # FAILED
4534
+ #
4535
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
4536
+ # @return [String]
4537
+ #
4538
+ # @!attribute [rw] failure_reason
4539
+ # If a recommender fails, the reason behind the failure.
4540
+ # @return [String]
4541
+ #
4542
+ # @!attribute [rw] latest_recommender_update
4543
+ # Provides a summary of the latest updates to the recommender.
4544
+ # @return [Types::RecommenderUpdateSummary]
4545
+ #
4546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Recommender AWS API Documentation
4547
+ #
4548
+ class Recommender < Struct.new(
4549
+ :recommender_arn,
4550
+ :dataset_group_arn,
4551
+ :name,
4552
+ :recipe_arn,
4553
+ :recommender_config,
4554
+ :creation_date_time,
4555
+ :last_updated_date_time,
4556
+ :status,
4557
+ :failure_reason,
4558
+ :latest_recommender_update)
4559
+ SENSITIVE = []
4560
+ include Aws::Structure
4561
+ end
4562
+
4563
+ # The configuration details of the recommender.
4564
+ #
4565
+ # @note When making an API call, you may pass RecommenderConfig
4566
+ # data as a hash:
4567
+ #
4568
+ # {
4569
+ # item_exploration_config: {
4570
+ # "ParameterName" => "ParameterValue",
4571
+ # },
4572
+ # min_recommendation_requests_per_second: 1,
4573
+ # }
4574
+ #
4575
+ # @!attribute [rw] item_exploration_config
4576
+ # Specifies the exploration configuration hyperparameters, including
4577
+ # `explorationWeight` and `explorationItemAgeCutOff`, you want to use
4578
+ # to configure the amount of item exploration Amazon Personalize uses
4579
+ # when recommending items. Provide `itemExplorationConfig` data only
4580
+ # if your recommenders generate personalized recommendations for a
4581
+ # user (not popular items or similar items).
4582
+ # @return [Hash<String,String>]
4583
+ #
4584
+ # @!attribute [rw] min_recommendation_requests_per_second
4585
+ # Specifies the requested minimum provisioned recommendation requests
4586
+ # per second that Amazon Personalize will support.
4587
+ # @return [Integer]
4588
+ #
4589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
4590
+ #
4591
+ class RecommenderConfig < Struct.new(
4592
+ :item_exploration_config,
4593
+ :min_recommendation_requests_per_second)
4594
+ SENSITIVE = []
4595
+ include Aws::Structure
4596
+ end
4597
+
4598
+ # Provides a summary of the properties of the recommender.
4599
+ #
4600
+ # @!attribute [rw] name
4601
+ # The name of the recommender.
4602
+ # @return [String]
4603
+ #
4604
+ # @!attribute [rw] recommender_arn
4605
+ # The Amazon Resource Name (ARN) of the recommender.
4606
+ # @return [String]
4607
+ #
4608
+ # @!attribute [rw] dataset_group_arn
4609
+ # The Amazon Resource Name (ARN) of the Domain dataset group that
4610
+ # contains the recommender.
4611
+ # @return [String]
4612
+ #
4613
+ # @!attribute [rw] recipe_arn
4614
+ # The Amazon Resource Name (ARN) of the recipe (Domain dataset group
4615
+ # use case) that the recommender was created for.
4616
+ # @return [String]
4617
+ #
4618
+ # @!attribute [rw] recommender_config
4619
+ # The configuration details of the recommender.
4620
+ # @return [Types::RecommenderConfig]
4621
+ #
4622
+ # @!attribute [rw] status
4623
+ # The status of the recommender. A recommender can be in one of the
4624
+ # following states:
4625
+ #
4626
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
4627
+ # FAILED
4628
+ #
4629
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
4630
+ # @return [String]
4631
+ #
4632
+ # @!attribute [rw] creation_date_time
4633
+ # The date and time (in Unix format) that the recommender was created.
4634
+ # @return [Time]
4635
+ #
4636
+ # @!attribute [rw] last_updated_date_time
4637
+ # The date and time (in Unix format) that the recommender was last
4638
+ # updated.
4639
+ # @return [Time]
4640
+ #
4641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderSummary AWS API Documentation
4642
+ #
4643
+ class RecommenderSummary < Struct.new(
4644
+ :name,
4645
+ :recommender_arn,
4646
+ :dataset_group_arn,
4647
+ :recipe_arn,
4648
+ :recommender_config,
4649
+ :status,
4650
+ :creation_date_time,
3906
4651
  :last_updated_date_time)
3907
4652
  SENSITIVE = []
3908
4653
  include Aws::Structure
3909
4654
  end
3910
4655
 
4656
+ # Provides a summary of the properties of a recommender update. For a
4657
+ # complete listing, call the DescribeRecommender API operation.
4658
+ #
4659
+ # @!attribute [rw] recommender_config
4660
+ # The configuration details of the recommender update.
4661
+ # @return [Types::RecommenderConfig]
4662
+ #
4663
+ # @!attribute [rw] creation_date_time
4664
+ # The date and time (in Unix format) that the recommender update was
4665
+ # created.
4666
+ # @return [Time]
4667
+ #
4668
+ # @!attribute [rw] last_updated_date_time
4669
+ # The date and time (in Unix time) that the recommender update was
4670
+ # last updated.
4671
+ # @return [Time]
4672
+ #
4673
+ # @!attribute [rw] status
4674
+ # The status of the recommender update.
4675
+ #
4676
+ # A recommender can be in one of the following states:
4677
+ #
4678
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
4679
+ # FAILED
4680
+ #
4681
+ # * DELETE PENDING &gt; DELETE IN\_PROGRESS
4682
+ # @return [String]
4683
+ #
4684
+ # @!attribute [rw] failure_reason
4685
+ # If a recommender update fails, the reason behind the failure.
4686
+ # @return [String]
4687
+ #
4688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderUpdateSummary AWS API Documentation
4689
+ #
4690
+ class RecommenderUpdateSummary < Struct.new(
4691
+ :recommender_config,
4692
+ :creation_date_time,
4693
+ :last_updated_date_time,
4694
+ :status,
4695
+ :failure_reason)
4696
+ SENSITIVE = []
4697
+ include Aws::Structure
4698
+ end
4699
+
3911
4700
  # The specified resource already exists.
3912
4701
  #
3913
4702
  # @!attribute [rw] message
@@ -3964,7 +4753,7 @@ module Aws::Personalize
3964
4753
  # @!attribute [rw] kms_key_arn
3965
4754
  # The Amazon Resource Name (ARN) of the Key Management Service (KMS)
3966
4755
  # key that Amazon Personalize uses to encrypt or decrypt the input and
3967
- # output files of a batch inference job.
4756
+ # output files.
3968
4757
  # @return [String]
3969
4758
  #
3970
4759
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/S3DataConfig AWS API Documentation
@@ -4211,7 +5000,7 @@ module Aws::Personalize
4211
5000
  end
4212
5001
 
4213
5002
  # An object that provides information about a specific version of a
4214
- # Solution.
5003
+ # Solution in a Custom dataset group.
4215
5004
  #
4216
5005
  # @!attribute [rw] solution_version_arn
4217
5006
  # The ARN of the solution version.
@@ -4467,5 +5256,48 @@ module Aws::Personalize
4467
5256
  include Aws::Structure
4468
5257
  end
4469
5258
 
5259
+ # @note When making an API call, you may pass UpdateRecommenderRequest
5260
+ # data as a hash:
5261
+ #
5262
+ # {
5263
+ # recommender_arn: "Arn", # required
5264
+ # recommender_config: { # required
5265
+ # item_exploration_config: {
5266
+ # "ParameterName" => "ParameterValue",
5267
+ # },
5268
+ # min_recommendation_requests_per_second: 1,
5269
+ # },
5270
+ # }
5271
+ #
5272
+ # @!attribute [rw] recommender_arn
5273
+ # The Amazon Resource Name (ARN) of the recommender to modify.
5274
+ # @return [String]
5275
+ #
5276
+ # @!attribute [rw] recommender_config
5277
+ # The configuration details of the recommender.
5278
+ # @return [Types::RecommenderConfig]
5279
+ #
5280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderRequest AWS API Documentation
5281
+ #
5282
+ class UpdateRecommenderRequest < Struct.new(
5283
+ :recommender_arn,
5284
+ :recommender_config)
5285
+ SENSITIVE = []
5286
+ include Aws::Structure
5287
+ end
5288
+
5289
+ # @!attribute [rw] recommender_arn
5290
+ # The same recommender Amazon Resource Name (ARN) as given in the
5291
+ # request.
5292
+ # @return [String]
5293
+ #
5294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderResponse AWS API Documentation
5295
+ #
5296
+ class UpdateRecommenderResponse < Struct.new(
5297
+ :recommender_arn)
5298
+ SENSITIVE = []
5299
+ include Aws::Structure
5300
+ end
5301
+
4470
5302
  end
4471
5303
  end