aws-sdk-personalize 1.15.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ecc025b4a0f2116cff850a737c0fc51307caf9c5f5e5833368ceb9acd9efc885
4
- data.tar.gz: fc2ac4cbfab8ef462d634c6339a0a75a0d8b21fda7c0e9a059b92be350b9427d
3
+ metadata.gz: 8333cc2dfa8b08e53cb45d0af74c9118c86371c9a94e91d4db31148392025396
4
+ data.tar.gz: 4b055092fa7edf9652ae2141ba0adc91b2374b4647af288a62d9b03ac5bc6848
5
5
  SHA512:
6
- metadata.gz: 7e0f7de9da1bbe980a37264f9231774c9486c41c7032ade59a960835e36550f13582075073229d8856ac21e98dab255aa660ef8445d1a1633e10368e83c986fb
7
- data.tar.gz: c0d2217de11b749c9f6965f466a7edf53d02316508f35773041eb1af2379f71b5b788611b1e786084cf5bf0c02430a171cc2f73565739d04d413042e42a80f4c
6
+ metadata.gz: f445293c7374cbf3a7b76ebfa35eefed35b2855e58bfec982fe3864ee99a3cf4fb4b7ce61515f487b2803cde48f64ce8bc47ef799c441747655007d03f55378f
7
+ data.tar.gz: 7f1bb9a106c77285346532d9b9bff5809724d8c78686c2364d8e2a3d96b56365409693b1c979c1e7b2832a4cfa765b12ffa41c528f56ec207a990c51354e5268
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-personalize/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::Personalize
49
50
 
50
- GEM_VERSION = '1.15.0'
51
+ GEM_VERSION = '1.20.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::Personalize
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Personalize
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -354,6 +369,9 @@ module Aws::Personalize
354
369
  # permissions to read and write to your input and out Amazon S3 buckets
355
370
  # respectively.
356
371
  #
372
+ # @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
373
+ # The configuration details of a batch inference job.
374
+ #
357
375
  # @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
358
376
  #
359
377
  # * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
@@ -378,6 +396,11 @@ module Aws::Personalize
378
396
  # },
379
397
  # },
380
398
  # role_arn: "RoleArn", # required
399
+ # batch_inference_job_config: {
400
+ # item_exploration_config: {
401
+ # "ParameterName" => "ParameterValue",
402
+ # },
403
+ # },
381
404
  # })
382
405
  #
383
406
  # @example Response structure
@@ -404,11 +427,16 @@ module Aws::Personalize
404
427
  # throughput and unit of billing for Amazon Personalize. The minimum
405
428
  # provisioned TPS (`minProvisionedTPS`) specifies the baseline
406
429
  # throughput provisioned by Amazon Personalize, and thus, the minimum
407
- # billing charge. If your TPS increases beyond `minProvisionedTPS`,
408
- # Amazon Personalize auto-scales the provisioned capacity up and down,
409
- # but never below `minProvisionedTPS`, to maintain a 70% utilization.
410
- # There's a short time delay while the capacity is increased that might
411
- # cause loss of transactions. It's recommended to start with a low
430
+ # billing charge.
431
+ #
432
+ # If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize
433
+ # auto-scales the provisioned capacity up and down, but never below
434
+ # `minProvisionedTPS`. There's a short time delay while the capacity is
435
+ # increased that might cause loss of transactions.
436
+ #
437
+ # The actual TPS used is calculated as the average requests/second
438
+ # within a 5-minute window. You pay for maximum of either the minimum
439
+ # provisioned TPS or the actual TPS. We recommend starting with a low
412
440
  # `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
413
441
  # and then increase the `minProvisionedTPS` as necessary.
414
442
  #
@@ -454,6 +482,9 @@ module Aws::Personalize
454
482
  # Specifies the requested minimum provisioned transactions
455
483
  # (recommendations) per second that Amazon Personalize will support.
456
484
  #
485
+ # @option params [Types::CampaignConfig] :campaign_config
486
+ # The configuration details of a campaign.
487
+ #
457
488
  # @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
458
489
  #
459
490
  # * {Types::CreateCampaignResponse#campaign_arn #campaign_arn} => String
@@ -464,6 +495,11 @@ module Aws::Personalize
464
495
  # name: "Name", # required
465
496
  # solution_version_arn: "Arn", # required
466
497
  # min_provisioned_tps: 1, # required
498
+ # campaign_config: {
499
+ # item_exploration_config: {
500
+ # "ParameterName" => "ParameterValue",
501
+ # },
502
+ # },
467
503
  # })
468
504
  #
469
505
  # @example Response structure
@@ -652,9 +688,11 @@ module Aws::Personalize
652
688
  # Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
653
689
  # Personalize to import the training data, you must specify an AWS
654
690
  # Identity and Access Management (IAM) role that has permission to read
655
- # from the data source.
691
+ # from the data source, as Amazon Personalize makes a copy of your data
692
+ # and processes it in an internal AWS system.
656
693
  #
657
- # The dataset import job replaces any previous data in the dataset.
694
+ # The dataset import job replaces any existing data in the dataset that
695
+ # you imported in bulk.
658
696
  #
659
697
  # **Status**
660
698
  #
@@ -723,23 +761,20 @@ module Aws::Personalize
723
761
  req.send_request(options)
724
762
  end
725
763
 
726
- # Creates an event tracker that you use when sending event data to the
764
+ # Creates an event tracker that you use when adding event data to a
727
765
  # specified dataset group using the [PutEvents][1] API.
728
766
  #
729
- # When Amazon Personalize creates an event tracker, it also creates an
730
- # *event-interactions* dataset in the dataset group associated with the
731
- # event tracker. The event-interactions dataset stores the event data
732
- # from the `PutEvents` call. The contents of this dataset are not
733
- # available to the user.
734
- #
735
767
  # <note markdown="1"> Only one event tracker can be associated with a dataset group. You
736
768
  # will get an error if you call `CreateEventTracker` using the same
737
769
  # dataset group as an existing event tracker.
738
770
  #
739
771
  # </note>
740
772
  #
741
- # When you send event data you include your tracking ID. The tracking ID
742
- # identifies the customer and authorizes the customer to send the data.
773
+ # When you create an event tracker, the response includes a tracking ID,
774
+ # which you pass as a parameter when you use the [PutEvents][1]
775
+ # operation. Amazon Personalize then appends the event data to the
776
+ # Interactions dataset of the dataset group you specify in your event
777
+ # tracker.
743
778
  #
744
779
  # The event tracker can be in one of the following states:
745
780
  #
@@ -800,8 +835,7 @@ module Aws::Personalize
800
835
  req.send_request(options)
801
836
  end
802
837
 
803
- # Creates a recommendation filter. For more information, see Using
804
- # Filters with Amazon Personalize.
838
+ # Creates a recommendation filter. For more information, see filter.
805
839
  #
806
840
  # @option params [required, String] :name
807
841
  # The name of the filter to create.
@@ -810,16 +844,10 @@ module Aws::Personalize
810
844
  # The ARN of the dataset group that the filter will belong to.
811
845
  #
812
846
  # @option params [required, String] :filter_expression
813
- # The filter expression that designates the interaction types that the
814
- # filter will filter out. A filter expression must follow the following
815
- # format:
816
- #
817
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
818
- #
819
- # Where "EVENT\_TYPE" is the type of event to filter out. To filter
820
- # out all items with any interactions history, set `"*"` as the
821
- # EVENT\_TYPE. For more information, see Using Filters with Amazon
822
- # Personalize.
847
+ # The filter expression defines which items are included or excluded
848
+ # from recommendations. Filter expression must follow specific format
849
+ # rules. For information about filter expression structure and syntax,
850
+ # see filter-expressions.
823
851
  #
824
852
  # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
825
853
  #
@@ -910,6 +938,11 @@ module Aws::Personalize
910
938
  # `performAutoML` and Amazon Personalize will analyze your data and
911
939
  # select the optimum USER\_PERSONALIZATION recipe for you.
912
940
  #
941
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` for
942
+ # solution hyperparameter optimization at this time.
943
+ #
944
+ # </note>
945
+ #
913
946
  # **Status**
914
947
  #
915
948
  # A solution can be in one of the following states:
@@ -975,11 +1008,19 @@ module Aws::Personalize
975
1008
  # field), this parameter specifies which event type (for example,
976
1009
  # 'click' or 'like') is used for training the model.
977
1010
  #
1011
+ # If you do not provide an `eventType`, Amazon Personalize will use all
1012
+ # interactions for training with equal weight regardless of type.
1013
+ #
978
1014
  # @option params [Types::SolutionConfig] :solution_config
979
1015
  # The configuration to use with the solution. When `performAutoML` is
980
1016
  # set to true, Amazon Personalize only evaluates the `autoMLConfig`
981
1017
  # section of the solution configuration.
982
1018
  #
1019
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
1020
+ # this time.
1021
+ #
1022
+ # </note>
1023
+ #
983
1024
  # @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
984
1025
  #
985
1026
  # * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
@@ -1104,7 +1145,12 @@ module Aws::Personalize
1104
1145
  # The `UPDATE` option can only be used when you already have an active
1105
1146
  # solution version created from the input solution using the `FULL`
1106
1147
  # option and the input solution was trained with the
1107
- # native-recipe-hrnn-coldstart recipe.
1148
+ # [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
1149
+ #
1150
+ #
1151
+ #
1152
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
1153
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
1108
1154
  #
1109
1155
  # @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1110
1156
  #
@@ -1394,6 +1440,8 @@ module Aws::Personalize
1394
1440
  # resp.batch_inference_job.job_input.s3_data_source.kms_key_arn #=> String
1395
1441
  # resp.batch_inference_job.job_output.s3_data_destination.path #=> String
1396
1442
  # resp.batch_inference_job.job_output.s3_data_destination.kms_key_arn #=> String
1443
+ # resp.batch_inference_job.batch_inference_job_config.item_exploration_config #=> Hash
1444
+ # resp.batch_inference_job.batch_inference_job_config.item_exploration_config["ParameterName"] #=> String
1397
1445
  # resp.batch_inference_job.role_arn #=> String
1398
1446
  # resp.batch_inference_job.status #=> String
1399
1447
  # resp.batch_inference_job.creation_date_time #=> Time
@@ -1441,12 +1489,16 @@ module Aws::Personalize
1441
1489
  # resp.campaign.campaign_arn #=> String
1442
1490
  # resp.campaign.solution_version_arn #=> String
1443
1491
  # resp.campaign.min_provisioned_tps #=> Integer
1492
+ # resp.campaign.campaign_config.item_exploration_config #=> Hash
1493
+ # resp.campaign.campaign_config.item_exploration_config["ParameterName"] #=> String
1444
1494
  # resp.campaign.status #=> String
1445
1495
  # resp.campaign.failure_reason #=> String
1446
1496
  # resp.campaign.creation_date_time #=> Time
1447
1497
  # resp.campaign.last_updated_date_time #=> Time
1448
1498
  # resp.campaign.latest_campaign_update.solution_version_arn #=> String
1449
1499
  # resp.campaign.latest_campaign_update.min_provisioned_tps #=> Integer
1500
+ # resp.campaign.latest_campaign_update.campaign_config.item_exploration_config #=> Hash
1501
+ # resp.campaign.latest_campaign_update.campaign_config.item_exploration_config["ParameterName"] #=> String
1450
1502
  # resp.campaign.latest_campaign_update.status #=> String
1451
1503
  # resp.campaign.latest_campaign_update.failure_reason #=> String
1452
1504
  # resp.campaign.latest_campaign_update.creation_date_time #=> Time
@@ -2495,6 +2547,9 @@ module Aws::Personalize
2495
2547
  # Specifies the requested minimum provisioned transactions
2496
2548
  # (recommendations) per second that Amazon Personalize will support.
2497
2549
  #
2550
+ # @option params [Types::CampaignConfig] :campaign_config
2551
+ # The configuration details of a campaign.
2552
+ #
2498
2553
  # @return [Types::UpdateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2499
2554
  #
2500
2555
  # * {Types::UpdateCampaignResponse#campaign_arn #campaign_arn} => String
@@ -2505,6 +2560,11 @@ module Aws::Personalize
2505
2560
  # campaign_arn: "Arn", # required
2506
2561
  # solution_version_arn: "Arn",
2507
2562
  # min_provisioned_tps: 1,
2563
+ # campaign_config: {
2564
+ # item_exploration_config: {
2565
+ # "ParameterName" => "ParameterValue",
2566
+ # },
2567
+ # },
2508
2568
  # })
2509
2569
  #
2510
2570
  # @example Response structure
@@ -2533,7 +2593,7 @@ module Aws::Personalize
2533
2593
  params: params,
2534
2594
  config: config)
2535
2595
  context[:gem_name] = 'aws-sdk-personalize'
2536
- context[:gem_version] = '1.15.0'
2596
+ context[:gem_version] = '1.20.0'
2537
2597
  Seahorse::Client::Request.new(handlers, context)
2538
2598
  end
2539
2599
 
@@ -22,12 +22,14 @@ module Aws::Personalize
22
22
  AutoMLResult = Shapes::StructureShape.new(name: 'AutoMLResult')
23
23
  AvroSchema = Shapes::StringShape.new(name: 'AvroSchema')
24
24
  BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
25
+ BatchInferenceJobConfig = Shapes::StructureShape.new(name: 'BatchInferenceJobConfig')
25
26
  BatchInferenceJobInput = Shapes::StructureShape.new(name: 'BatchInferenceJobInput')
26
27
  BatchInferenceJobOutput = Shapes::StructureShape.new(name: 'BatchInferenceJobOutput')
27
28
  BatchInferenceJobSummary = Shapes::StructureShape.new(name: 'BatchInferenceJobSummary')
28
29
  BatchInferenceJobs = Shapes::ListShape.new(name: 'BatchInferenceJobs')
29
30
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
30
31
  Campaign = Shapes::StructureShape.new(name: 'Campaign')
32
+ CampaignConfig = Shapes::StructureShape.new(name: 'CampaignConfig')
31
33
  CampaignSummary = Shapes::StructureShape.new(name: 'CampaignSummary')
32
34
  CampaignUpdateSummary = Shapes::StructureShape.new(name: 'CampaignUpdateSummary')
33
35
  Campaigns = Shapes::ListShape.new(name: 'Campaigns')
@@ -244,12 +246,16 @@ module Aws::Personalize
244
246
  BatchInferenceJob.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
245
247
  BatchInferenceJob.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, location_name: "jobInput"))
246
248
  BatchInferenceJob.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, location_name: "jobOutput"))
249
+ BatchInferenceJob.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
247
250
  BatchInferenceJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
248
251
  BatchInferenceJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
249
252
  BatchInferenceJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
250
253
  BatchInferenceJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
251
254
  BatchInferenceJob.struct_class = Types::BatchInferenceJob
252
255
 
256
+ BatchInferenceJobConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
257
+ BatchInferenceJobConfig.struct_class = Types::BatchInferenceJobConfig
258
+
253
259
  BatchInferenceJobInput.add_member(:s3_data_source, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataSource"))
254
260
  BatchInferenceJobInput.struct_class = Types::BatchInferenceJobInput
255
261
 
@@ -271,6 +277,7 @@ module Aws::Personalize
271
277
  Campaign.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
272
278
  Campaign.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
273
279
  Campaign.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minProvisionedTPS"))
280
+ Campaign.add_member(:campaign_config, Shapes::ShapeRef.new(shape: CampaignConfig, location_name: "campaignConfig"))
274
281
  Campaign.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
275
282
  Campaign.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
276
283
  Campaign.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
@@ -278,6 +285,9 @@ module Aws::Personalize
278
285
  Campaign.add_member(:latest_campaign_update, Shapes::ShapeRef.new(shape: CampaignUpdateSummary, location_name: "latestCampaignUpdate"))
279
286
  Campaign.struct_class = Types::Campaign
280
287
 
288
+ CampaignConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
289
+ CampaignConfig.struct_class = Types::CampaignConfig
290
+
281
291
  CampaignSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
282
292
  CampaignSummary.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
283
293
  CampaignSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
@@ -288,6 +298,7 @@ module Aws::Personalize
288
298
 
289
299
  CampaignUpdateSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
290
300
  CampaignUpdateSummary.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minProvisionedTPS"))
301
+ CampaignUpdateSummary.add_member(:campaign_config, Shapes::ShapeRef.new(shape: CampaignConfig, location_name: "campaignConfig"))
291
302
  CampaignUpdateSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
292
303
  CampaignUpdateSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
293
304
  CampaignUpdateSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
@@ -318,6 +329,7 @@ module Aws::Personalize
318
329
  CreateBatchInferenceJobRequest.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, required: true, location_name: "jobInput"))
319
330
  CreateBatchInferenceJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, required: true, location_name: "jobOutput"))
320
331
  CreateBatchInferenceJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
332
+ CreateBatchInferenceJobRequest.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
321
333
  CreateBatchInferenceJobRequest.struct_class = Types::CreateBatchInferenceJobRequest
322
334
 
323
335
  CreateBatchInferenceJobResponse.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
@@ -326,6 +338,7 @@ module Aws::Personalize
326
338
  CreateCampaignRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
327
339
  CreateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
328
340
  CreateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, required: true, location_name: "minProvisionedTPS"))
341
+ CreateCampaignRequest.add_member(:campaign_config, Shapes::ShapeRef.new(shape: CampaignConfig, location_name: "campaignConfig"))
329
342
  CreateCampaignRequest.struct_class = Types::CreateCampaignRequest
330
343
 
331
344
  CreateCampaignResponse.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
@@ -903,6 +916,7 @@ module Aws::Personalize
903
916
  UpdateCampaignRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
904
917
  UpdateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
905
918
  UpdateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minProvisionedTPS"))
919
+ UpdateCampaignRequest.add_member(:campaign_config, Shapes::ShapeRef.new(shape: CampaignConfig, location_name: "campaignConfig"))
906
920
  UpdateCampaignRequest.struct_class = Types::UpdateCampaignRequest
907
921
 
908
922
  UpdateCampaignResponse.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
@@ -1047,6 +1061,7 @@ module Aws::Personalize
1047
1061
  o.output = Shapes::ShapeRef.new(shape: CreateSolutionVersionResponse)
1048
1062
  o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1049
1063
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1064
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
1050
1065
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1051
1066
  end)
1052
1067
 
@@ -1102,6 +1117,7 @@ module Aws::Personalize
1102
1117
  o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
1103
1118
  o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1104
1119
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1120
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1105
1121
  end)
1106
1122
 
1107
1123
  api.add_operation(:delete_schema, Seahorse::Model::Operation.new.tap do |o|
@@ -177,6 +177,11 @@ module Aws::Personalize
177
177
  # batch inference job.
178
178
  # @return [Types::BatchInferenceJobOutput]
179
179
  #
180
+ # @!attribute [rw] batch_inference_job_config
181
+ # A string to string map of the configuration details of a batch
182
+ # inference job.
183
+ # @return [Types::BatchInferenceJobConfig]
184
+ #
180
185
  # @!attribute [rw] role_arn
181
186
  # The ARN of the Amazon Identity and Access Management (IAM) role that
182
187
  # requested the batch inference job.
@@ -214,6 +219,7 @@ module Aws::Personalize
214
219
  :num_results,
215
220
  :job_input,
216
221
  :job_output,
222
+ :batch_inference_job_config,
217
223
  :role_arn,
218
224
  :status,
219
225
  :creation_date_time,
@@ -222,6 +228,33 @@ module Aws::Personalize
222
228
  include Aws::Structure
223
229
  end
224
230
 
231
+ # The configuration details of a batch inference job.
232
+ #
233
+ # @note When making an API call, you may pass BatchInferenceJobConfig
234
+ # data as a hash:
235
+ #
236
+ # {
237
+ # item_exploration_config: {
238
+ # "ParameterName" => "ParameterValue",
239
+ # },
240
+ # }
241
+ #
242
+ # @!attribute [rw] item_exploration_config
243
+ # A string to string map specifying the exploration configuration
244
+ # hyperparameters, including `explorationWeight` and
245
+ # `explorationItemAgeCutOff`, you want to use to configure the amount
246
+ # of item exploration Amazon Personalize uses when recommending items.
247
+ # See native-recipe-new-item-USER\_PERSONALIZATION.
248
+ # @return [Hash<String,String>]
249
+ #
250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
251
+ #
252
+ class BatchInferenceJobConfig < Struct.new(
253
+ :item_exploration_config)
254
+ SENSITIVE = []
255
+ include Aws::Structure
256
+ end
257
+
225
258
  # The input configuration of a batch inference job.
226
259
  #
227
260
  # @note When making an API call, you may pass BatchInferenceJobInput
@@ -349,6 +382,10 @@ module Aws::Personalize
349
382
  # (recommendations) per second.
350
383
  # @return [Integer]
351
384
  #
385
+ # @!attribute [rw] campaign_config
386
+ # The configuration details of a campaign.
387
+ # @return [Types::CampaignConfig]
388
+ #
352
389
  # @!attribute [rw] status
353
390
  # The status of the campaign.
354
391
  #
@@ -385,6 +422,7 @@ module Aws::Personalize
385
422
  :campaign_arn,
386
423
  :solution_version_arn,
387
424
  :min_provisioned_tps,
425
+ :campaign_config,
388
426
  :status,
389
427
  :failure_reason,
390
428
  :creation_date_time,
@@ -394,6 +432,38 @@ module Aws::Personalize
394
432
  include Aws::Structure
395
433
  end
396
434
 
435
+ # The configuration details of a campaign.
436
+ #
437
+ # @note When making an API call, you may pass CampaignConfig
438
+ # data as a hash:
439
+ #
440
+ # {
441
+ # item_exploration_config: {
442
+ # "ParameterName" => "ParameterValue",
443
+ # },
444
+ # }
445
+ #
446
+ # @!attribute [rw] item_exploration_config
447
+ # A string to string map specifying the exploration configuration
448
+ # hyperparameters, including `explorationWeight` and
449
+ # `explorationItemAgeCutOff`, you want to use to configure the amount
450
+ # of item exploration Amazon Personalize uses when recommending items.
451
+ # Provide `itemExplorationConfig` data only if your solution uses the
452
+ # [User-Personalization][1] recipe.
453
+ #
454
+ #
455
+ #
456
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
457
+ # @return [Hash<String,String>]
458
+ #
459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
460
+ #
461
+ class CampaignConfig < Struct.new(
462
+ :item_exploration_config)
463
+ SENSITIVE = []
464
+ include Aws::Structure
465
+ end
466
+
397
467
  # Provides a summary of the properties of a campaign. For a complete
398
468
  # listing, call the DescribeCampaign API.
399
469
  #
@@ -453,6 +523,10 @@ module Aws::Personalize
453
523
  # (recommendations) per second that Amazon Personalize will support.
454
524
  # @return [Integer]
455
525
  #
526
+ # @!attribute [rw] campaign_config
527
+ # The configuration details of a campaign.
528
+ # @return [Types::CampaignConfig]
529
+ #
456
530
  # @!attribute [rw] status
457
531
  # The status of the campaign update.
458
532
  #
@@ -483,6 +557,7 @@ module Aws::Personalize
483
557
  class CampaignUpdateSummary < Struct.new(
484
558
  :solution_version_arn,
485
559
  :min_provisioned_tps,
560
+ :campaign_config,
486
561
  :status,
487
562
  :failure_reason,
488
563
  :creation_date_time,
@@ -572,6 +647,11 @@ module Aws::Personalize
572
647
  # },
573
648
  # },
574
649
  # role_arn: "RoleArn", # required
650
+ # batch_inference_job_config: {
651
+ # item_exploration_config: {
652
+ # "ParameterName" => "ParameterValue",
653
+ # },
654
+ # },
575
655
  # }
576
656
  #
577
657
  # @!attribute [rw] job_name
@@ -609,6 +689,10 @@ module Aws::Personalize
609
689
  # buckets respectively.
610
690
  # @return [String]
611
691
  #
692
+ # @!attribute [rw] batch_inference_job_config
693
+ # The configuration details of a batch inference job.
694
+ # @return [Types::BatchInferenceJobConfig]
695
+ #
612
696
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
613
697
  #
614
698
  class CreateBatchInferenceJobRequest < Struct.new(
@@ -618,7 +702,8 @@ module Aws::Personalize
618
702
  :num_results,
619
703
  :job_input,
620
704
  :job_output,
621
- :role_arn)
705
+ :role_arn,
706
+ :batch_inference_job_config)
622
707
  SENSITIVE = []
623
708
  include Aws::Structure
624
709
  end
@@ -642,6 +727,11 @@ module Aws::Personalize
642
727
  # name: "Name", # required
643
728
  # solution_version_arn: "Arn", # required
644
729
  # min_provisioned_tps: 1, # required
730
+ # campaign_config: {
731
+ # item_exploration_config: {
732
+ # "ParameterName" => "ParameterValue",
733
+ # },
734
+ # },
645
735
  # }
646
736
  #
647
737
  # @!attribute [rw] name
@@ -658,12 +748,17 @@ module Aws::Personalize
658
748
  # (recommendations) per second that Amazon Personalize will support.
659
749
  # @return [Integer]
660
750
  #
751
+ # @!attribute [rw] campaign_config
752
+ # The configuration details of a campaign.
753
+ # @return [Types::CampaignConfig]
754
+ #
661
755
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaignRequest AWS API Documentation
662
756
  #
663
757
  class CreateCampaignRequest < Struct.new(
664
758
  :name,
665
759
  :solution_version_arn,
666
- :min_provisioned_tps)
760
+ :min_provisioned_tps,
761
+ :campaign_config)
667
762
  SENSITIVE = []
668
763
  include Aws::Structure
669
764
  end
@@ -902,16 +997,10 @@ module Aws::Personalize
902
997
  # @return [String]
903
998
  #
904
999
  # @!attribute [rw] filter_expression
905
- # The filter expression that designates the interaction types that the
906
- # filter will filter out. A filter expression must follow the
907
- # following format:
908
- #
909
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
910
- #
911
- # Where "EVENT\_TYPE" is the type of event to filter out. To filter
912
- # out all items with any interactions history, set `"*"` as the
913
- # EVENT\_TYPE. For more information, see Using Filters with Amazon
914
- # Personalize.
1000
+ # The filter expression defines which items are included or excluded
1001
+ # from recommendations. Filter expression must follow specific format
1002
+ # rules. For information about filter expression structure and syntax,
1003
+ # see filter-expressions.
915
1004
  # @return [String]
916
1005
  #
917
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
@@ -1069,12 +1158,20 @@ module Aws::Personalize
1069
1158
  # When your have multiple event types (using an `EVENT_TYPE` schema
1070
1159
  # field), this parameter specifies which event type (for example,
1071
1160
  # 'click' or 'like') is used for training the model.
1161
+ #
1162
+ # If you do not provide an `eventType`, Amazon Personalize will use
1163
+ # all interactions for training with equal weight regardless of type.
1072
1164
  # @return [String]
1073
1165
  #
1074
1166
  # @!attribute [rw] solution_config
1075
1167
  # The configuration to use with the solution. When `performAutoML` is
1076
1168
  # set to true, Amazon Personalize only evaluates the `autoMLConfig`
1077
1169
  # section of the solution configuration.
1170
+ #
1171
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
1172
+ # at this time.
1173
+ #
1174
+ # </note>
1078
1175
  # @return [Types::SolutionConfig]
1079
1176
  #
1080
1177
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
@@ -1128,7 +1225,12 @@ module Aws::Personalize
1128
1225
  # The `UPDATE` option can only be used when you already have an active
1129
1226
  # solution version created from the input solution using the `FULL`
1130
1227
  # option and the input solution was trained with the
1131
- # native-recipe-hrnn-coldstart recipe.
1228
+ # [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
1229
+ #
1230
+ #
1231
+ #
1232
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
1233
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
1132
1234
  # @return [String]
1133
1235
  #
1134
1236
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
@@ -2443,13 +2545,9 @@ module Aws::Personalize
2443
2545
  #
2444
2546
  # @!attribute [rw] filter_expression
2445
2547
  # Specifies the type of item interactions to filter out of
2446
- # recommendation results. The filter expression must follow the
2447
- # following format:
2448
- #
2449
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
2450
- #
2451
- # Where "EVENT\_TYPE" is the type of event to filter out. For more
2452
- # information, see Using Filters with Amazon Personalize.
2548
+ # recommendation results. The filter expression must follow specific
2549
+ # format rules. For information about filter expression structure and
2550
+ # syntax, see filter-expressions.
2453
2551
  # @return [String]
2454
2552
  #
2455
2553
  # @!attribute [rw] status
@@ -2552,9 +2650,7 @@ module Aws::Personalize
2552
2650
  include Aws::Structure
2553
2651
  end
2554
2652
 
2555
- # Describes the properties for hyperparameter optimization (HPO). For
2556
- # use with the bring-your-own-recipe feature. Do not use for Amazon
2557
- # Personalize native recipes.
2653
+ # Describes the properties for hyperparameter optimization (HPO).
2558
2654
  #
2559
2655
  # @note When making an API call, you may pass HPOConfig
2560
2656
  # data as a hash:
@@ -2595,6 +2691,11 @@ module Aws::Personalize
2595
2691
  #
2596
2692
  # @!attribute [rw] hpo_objective
2597
2693
  # The metric to optimize during HPO.
2694
+ #
2695
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
2696
+ # at this time.
2697
+ #
2698
+ # </note>
2598
2699
  # @return [Types::HPOObjective]
2599
2700
  #
2600
2701
  # @!attribute [rw] hpo_resource_config
@@ -2617,6 +2718,11 @@ module Aws::Personalize
2617
2718
 
2618
2719
  # The metric to optimize during hyperparameter optimization (HPO).
2619
2720
  #
2721
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
2722
+ # this time.
2723
+ #
2724
+ # </note>
2725
+ #
2620
2726
  # @note When making an API call, you may pass HPOObjective
2621
2727
  # data as a hash:
2622
2728
  #
@@ -3539,7 +3645,9 @@ module Aws::Personalize
3539
3645
  #
3540
3646
  # @!attribute [rw] event_type
3541
3647
  # The event type (for example, 'click' or 'like') that is used for
3542
- # training the model.
3648
+ # training the model. If no `eventType` is provided, Amazon
3649
+ # Personalize uses all interactions for training with equal weight
3650
+ # regardless of type.
3543
3651
  # @return [String]
3544
3652
  #
3545
3653
  # @!attribute [rw] solution_config
@@ -3769,17 +3877,23 @@ module Aws::Personalize
3769
3877
  # @return [Float]
3770
3878
  #
3771
3879
  # @!attribute [rw] training_mode
3772
- # The scope of training used to create the solution version. The
3773
- # `FULL` option trains the solution version based on the entirety of
3774
- # the input solution's training data, while the `UPDATE` option
3775
- # processes only the training data that has changed since the creation
3776
- # of the last solution version. Choose `UPDATE` when you want to start
3777
- # recommending items added to the dataset without retraining the
3778
- # model.
3880
+ # The scope of training to be performed when creating the solution
3881
+ # version. The `FULL` option trains the solution version based on the
3882
+ # entirety of the input solution's training data, while the `UPDATE`
3883
+ # option processes only the data that has changed in comparison to the
3884
+ # input solution. Choose `UPDATE` when you want to incrementally
3885
+ # update your solution version instead of creating an entirely new
3886
+ # one.
3887
+ #
3888
+ # The `UPDATE` option can only be used when you already have an active
3889
+ # solution version created from the input solution using the `FULL`
3890
+ # option and the input solution was trained with the
3891
+ # [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
3892
+ #
3893
+ #
3779
3894
  #
3780
- # The `UPDATE` option can only be used after you've created a
3781
- # solution version with the `FULL` option and the training solution
3782
- # uses the native-recipe-hrnn-coldstart.
3895
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
3896
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
3783
3897
  # @return [String]
3784
3898
  #
3785
3899
  # @!attribute [rw] tuned_hpo_params
@@ -3902,6 +4016,11 @@ module Aws::Personalize
3902
4016
  # campaign_arn: "Arn", # required
3903
4017
  # solution_version_arn: "Arn",
3904
4018
  # min_provisioned_tps: 1,
4019
+ # campaign_config: {
4020
+ # item_exploration_config: {
4021
+ # "ParameterName" => "ParameterValue",
4022
+ # },
4023
+ # },
3905
4024
  # }
3906
4025
  #
3907
4026
  # @!attribute [rw] campaign_arn
@@ -3917,12 +4036,17 @@ module Aws::Personalize
3917
4036
  # (recommendations) per second that Amazon Personalize will support.
3918
4037
  # @return [Integer]
3919
4038
  #
4039
+ # @!attribute [rw] campaign_config
4040
+ # The configuration details of a campaign.
4041
+ # @return [Types::CampaignConfig]
4042
+ #
3920
4043
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaignRequest AWS API Documentation
3921
4044
  #
3922
4045
  class UpdateCampaignRequest < Struct.new(
3923
4046
  :campaign_arn,
3924
4047
  :solution_version_arn,
3925
- :min_provisioned_tps)
4048
+ :min_provisioned_tps,
4049
+ :campaign_config)
3926
4050
  SENSITIVE = []
3927
4051
  include Aws::Structure
3928
4052
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalize
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.15.0
4
+ version: 1.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-23 00:00:00.000000000 Z
11
+ date: 2021-01-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.99.0
22
+ version: 3.109.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.99.0
32
+ version: 3.109.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement