aws-sdk-personalize 1.17.0 → 1.22.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: 3e8ee6c1c137a15c0920cd529d71ad5c383972e01b5d9eea5afd70fc0b3ea90d
4
- data.tar.gz: a98744b407214e71467fca725cdbd435f980e518940092661903a7d0197b6f98
3
+ metadata.gz: 57ca84f91ae09dcd33f95e24bc2bfaa4009361097dc0c55b18144433660b91e4
4
+ data.tar.gz: 348c41901d08afccb8f9efbbc776b1c465639432fcc2582b25be3287ec4d8dd3
5
5
  SHA512:
6
- metadata.gz: aa345121889b6381e23426b48ea811b2bf2805f094b074ea4850a6fa76e21a83b2e4280b67624749b8cf935922cde764718da637dbcf3b0e6932428b3b2e5899
7
- data.tar.gz: '08fc97553337d673c83d47bc1aaf13cd4822915ad6051763e93e3b9af4c95122bef2c92e806e190661b94cba8cbe56883279c2b3c0ac03f0ead6926d8c81d66c'
6
+ metadata.gz: b5804afc266f9b92fe0b6830753a27dddb2b3765e2ef9a5bb5d5a0bd4963c5a15699fed8cb675b6e3ef7adca4750c6787d32e7451ac1c8a0681cfb41d46bd701
7
+ data.tar.gz: 2eea08fb47af054c148aa86743583545dddd71937b44894babd870e36608d6c77b467cb6195eb0463141cee5e74d1575f4f14c5ee7e2f73ed089fea386ff6b72
data/CHANGELOG.md ADDED
@@ -0,0 +1,123 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.22.0 (2021-03-10)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.21.0 (2021-02-02)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.20.0 (2021-01-13)
15
+ ------------------
16
+
17
+ * Feature - Miscellaneous updates and improvements to the documentation
18
+
19
+ 1.19.0 (2020-09-30)
20
+ ------------------
21
+
22
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
23
+
24
+ 1.18.0 (2020-09-15)
25
+ ------------------
26
+
27
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
28
+
29
+ 1.17.0 (2020-08-25)
30
+ ------------------
31
+
32
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
33
+
34
+ 1.16.0 (2020-08-06)
35
+ ------------------
36
+
37
+ * Feature - Add 'exploration' functionality
38
+
39
+ 1.15.0 (2020-06-23)
40
+ ------------------
41
+
42
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
43
+
44
+ 1.14.1 (2020-06-11)
45
+ ------------------
46
+
47
+ * Issue - Republish previous version with correct dependency on `aws-sdk-core`.
48
+
49
+ 1.14.0 (2020-06-10)
50
+ ------------------
51
+
52
+ * Issue - This version has been yanked. (#2327).
53
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
54
+
55
+ 1.13.0 (2020-06-05)
56
+ ------------------
57
+
58
+ * Feature - Adds ability to create and apply filters.
59
+
60
+ 1.12.0 (2020-05-28)
61
+ ------------------
62
+
63
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
64
+
65
+ 1.11.0 (2020-05-07)
66
+ ------------------
67
+
68
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
69
+
70
+ 1.10.0 (2020-03-18)
71
+ ------------------
72
+
73
+ * Feature - Adds support for returning hyperparameter values of the best performing model in a HPO job.
74
+
75
+ 1.9.0 (2020-03-09)
76
+ ------------------
77
+
78
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
79
+
80
+ 1.8.0 (2019-11-14)
81
+ ------------------
82
+
83
+ * Feature - Adds ability to get batch recommendations by creating a batch inference job.
84
+
85
+ 1.7.0 (2019-10-23)
86
+ ------------------
87
+
88
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
89
+
90
+ 1.6.0 (2019-10-14)
91
+ ------------------
92
+
93
+ * Feature - Adds ability to create a solution version using FULL or UPDATE training mode
94
+
95
+ 1.5.0 (2019-09-17)
96
+ ------------------
97
+
98
+ * Feature - Adds trainingHours to solutionVersion properties.
99
+
100
+ 1.4.0 (2019-07-25)
101
+ ------------------
102
+
103
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
104
+
105
+ 1.3.0 (2019-07-01)
106
+ ------------------
107
+
108
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
109
+
110
+ 1.2.0 (2019-06-17)
111
+ ------------------
112
+
113
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
114
+
115
+ 1.1.0 (2019-06-14)
116
+ ------------------
117
+
118
+ * Feature - Documentation updates for Amazon Personalize.
119
+
120
+ 1.0.0 (2019-06-10)
121
+ ------------------
122
+
123
+ * Feature - Initial release of `aws-sdk-personalize`.
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.22.0
@@ -3,10 +3,11 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-personalize/customizations'
47
48
  # @!group service
48
49
  module Aws::Personalize
49
50
 
50
- GEM_VERSION = '1.17.0'
51
+ GEM_VERSION = '1.22.0'
51
52
 
52
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -427,11 +427,16 @@ module Aws::Personalize
427
427
  # throughput and unit of billing for Amazon Personalize. The minimum
428
428
  # provisioned TPS (`minProvisionedTPS`) specifies the baseline
429
429
  # throughput provisioned by Amazon Personalize, and thus, the minimum
430
- # billing charge. If your TPS increases beyond `minProvisionedTPS`,
431
- # Amazon Personalize auto-scales the provisioned capacity up and down,
432
- # but never below `minProvisionedTPS`, to maintain a 70% utilization.
433
- # There's a short time delay while the capacity is increased that might
434
- # 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
435
440
  # `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
436
441
  # and then increase the `minProvisionedTPS` as necessary.
437
442
  #
@@ -686,7 +691,8 @@ module Aws::Personalize
686
691
  # from the data source, as Amazon Personalize makes a copy of your data
687
692
  # and processes it in an internal AWS system.
688
693
  #
689
- # 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.
690
696
  #
691
697
  # **Status**
692
698
  #
@@ -755,23 +761,20 @@ module Aws::Personalize
755
761
  req.send_request(options)
756
762
  end
757
763
 
758
- # 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
759
765
  # specified dataset group using the [PutEvents][1] API.
760
766
  #
761
- # When Amazon Personalize creates an event tracker, it also creates an
762
- # *event-interactions* dataset in the dataset group associated with the
763
- # event tracker. The event-interactions dataset stores the event data
764
- # from the `PutEvents` call. The contents of this dataset are not
765
- # available to the user.
766
- #
767
767
  # <note markdown="1"> Only one event tracker can be associated with a dataset group. You
768
768
  # will get an error if you call `CreateEventTracker` using the same
769
769
  # dataset group as an existing event tracker.
770
770
  #
771
771
  # </note>
772
772
  #
773
- # When you send event data you include your tracking ID. The tracking ID
774
- # 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.
775
778
  #
776
779
  # The event tracker can be in one of the following states:
777
780
  #
@@ -832,12 +835,7 @@ module Aws::Personalize
832
835
  req.send_request(options)
833
836
  end
834
837
 
835
- # Creates a recommendation filter. For more information, see [Using
836
- # Filters with Amazon Personalize][1].
837
- #
838
- #
839
- #
840
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
838
+ # Creates a recommendation filter. For more information, see filter.
841
839
  #
842
840
  # @option params [required, String] :name
843
841
  # The name of the filter to create.
@@ -846,20 +844,10 @@ module Aws::Personalize
846
844
  # The ARN of the dataset group that the filter will belong to.
847
845
  #
848
846
  # @option params [required, String] :filter_expression
849
- # The filter expression that designates the interaction types that the
850
- # filter will filter out. A filter expression must follow the following
851
- # format:
852
- #
853
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
854
- #
855
- # Where "EVENT\_TYPE" is the type of event to filter out. To filter
856
- # out all items with any interactions history, set `"*"` as the
857
- # EVENT\_TYPE. For more information, see [Using Filters with Amazon
858
- # Personalize][1].
859
- #
860
- #
861
- #
862
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
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.
863
851
  #
864
852
  # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
865
853
  #
@@ -950,6 +938,11 @@ module Aws::Personalize
950
938
  # `performAutoML` and Amazon Personalize will analyze your data and
951
939
  # select the optimum USER\_PERSONALIZATION recipe for you.
952
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
+ #
953
946
  # **Status**
954
947
  #
955
948
  # A solution can be in one of the following states:
@@ -1015,11 +1008,19 @@ module Aws::Personalize
1015
1008
  # field), this parameter specifies which event type (for example,
1016
1009
  # 'click' or 'like') is used for training the model.
1017
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
+ #
1018
1014
  # @option params [Types::SolutionConfig] :solution_config
1019
1015
  # The configuration to use with the solution. When `performAutoML` is
1020
1016
  # set to true, Amazon Personalize only evaluates the `autoMLConfig`
1021
1017
  # section of the solution configuration.
1022
1018
  #
1019
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
1020
+ # this time.
1021
+ #
1022
+ # </note>
1023
+ #
1023
1024
  # @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1024
1025
  #
1025
1026
  # * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
@@ -1144,7 +1145,12 @@ module Aws::Personalize
1144
1145
  # The `UPDATE` option can only be used when you already have an active
1145
1146
  # solution version created from the input solution using the `FULL`
1146
1147
  # option and the input solution was trained with the
1147
- # 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
1148
1154
  #
1149
1155
  # @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1150
1156
  #
@@ -2587,7 +2593,7 @@ module Aws::Personalize
2587
2593
  params: params,
2588
2594
  config: config)
2589
2595
  context[:gem_name] = 'aws-sdk-personalize'
2590
- context[:gem_version] = '1.17.0'
2596
+ context[:gem_version] = '1.22.0'
2591
2597
  Seahorse::Client::Request.new(handlers, context)
2592
2598
  end
2593
2599
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -240,9 +240,11 @@ module Aws::Personalize
240
240
  # }
241
241
  #
242
242
  # @!attribute [rw] item_exploration_config
243
- # A string to string map specifying the inference hyperparameters you
244
- # wish to use for hyperparameter optimization. See
245
- # customizing-solution-config-hpo.
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.
246
248
  # @return [Hash<String,String>]
247
249
  #
248
250
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
@@ -442,9 +444,16 @@ module Aws::Personalize
442
444
  # }
443
445
  #
444
446
  # @!attribute [rw] item_exploration_config
445
- # A string to string map specifying the inference hyperparameters you
446
- # wish to use for hyperparameter optimization. See
447
- # customizing-solution-config-hpo.
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
448
457
  # @return [Hash<String,String>]
449
458
  #
450
459
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
@@ -988,20 +997,10 @@ module Aws::Personalize
988
997
  # @return [String]
989
998
  #
990
999
  # @!attribute [rw] filter_expression
991
- # The filter expression that designates the interaction types that the
992
- # filter will filter out. A filter expression must follow the
993
- # following format:
994
- #
995
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
996
- #
997
- # Where "EVENT\_TYPE" is the type of event to filter out. To filter
998
- # out all items with any interactions history, set `"*"` as the
999
- # EVENT\_TYPE. For more information, see [Using Filters with Amazon
1000
- # Personalize][1].
1001
- #
1002
- #
1003
- #
1004
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
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.
1005
1004
  # @return [String]
1006
1005
  #
1007
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
@@ -1159,12 +1158,20 @@ module Aws::Personalize
1159
1158
  # When your have multiple event types (using an `EVENT_TYPE` schema
1160
1159
  # field), this parameter specifies which event type (for example,
1161
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.
1162
1164
  # @return [String]
1163
1165
  #
1164
1166
  # @!attribute [rw] solution_config
1165
1167
  # The configuration to use with the solution. When `performAutoML` is
1166
1168
  # set to true, Amazon Personalize only evaluates the `autoMLConfig`
1167
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>
1168
1175
  # @return [Types::SolutionConfig]
1169
1176
  #
1170
1177
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
@@ -1218,7 +1225,12 @@ module Aws::Personalize
1218
1225
  # The `UPDATE` option can only be used when you already have an active
1219
1226
  # solution version created from the input solution using the `FULL`
1220
1227
  # option and the input solution was trained with the
1221
- # 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
1222
1234
  # @return [String]
1223
1235
  #
1224
1236
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
@@ -2533,17 +2545,9 @@ module Aws::Personalize
2533
2545
  #
2534
2546
  # @!attribute [rw] filter_expression
2535
2547
  # Specifies the type of item interactions to filter out of
2536
- # recommendation results. The filter expression must follow the
2537
- # following format:
2538
- #
2539
- # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
2540
- #
2541
- # Where "EVENT\_TYPE" is the type of event to filter out. For more
2542
- # information, see [Using Filters with Amazon Personalize][1].
2543
- #
2544
- #
2545
- #
2546
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
2548
+ # recommendation results. The filter expression must follow specific
2549
+ # format rules. For information about filter expression structure and
2550
+ # syntax, see filter-expressions.
2547
2551
  # @return [String]
2548
2552
  #
2549
2553
  # @!attribute [rw] status
@@ -2646,9 +2650,7 @@ module Aws::Personalize
2646
2650
  include Aws::Structure
2647
2651
  end
2648
2652
 
2649
- # Describes the properties for hyperparameter optimization (HPO). For
2650
- # use with the bring-your-own-recipe feature. Do not use for Amazon
2651
- # Personalize native recipes.
2653
+ # Describes the properties for hyperparameter optimization (HPO).
2652
2654
  #
2653
2655
  # @note When making an API call, you may pass HPOConfig
2654
2656
  # data as a hash:
@@ -2689,6 +2691,11 @@ module Aws::Personalize
2689
2691
  #
2690
2692
  # @!attribute [rw] hpo_objective
2691
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>
2692
2699
  # @return [Types::HPOObjective]
2693
2700
  #
2694
2701
  # @!attribute [rw] hpo_resource_config
@@ -2711,6 +2718,11 @@ module Aws::Personalize
2711
2718
 
2712
2719
  # The metric to optimize during hyperparameter optimization (HPO).
2713
2720
  #
2721
+ # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
2722
+ # this time.
2723
+ #
2724
+ # </note>
2725
+ #
2714
2726
  # @note When making an API call, you may pass HPOObjective
2715
2727
  # data as a hash:
2716
2728
  #
@@ -3633,7 +3645,9 @@ module Aws::Personalize
3633
3645
  #
3634
3646
  # @!attribute [rw] event_type
3635
3647
  # The event type (for example, 'click' or 'like') that is used for
3636
- # 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.
3637
3651
  # @return [String]
3638
3652
  #
3639
3653
  # @!attribute [rw] solution_config
@@ -3863,17 +3877,23 @@ module Aws::Personalize
3863
3877
  # @return [Float]
3864
3878
  #
3865
3879
  # @!attribute [rw] training_mode
3866
- # The scope of training used to create the solution version. The
3867
- # `FULL` option trains the solution version based on the entirety of
3868
- # the input solution's training data, while the `UPDATE` option
3869
- # processes only the training data that has changed since the creation
3870
- # of the last solution version. Choose `UPDATE` when you want to start
3871
- # recommending items added to the dataset without retraining the
3872
- # model.
3873
- #
3874
- # The `UPDATE` option can only be used after you've created a
3875
- # solution version with the `FULL` option and the training solution
3876
- # uses the native-recipe-hrnn-coldstart.
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
+ #
3894
+ #
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
3877
3897
  # @return [String]
3878
3898
  #
3879
3899
  # @!attribute [rw] tuned_hpo_params
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.17.0
4
+ version: 1.22.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-08-25 00:00:00.000000000 Z
11
+ date: 2021-03-10 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.112.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.112.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -47,11 +47,14 @@ dependencies:
47
47
  description: Official AWS Ruby gem for Amazon Personalize. This gem is part of the
48
48
  AWS SDK for Ruby.
49
49
  email:
50
- - trevrowe@amazon.com
50
+ - aws-dr-rubygems@amazon.com
51
51
  executables: []
52
52
  extensions: []
53
53
  extra_rdoc_files: []
54
54
  files:
55
+ - CHANGELOG.md
56
+ - LICENSE.txt
57
+ - VERSION
55
58
  - lib/aws-sdk-personalize.rb
56
59
  - lib/aws-sdk-personalize/client.rb
57
60
  - lib/aws-sdk-personalize/client_api.rb