aws-sdk-personalize 1.19.0 → 1.24.0

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