aws-sdk-personalize 1.18.0 → 1.23.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 +4 -4
- data/CHANGELOG.md +128 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-personalize.rb +2 -2
- data/lib/aws-sdk-personalize/client.rb +236 -45
- data/lib/aws-sdk-personalize/client_api.rb +107 -1
- data/lib/aws-sdk-personalize/errors.rb +1 -1
- data/lib/aws-sdk-personalize/resource.rb +1 -1
- data/lib/aws-sdk-personalize/types.rb +400 -54
- metadata +11 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 21861151f0e79d08f061f15dad8a66437420dd0bf285c22b5ba20e2fdec125a7
|
|
4
|
+
data.tar.gz: 762f5ed0df85e77554b273a07d0f2dd7c00e9172a80e4bd640b585d224148298
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e39a706304565fb03c6a41def1616592282bf21d3a958bd042ae34a58c19489b41710c536a1c30b36df13f76fd71394e9f486c459d0e330ec5fe54a11a8fa36a
|
|
7
|
+
data.tar.gz: 7f411d1b37dd27f65c5de49ea6ae15cd51d332f8996927584a8a1ea3535983aaf01ac1c989d844b8a5bb1fb98153296f60f18c5287bab023b531c29ae52e4a4c
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
Unreleased Changes
|
|
2
|
+
------------------
|
|
3
|
+
|
|
4
|
+
1.23.0 (2021-04-26)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Added support for exporting data imported into an Amazon Personalize dataset to a specified data source (Amazon S3 bucket).
|
|
8
|
+
|
|
9
|
+
1.22.0 (2021-03-10)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
14
|
+
1.21.0 (2021-02-02)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
18
|
+
|
|
19
|
+
1.20.0 (2021-01-13)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Miscellaneous updates and improvements to the documentation
|
|
23
|
+
|
|
24
|
+
1.19.0 (2020-09-30)
|
|
25
|
+
------------------
|
|
26
|
+
|
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
28
|
+
|
|
29
|
+
1.18.0 (2020-09-15)
|
|
30
|
+
------------------
|
|
31
|
+
|
|
32
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
33
|
+
|
|
34
|
+
1.17.0 (2020-08-25)
|
|
35
|
+
------------------
|
|
36
|
+
|
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
38
|
+
|
|
39
|
+
1.16.0 (2020-08-06)
|
|
40
|
+
------------------
|
|
41
|
+
|
|
42
|
+
* Feature - Add 'exploration' functionality
|
|
43
|
+
|
|
44
|
+
1.15.0 (2020-06-23)
|
|
45
|
+
------------------
|
|
46
|
+
|
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
48
|
+
|
|
49
|
+
1.14.1 (2020-06-11)
|
|
50
|
+
------------------
|
|
51
|
+
|
|
52
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
|
53
|
+
|
|
54
|
+
1.14.0 (2020-06-10)
|
|
55
|
+
------------------
|
|
56
|
+
|
|
57
|
+
* Issue - This version has been yanked. (#2327).
|
|
58
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
59
|
+
|
|
60
|
+
1.13.0 (2020-06-05)
|
|
61
|
+
------------------
|
|
62
|
+
|
|
63
|
+
* Feature - Adds ability to create and apply filters.
|
|
64
|
+
|
|
65
|
+
1.12.0 (2020-05-28)
|
|
66
|
+
------------------
|
|
67
|
+
|
|
68
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
69
|
+
|
|
70
|
+
1.11.0 (2020-05-07)
|
|
71
|
+
------------------
|
|
72
|
+
|
|
73
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
74
|
+
|
|
75
|
+
1.10.0 (2020-03-18)
|
|
76
|
+
------------------
|
|
77
|
+
|
|
78
|
+
* Feature - Adds support for returning hyperparameter values of the best performing model in a HPO job.
|
|
79
|
+
|
|
80
|
+
1.9.0 (2020-03-09)
|
|
81
|
+
------------------
|
|
82
|
+
|
|
83
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
84
|
+
|
|
85
|
+
1.8.0 (2019-11-14)
|
|
86
|
+
------------------
|
|
87
|
+
|
|
88
|
+
* Feature - Adds ability to get batch recommendations by creating a batch inference job.
|
|
89
|
+
|
|
90
|
+
1.7.0 (2019-10-23)
|
|
91
|
+
------------------
|
|
92
|
+
|
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
94
|
+
|
|
95
|
+
1.6.0 (2019-10-14)
|
|
96
|
+
------------------
|
|
97
|
+
|
|
98
|
+
* Feature - Adds ability to create a solution version using FULL or UPDATE training mode
|
|
99
|
+
|
|
100
|
+
1.5.0 (2019-09-17)
|
|
101
|
+
------------------
|
|
102
|
+
|
|
103
|
+
* Feature - Adds trainingHours to solutionVersion properties.
|
|
104
|
+
|
|
105
|
+
1.4.0 (2019-07-25)
|
|
106
|
+
------------------
|
|
107
|
+
|
|
108
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
109
|
+
|
|
110
|
+
1.3.0 (2019-07-01)
|
|
111
|
+
------------------
|
|
112
|
+
|
|
113
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
114
|
+
|
|
115
|
+
1.2.0 (2019-06-17)
|
|
116
|
+
------------------
|
|
117
|
+
|
|
118
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
119
|
+
|
|
120
|
+
1.1.0 (2019-06-14)
|
|
121
|
+
------------------
|
|
122
|
+
|
|
123
|
+
* Feature - Documentation updates for Amazon Personalize.
|
|
124
|
+
|
|
125
|
+
1.0.0 (2019-06-10)
|
|
126
|
+
------------------
|
|
127
|
+
|
|
128
|
+
* 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.23.0
|
data/lib/aws-sdk-personalize.rb
CHANGED
|
@@ -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/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-personalize/customizations'
|
|
|
48
48
|
# @!group service
|
|
49
49
|
module Aws::Personalize
|
|
50
50
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
51
|
+
GEM_VERSION = '1.23.0'
|
|
52
52
|
|
|
53
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/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -350,8 +350,12 @@ module Aws::Personalize
|
|
|
350
350
|
#
|
|
351
351
|
# @option params [String] :filter_arn
|
|
352
352
|
# The ARN of the filter to apply to the batch inference job. For more
|
|
353
|
-
# information on using filters, see
|
|
354
|
-
#
|
|
353
|
+
# information on using filters, see [Filtering Batch
|
|
354
|
+
# Recommendations][1]..
|
|
355
|
+
#
|
|
356
|
+
#
|
|
357
|
+
#
|
|
358
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
|
|
355
359
|
#
|
|
356
360
|
# @option params [Integer] :num_results
|
|
357
361
|
# The number of recommendations to retreive.
|
|
@@ -366,8 +370,8 @@ module Aws::Personalize
|
|
|
366
370
|
#
|
|
367
371
|
# @option params [required, String] :role_arn
|
|
368
372
|
# The ARN of the Amazon Identity and Access Management role that has
|
|
369
|
-
# permissions to read and write to your input and
|
|
370
|
-
# respectively.
|
|
373
|
+
# permissions to read and write to your input and output Amazon S3
|
|
374
|
+
# buckets respectively.
|
|
371
375
|
#
|
|
372
376
|
# @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
|
|
373
377
|
# The configuration details of a batch inference job.
|
|
@@ -427,11 +431,16 @@ module Aws::Personalize
|
|
|
427
431
|
# throughput and unit of billing for Amazon Personalize. The minimum
|
|
428
432
|
# provisioned TPS (`minProvisionedTPS`) specifies the baseline
|
|
429
433
|
# throughput provisioned by Amazon Personalize, and thus, the minimum
|
|
430
|
-
# billing charge.
|
|
431
|
-
#
|
|
432
|
-
#
|
|
433
|
-
#
|
|
434
|
-
#
|
|
434
|
+
# billing charge.
|
|
435
|
+
#
|
|
436
|
+
# If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize
|
|
437
|
+
# auto-scales the provisioned capacity up and down, but never below
|
|
438
|
+
# `minProvisionedTPS`. There's a short time delay while the capacity is
|
|
439
|
+
# increased that might cause loss of transactions.
|
|
440
|
+
#
|
|
441
|
+
# The actual TPS used is calculated as the average requests/second
|
|
442
|
+
# within a 5-minute window. You pay for maximum of either the minimum
|
|
443
|
+
# provisioned TPS or the actual TPS. We recommend starting with a low
|
|
435
444
|
# `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
|
|
436
445
|
# and then increase the `minProvisionedTPS` as necessary.
|
|
437
446
|
#
|
|
@@ -592,6 +601,87 @@ module Aws::Personalize
|
|
|
592
601
|
req.send_request(options)
|
|
593
602
|
end
|
|
594
603
|
|
|
604
|
+
# Creates a job that exports data from your dataset to an Amazon S3
|
|
605
|
+
# bucket. To allow Amazon Personalize to export the training data, you
|
|
606
|
+
# must specify an service-linked AWS Identity and Access Management
|
|
607
|
+
# (IAM) role that gives Amazon Personalize `PutObject` permissions for
|
|
608
|
+
# your Amazon S3 bucket. For information, see [Dataset export job
|
|
609
|
+
# permissions requirements][1] in the Amazon Personalize developer
|
|
610
|
+
# guide.
|
|
611
|
+
#
|
|
612
|
+
# **Status**
|
|
613
|
+
#
|
|
614
|
+
# A dataset export job can be in one of the following states:
|
|
615
|
+
#
|
|
616
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
|
617
|
+
# FAILED
|
|
618
|
+
#
|
|
619
|
+
# ^
|
|
620
|
+
#
|
|
621
|
+
# To get the status of the export job, call DescribeDatasetExportJob,
|
|
622
|
+
# and specify the Amazon Resource Name (ARN) of the dataset export job.
|
|
623
|
+
# The dataset export is complete when the status shows as ACTIVE. If the
|
|
624
|
+
# status shows as CREATE FAILED, the response includes a `failureReason`
|
|
625
|
+
# key, which describes why the job failed.
|
|
626
|
+
#
|
|
627
|
+
#
|
|
628
|
+
#
|
|
629
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/export-permissions.html
|
|
630
|
+
#
|
|
631
|
+
# @option params [required, String] :job_name
|
|
632
|
+
# The name for the dataset export job.
|
|
633
|
+
#
|
|
634
|
+
# @option params [required, String] :dataset_arn
|
|
635
|
+
# The Amazon Resource Name (ARN) of the dataset that contains the data
|
|
636
|
+
# to export.
|
|
637
|
+
#
|
|
638
|
+
# @option params [String] :ingestion_mode
|
|
639
|
+
# The data to export, based on how you imported the data. You can choose
|
|
640
|
+
# to export only `BULK` data that you imported using a dataset import
|
|
641
|
+
# job, only `PUT` data that you imported incrementally (using the
|
|
642
|
+
# console, PutEvents, PutUsers and PutItems operations), or `ALL` for
|
|
643
|
+
# both types. The default value is `PUT`.
|
|
644
|
+
#
|
|
645
|
+
# @option params [required, String] :role_arn
|
|
646
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
|
647
|
+
# Management service role that has permissions to add data to your
|
|
648
|
+
# output Amazon S3 bucket.
|
|
649
|
+
#
|
|
650
|
+
# @option params [required, Types::DatasetExportJobOutput] :job_output
|
|
651
|
+
# The path to the Amazon S3 bucket where the job's output is stored.
|
|
652
|
+
#
|
|
653
|
+
# @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
654
|
+
#
|
|
655
|
+
# * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
|
|
656
|
+
#
|
|
657
|
+
# @example Request syntax with placeholder values
|
|
658
|
+
#
|
|
659
|
+
# resp = client.create_dataset_export_job({
|
|
660
|
+
# job_name: "Name", # required
|
|
661
|
+
# dataset_arn: "Arn", # required
|
|
662
|
+
# ingestion_mode: "BULK", # accepts BULK, PUT, ALL
|
|
663
|
+
# role_arn: "RoleArn", # required
|
|
664
|
+
# job_output: { # required
|
|
665
|
+
# s3_data_destination: { # required
|
|
666
|
+
# path: "S3Location", # required
|
|
667
|
+
# kms_key_arn: "KmsKeyArn",
|
|
668
|
+
# },
|
|
669
|
+
# },
|
|
670
|
+
# })
|
|
671
|
+
#
|
|
672
|
+
# @example Response structure
|
|
673
|
+
#
|
|
674
|
+
# resp.dataset_export_job_arn #=> String
|
|
675
|
+
#
|
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJob AWS API Documentation
|
|
677
|
+
#
|
|
678
|
+
# @overload create_dataset_export_job(params = {})
|
|
679
|
+
# @param [Hash] params ({})
|
|
680
|
+
def create_dataset_export_job(params = {}, options = {})
|
|
681
|
+
req = build_request(:create_dataset_export_job, params)
|
|
682
|
+
req.send_request(options)
|
|
683
|
+
end
|
|
684
|
+
|
|
595
685
|
# Creates an empty dataset group. A dataset group contains related
|
|
596
686
|
# datasets that supply data for training a model. A dataset group can
|
|
597
687
|
# contain at most three datasets, one for each type of dataset:
|
|
@@ -682,11 +772,14 @@ module Aws::Personalize
|
|
|
682
772
|
# Creates a job that imports training data from your data source (an
|
|
683
773
|
# Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
|
|
684
774
|
# Personalize to import the training data, you must specify an AWS
|
|
685
|
-
# Identity and Access Management (IAM) role that has permission
|
|
686
|
-
# from the data source, as Amazon Personalize makes a copy of
|
|
687
|
-
# and processes it in an internal AWS system.
|
|
775
|
+
# Identity and Access Management (IAM) service role that has permission
|
|
776
|
+
# to read from the data source, as Amazon Personalize makes a copy of
|
|
777
|
+
# your data and processes it in an internal AWS system. For information
|
|
778
|
+
# on granting access to your Amazon S3 bucket, see [Giving Amazon
|
|
779
|
+
# Personalize Access to Amazon S3 Resources][1].
|
|
688
780
|
#
|
|
689
|
-
# The dataset import job replaces any
|
|
781
|
+
# The dataset import job replaces any existing data in the dataset that
|
|
782
|
+
# you imported in bulk.
|
|
690
783
|
#
|
|
691
784
|
# **Status**
|
|
692
785
|
#
|
|
@@ -714,6 +807,10 @@ module Aws::Personalize
|
|
|
714
807
|
#
|
|
715
808
|
# * DescribeDatasetImportJob
|
|
716
809
|
#
|
|
810
|
+
#
|
|
811
|
+
#
|
|
812
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
|
|
813
|
+
#
|
|
717
814
|
# @option params [required, String] :job_name
|
|
718
815
|
# The name for the dataset import job.
|
|
719
816
|
#
|
|
@@ -755,23 +852,20 @@ module Aws::Personalize
|
|
|
755
852
|
req.send_request(options)
|
|
756
853
|
end
|
|
757
854
|
|
|
758
|
-
# Creates an event tracker that you use when
|
|
855
|
+
# Creates an event tracker that you use when adding event data to a
|
|
759
856
|
# specified dataset group using the [PutEvents][1] API.
|
|
760
857
|
#
|
|
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
858
|
# <note markdown="1"> Only one event tracker can be associated with a dataset group. You
|
|
768
859
|
# will get an error if you call `CreateEventTracker` using the same
|
|
769
860
|
# dataset group as an existing event tracker.
|
|
770
861
|
#
|
|
771
862
|
# </note>
|
|
772
863
|
#
|
|
773
|
-
# When you
|
|
774
|
-
#
|
|
864
|
+
# When you create an event tracker, the response includes a tracking ID,
|
|
865
|
+
# which you pass as a parameter when you use the [PutEvents][1]
|
|
866
|
+
# operation. Amazon Personalize then appends the event data to the
|
|
867
|
+
# Interactions dataset of the dataset group you specify in your event
|
|
868
|
+
# tracker.
|
|
775
869
|
#
|
|
776
870
|
# The event tracker can be in one of the following states:
|
|
777
871
|
#
|
|
@@ -832,12 +926,7 @@ module Aws::Personalize
|
|
|
832
926
|
req.send_request(options)
|
|
833
927
|
end
|
|
834
928
|
|
|
835
|
-
# Creates a recommendation filter. For more information, see
|
|
836
|
-
# Filters with Amazon Personalize][1].
|
|
837
|
-
#
|
|
838
|
-
#
|
|
839
|
-
#
|
|
840
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
|
|
929
|
+
# Creates a recommendation filter. For more information, see filter.
|
|
841
930
|
#
|
|
842
931
|
# @option params [required, String] :name
|
|
843
932
|
# The name of the filter to create.
|
|
@@ -846,20 +935,10 @@ module Aws::Personalize
|
|
|
846
935
|
# The ARN of the dataset group that the filter will belong to.
|
|
847
936
|
#
|
|
848
937
|
# @option params [required, String] :filter_expression
|
|
849
|
-
# The filter expression
|
|
850
|
-
#
|
|
851
|
-
#
|
|
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
|
|
938
|
+
# The filter expression defines which items are included or excluded
|
|
939
|
+
# from recommendations. Filter expression must follow specific format
|
|
940
|
+
# rules. For information about filter expression structure and syntax,
|
|
941
|
+
# see filter-expressions.
|
|
863
942
|
#
|
|
864
943
|
# @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
865
944
|
#
|
|
@@ -950,6 +1029,11 @@ module Aws::Personalize
|
|
|
950
1029
|
# `performAutoML` and Amazon Personalize will analyze your data and
|
|
951
1030
|
# select the optimum USER\_PERSONALIZATION recipe for you.
|
|
952
1031
|
#
|
|
1032
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` for
|
|
1033
|
+
# solution hyperparameter optimization at this time.
|
|
1034
|
+
#
|
|
1035
|
+
# </note>
|
|
1036
|
+
#
|
|
953
1037
|
# **Status**
|
|
954
1038
|
#
|
|
955
1039
|
# A solution can be in one of the following states:
|
|
@@ -1015,11 +1099,19 @@ module Aws::Personalize
|
|
|
1015
1099
|
# field), this parameter specifies which event type (for example,
|
|
1016
1100
|
# 'click' or 'like') is used for training the model.
|
|
1017
1101
|
#
|
|
1102
|
+
# If you do not provide an `eventType`, Amazon Personalize will use all
|
|
1103
|
+
# interactions for training with equal weight regardless of type.
|
|
1104
|
+
#
|
|
1018
1105
|
# @option params [Types::SolutionConfig] :solution_config
|
|
1019
1106
|
# The configuration to use with the solution. When `performAutoML` is
|
|
1020
1107
|
# set to true, Amazon Personalize only evaluates the `autoMLConfig`
|
|
1021
1108
|
# section of the solution configuration.
|
|
1022
1109
|
#
|
|
1110
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
|
|
1111
|
+
# this time.
|
|
1112
|
+
#
|
|
1113
|
+
# </note>
|
|
1114
|
+
#
|
|
1023
1115
|
# @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1024
1116
|
#
|
|
1025
1117
|
# * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
|
|
@@ -1144,7 +1236,12 @@ module Aws::Personalize
|
|
|
1144
1236
|
# The `UPDATE` option can only be used when you already have an active
|
|
1145
1237
|
# solution version created from the input solution using the `FULL`
|
|
1146
1238
|
# option and the input solution was trained with the
|
|
1147
|
-
#
|
|
1239
|
+
# [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
|
|
1240
|
+
#
|
|
1241
|
+
#
|
|
1242
|
+
#
|
|
1243
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
|
1244
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
|
1148
1245
|
#
|
|
1149
1246
|
# @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1150
1247
|
#
|
|
@@ -1543,6 +1640,45 @@ module Aws::Personalize
|
|
|
1543
1640
|
req.send_request(options)
|
|
1544
1641
|
end
|
|
1545
1642
|
|
|
1643
|
+
# Describes the dataset export job created by CreateDatasetExportJob,
|
|
1644
|
+
# including the export job status.
|
|
1645
|
+
#
|
|
1646
|
+
# @option params [required, String] :dataset_export_job_arn
|
|
1647
|
+
# The Amazon Resource Name (ARN) of the dataset export job to describe.
|
|
1648
|
+
#
|
|
1649
|
+
# @return [Types::DescribeDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1650
|
+
#
|
|
1651
|
+
# * {Types::DescribeDatasetExportJobResponse#dataset_export_job #dataset_export_job} => Types::DatasetExportJob
|
|
1652
|
+
#
|
|
1653
|
+
# @example Request syntax with placeholder values
|
|
1654
|
+
#
|
|
1655
|
+
# resp = client.describe_dataset_export_job({
|
|
1656
|
+
# dataset_export_job_arn: "Arn", # required
|
|
1657
|
+
# })
|
|
1658
|
+
#
|
|
1659
|
+
# @example Response structure
|
|
1660
|
+
#
|
|
1661
|
+
# resp.dataset_export_job.job_name #=> String
|
|
1662
|
+
# resp.dataset_export_job.dataset_export_job_arn #=> String
|
|
1663
|
+
# resp.dataset_export_job.dataset_arn #=> String
|
|
1664
|
+
# resp.dataset_export_job.ingestion_mode #=> String, one of "BULK", "PUT", "ALL"
|
|
1665
|
+
# resp.dataset_export_job.role_arn #=> String
|
|
1666
|
+
# resp.dataset_export_job.status #=> String
|
|
1667
|
+
# resp.dataset_export_job.job_output.s3_data_destination.path #=> String
|
|
1668
|
+
# resp.dataset_export_job.job_output.s3_data_destination.kms_key_arn #=> String
|
|
1669
|
+
# resp.dataset_export_job.creation_date_time #=> Time
|
|
1670
|
+
# resp.dataset_export_job.last_updated_date_time #=> Time
|
|
1671
|
+
# resp.dataset_export_job.failure_reason #=> String
|
|
1672
|
+
#
|
|
1673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJob AWS API Documentation
|
|
1674
|
+
#
|
|
1675
|
+
# @overload describe_dataset_export_job(params = {})
|
|
1676
|
+
# @param [Hash] params ({})
|
|
1677
|
+
def describe_dataset_export_job(params = {}, options = {})
|
|
1678
|
+
req = build_request(:describe_dataset_export_job, params)
|
|
1679
|
+
req.send_request(options)
|
|
1680
|
+
end
|
|
1681
|
+
|
|
1546
1682
|
# Describes the given dataset group. For more information on dataset
|
|
1547
1683
|
# groups, see CreateDatasetGroup.
|
|
1548
1684
|
#
|
|
@@ -2083,6 +2219,59 @@ module Aws::Personalize
|
|
|
2083
2219
|
req.send_request(options)
|
|
2084
2220
|
end
|
|
2085
2221
|
|
|
2222
|
+
# Returns a list of dataset export jobs that use the given dataset. When
|
|
2223
|
+
# a dataset is not specified, all the dataset export jobs associated
|
|
2224
|
+
# with the account are listed. The response provides the properties for
|
|
2225
|
+
# each dataset export job, including the Amazon Resource Name (ARN). For
|
|
2226
|
+
# more information on dataset export jobs, see CreateDatasetExportJob.
|
|
2227
|
+
# For more information on datasets, see CreateDataset.
|
|
2228
|
+
#
|
|
2229
|
+
# @option params [String] :dataset_arn
|
|
2230
|
+
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
2231
|
+
# export jobs for.
|
|
2232
|
+
#
|
|
2233
|
+
# @option params [String] :next_token
|
|
2234
|
+
# A token returned from the previous call to `ListDatasetExportJobs` for
|
|
2235
|
+
# getting the next set of dataset export jobs (if they exist).
|
|
2236
|
+
#
|
|
2237
|
+
# @option params [Integer] :max_results
|
|
2238
|
+
# The maximum number of dataset export jobs to return.
|
|
2239
|
+
#
|
|
2240
|
+
# @return [Types::ListDatasetExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2241
|
+
#
|
|
2242
|
+
# * {Types::ListDatasetExportJobsResponse#dataset_export_jobs #dataset_export_jobs} => Array<Types::DatasetExportJobSummary>
|
|
2243
|
+
# * {Types::ListDatasetExportJobsResponse#next_token #next_token} => String
|
|
2244
|
+
#
|
|
2245
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2246
|
+
#
|
|
2247
|
+
# @example Request syntax with placeholder values
|
|
2248
|
+
#
|
|
2249
|
+
# resp = client.list_dataset_export_jobs({
|
|
2250
|
+
# dataset_arn: "Arn",
|
|
2251
|
+
# next_token: "NextToken",
|
|
2252
|
+
# max_results: 1,
|
|
2253
|
+
# })
|
|
2254
|
+
#
|
|
2255
|
+
# @example Response structure
|
|
2256
|
+
#
|
|
2257
|
+
# resp.dataset_export_jobs #=> Array
|
|
2258
|
+
# resp.dataset_export_jobs[0].dataset_export_job_arn #=> String
|
|
2259
|
+
# resp.dataset_export_jobs[0].job_name #=> String
|
|
2260
|
+
# resp.dataset_export_jobs[0].status #=> String
|
|
2261
|
+
# resp.dataset_export_jobs[0].creation_date_time #=> Time
|
|
2262
|
+
# resp.dataset_export_jobs[0].last_updated_date_time #=> Time
|
|
2263
|
+
# resp.dataset_export_jobs[0].failure_reason #=> String
|
|
2264
|
+
# resp.next_token #=> String
|
|
2265
|
+
#
|
|
2266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs AWS API Documentation
|
|
2267
|
+
#
|
|
2268
|
+
# @overload list_dataset_export_jobs(params = {})
|
|
2269
|
+
# @param [Hash] params ({})
|
|
2270
|
+
def list_dataset_export_jobs(params = {}, options = {})
|
|
2271
|
+
req = build_request(:list_dataset_export_jobs, params)
|
|
2272
|
+
req.send_request(options)
|
|
2273
|
+
end
|
|
2274
|
+
|
|
2086
2275
|
# Returns a list of dataset groups. The response provides the properties
|
|
2087
2276
|
# for each dataset group, including the Amazon Resource Name (ARN). For
|
|
2088
2277
|
# more information on dataset groups, see CreateDatasetGroup.
|
|
@@ -2298,6 +2487,8 @@ module Aws::Personalize
|
|
|
2298
2487
|
# * {Types::ListFiltersResponse#filters #filters} => Array<Types::FilterSummary>
|
|
2299
2488
|
# * {Types::ListFiltersResponse#next_token #next_token} => String
|
|
2300
2489
|
#
|
|
2490
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2491
|
+
#
|
|
2301
2492
|
# @example Request syntax with placeholder values
|
|
2302
2493
|
#
|
|
2303
2494
|
# resp = client.list_filters({
|
|
@@ -2587,7 +2778,7 @@ module Aws::Personalize
|
|
|
2587
2778
|
params: params,
|
|
2588
2779
|
config: config)
|
|
2589
2780
|
context[:gem_name] = 'aws-sdk-personalize'
|
|
2590
|
-
context[:gem_version] = '1.
|
|
2781
|
+
context[:gem_version] = '1.23.0'
|
|
2591
2782
|
Seahorse::Client::Request.new(handlers, context)
|
|
2592
2783
|
end
|
|
2593
2784
|
|