aws-sdk-forecastservice 1.12.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +98 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-forecastservice.rb +2 -2
- data/lib/aws-sdk-forecastservice/client.rb +342 -4
- data/lib/aws-sdk-forecastservice/client_api.rb +129 -1
- data/lib/aws-sdk-forecastservice/errors.rb +1 -1
- data/lib/aws-sdk-forecastservice/resource.rb +1 -1
- data/lib/aws-sdk-forecastservice/types.rb +562 -58
- metadata +8 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f0349d0b6333e4f84d87eb0bb485c806dbf5d74c23a0712317f919acdf8afb22
|
4
|
+
data.tar.gz: 49ef8227c9a0552295f5bf7ef0bb71b56e42987f6b1e891ff5d853a2bae42e86
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 52dd61eb888babb7eca257db3c68db0f6cf35110d66f1c505cb5dcfd80026aa0e2ffe43f64e640f82486892273b35f751d4300472dd287321fb129d7278b1b96
|
7
|
+
data.tar.gz: 8b570ca864fcb21bda723df79272471e435c64e174e898a101aaa2f384db87afaa5bedb7fbe724758c88511c7894ae01e72f7e295371b5a8a9e632489f497c9a
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.17.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.16.0 (2021-03-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added new StopResource operation that stops Amazon Forecast resource jobs that are in progress.
|
13
|
+
|
14
|
+
1.15.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.14.0 (2020-12-08)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release adds support for the Amazon Forecast Weather Index which can increase forecasting accuracy by automatically including weather forecasts in demand forecasts.
|
23
|
+
|
24
|
+
1.13.0 (2020-11-23)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Releasing the set of PredictorBacktestExportJob APIs which allow customers to export backtest values and item-level metrics data from Predictor training.
|
28
|
+
|
29
|
+
1.12.0 (2020-11-11)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Providing support of custom quantiles in CreatePredictor API.
|
33
|
+
|
34
|
+
1.11.0 (2020-09-30)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.10.0 (2020-09-15)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.9.0 (2020-08-25)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
48
|
+
|
49
|
+
1.8.0 (2020-07-08)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Feature - With this release, Amazon Forecast now supports the ability to add a tag to any resource via the launch of three new APIs: TagResouce, UntagResource and ListTagsForResource. A tag is a simple label consisting of a customer-defined key and an optional value allowing for easier resource management.
|
53
|
+
|
54
|
+
1.7.0 (2020-06-23)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
58
|
+
|
59
|
+
1.6.1 (2020-06-11)
|
60
|
+
------------------
|
61
|
+
|
62
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
63
|
+
|
64
|
+
1.6.0 (2020-06-10)
|
65
|
+
------------------
|
66
|
+
|
67
|
+
* Issue - This version has been yanked. (#2327).
|
68
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
69
|
+
|
70
|
+
1.5.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.4.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.3.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.2.0 (2019-11-22)
|
86
|
+
------------------
|
87
|
+
|
88
|
+
* Feature - This release adds two key updates to existing APIs. 1. Amazon Forecast can now generate forecasts in any quantile using the optional parameter forecastTypes in the CreateForecast API and 2. You can get additional details (metrics and relevant error messages) on your AutoML runs using the DescribePredictor and GetAccuracyMetrics APIs.
|
89
|
+
|
90
|
+
1.1.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.0.0 (2019-08-21)
|
96
|
+
------------------
|
97
|
+
|
98
|
+
* Feature - Initial release of `aws-sdk-forecastservice`.
|
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.17.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/
|
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-forecastservice/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::ForecastService
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.17.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
|
|
@@ -459,7 +459,7 @@ module Aws::ForecastService
|
|
459
459
|
# attributes: [
|
460
460
|
# {
|
461
461
|
# attribute_name: "Name",
|
462
|
-
# attribute_type: "string", # accepts string, integer, float, timestamp
|
462
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
463
463
|
# },
|
464
464
|
# ],
|
465
465
|
# },
|
@@ -652,6 +652,34 @@ module Aws::ForecastService
|
|
652
652
|
# If the format isn't specified, Amazon Forecast expects the format to
|
653
653
|
# be "yyyy-MM-dd HH:mm:ss".
|
654
654
|
#
|
655
|
+
# @option params [String] :time_zone
|
656
|
+
# A single time zone for every item in your dataset. This option is
|
657
|
+
# ideal for datasets with all timestamps within a single time zone, or
|
658
|
+
# if all timestamps are normalized to a single time zone.
|
659
|
+
#
|
660
|
+
# Refer to the [Joda-Time API][1] for a complete list of valid time zone
|
661
|
+
# names.
|
662
|
+
#
|
663
|
+
#
|
664
|
+
#
|
665
|
+
# [1]: http://joda-time.sourceforge.net/timezones.html
|
666
|
+
#
|
667
|
+
# @option params [Boolean] :use_geolocation_for_time_zone
|
668
|
+
# Automatically derive time zone information from the geolocation
|
669
|
+
# attribute. This option is ideal for datasets that contain timestamps
|
670
|
+
# in multiple time zones and those timestamps are expressed in local
|
671
|
+
# time.
|
672
|
+
#
|
673
|
+
# @option params [String] :geolocation_format
|
674
|
+
# The format of the geolocation attribute. The geolocation attribute can
|
675
|
+
# be formatted in one of two ways:
|
676
|
+
#
|
677
|
+
# * `LAT_LONG` - the latitude and longitude in decimal format (Example:
|
678
|
+
# 47.61\_-122.33).
|
679
|
+
#
|
680
|
+
# * `CC_POSTALCODE` (US Only) - the country code (US), followed by the
|
681
|
+
# 5-digit ZIP code (Example: US\_98121).
|
682
|
+
#
|
655
683
|
# @option params [Array<Types::Tag>] :tags
|
656
684
|
# The optional metadata that you apply to the dataset import job to help
|
657
685
|
# you categorize and organize them. Each tag consists of a key and an
|
@@ -701,6 +729,9 @@ module Aws::ForecastService
|
|
701
729
|
# },
|
702
730
|
# },
|
703
731
|
# timestamp_format: "TimestampFormat",
|
732
|
+
# time_zone: "TimeZone",
|
733
|
+
# use_geolocation_for_time_zone: false,
|
734
|
+
# geolocation_format: "GeolocationFormat",
|
704
735
|
# tags: [
|
705
736
|
# {
|
706
737
|
# key: "TagKey", # required
|
@@ -1230,6 +1261,105 @@ module Aws::ForecastService
|
|
1230
1261
|
req.send_request(options)
|
1231
1262
|
end
|
1232
1263
|
|
1264
|
+
# Exports backtest forecasts and accuracy metrics generated by the
|
1265
|
+
# CreatePredictor operation. Two folders containing CSV files are
|
1266
|
+
# exported to your specified S3 bucket.
|
1267
|
+
#
|
1268
|
+
# The export file names will match the following conventions:
|
1269
|
+
#
|
1270
|
+
# `<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv`
|
1271
|
+
#
|
1272
|
+
# The <ExportTimestamp> component is in Java SimpleDate format
|
1273
|
+
# (yyyy-MM-ddTHH-mm-ssZ).
|
1274
|
+
#
|
1275
|
+
# You must specify a DataDestination object that includes an Amazon S3
|
1276
|
+
# bucket and an AWS Identity and Access Management (IAM) role that
|
1277
|
+
# Amazon Forecast can assume to access the Amazon S3 bucket. For more
|
1278
|
+
# information, see aws-forecast-iam-roles.
|
1279
|
+
#
|
1280
|
+
# <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
|
1281
|
+
# the export in your Amazon S3 bucket. To get the status, use the
|
1282
|
+
# DescribePredictorBacktestExportJob operation.
|
1283
|
+
#
|
1284
|
+
# </note>
|
1285
|
+
#
|
1286
|
+
# @option params [required, String] :predictor_backtest_export_job_name
|
1287
|
+
# The name for the backtest export job.
|
1288
|
+
#
|
1289
|
+
# @option params [required, String] :predictor_arn
|
1290
|
+
# The Amazon Resource Name (ARN) of the predictor that you want to
|
1291
|
+
# export.
|
1292
|
+
#
|
1293
|
+
# @option params [required, Types::DataDestination] :destination
|
1294
|
+
# The destination for an export job. Provide an S3 path, an AWS Identity
|
1295
|
+
# and Access Management (IAM) role that allows Amazon Forecast to access
|
1296
|
+
# the location, and an AWS Key Management Service (KMS) key (optional).
|
1297
|
+
#
|
1298
|
+
# @option params [Array<Types::Tag>] :tags
|
1299
|
+
# Optional metadata to help you categorize and organize your backtests.
|
1300
|
+
# Each tag consists of a key and an optional value, both of which you
|
1301
|
+
# define. Tag keys and values are case sensitive.
|
1302
|
+
#
|
1303
|
+
# The following restrictions apply to tags:
|
1304
|
+
#
|
1305
|
+
# * For each resource, each tag key must be unique and each tag key must
|
1306
|
+
# have one value.
|
1307
|
+
#
|
1308
|
+
# * Maximum number of tags per resource: 50.
|
1309
|
+
#
|
1310
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1311
|
+
#
|
1312
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1313
|
+
#
|
1314
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
1315
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
1316
|
+
# across other services and resources, the character restrictions of
|
1317
|
+
# those services also apply.
|
1318
|
+
#
|
1319
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
1320
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
1321
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
1322
|
+
# be a user tag and will count against the limit of 50 tags. Tags with
|
1323
|
+
# only the key prefix of `aws` do not count against your tags per
|
1324
|
+
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1325
|
+
#
|
1326
|
+
# @return [Types::CreatePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1327
|
+
#
|
1328
|
+
# * {Types::CreatePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
|
1329
|
+
#
|
1330
|
+
# @example Request syntax with placeholder values
|
1331
|
+
#
|
1332
|
+
# resp = client.create_predictor_backtest_export_job({
|
1333
|
+
# predictor_backtest_export_job_name: "Name", # required
|
1334
|
+
# predictor_arn: "Arn", # required
|
1335
|
+
# destination: { # required
|
1336
|
+
# s3_config: { # required
|
1337
|
+
# path: "S3Path", # required
|
1338
|
+
# role_arn: "Arn", # required
|
1339
|
+
# kms_key_arn: "KMSKeyArn",
|
1340
|
+
# },
|
1341
|
+
# },
|
1342
|
+
# tags: [
|
1343
|
+
# {
|
1344
|
+
# key: "TagKey", # required
|
1345
|
+
# value: "TagValue", # required
|
1346
|
+
# },
|
1347
|
+
# ],
|
1348
|
+
# })
|
1349
|
+
#
|
1350
|
+
# @example Response structure
|
1351
|
+
#
|
1352
|
+
# resp.predictor_backtest_export_job_arn #=> String
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob AWS API Documentation
|
1355
|
+
#
|
1356
|
+
# @overload create_predictor_backtest_export_job(params = {})
|
1357
|
+
# @param [Hash] params ({})
|
1358
|
+
def create_predictor_backtest_export_job(params = {}, options = {})
|
1359
|
+
req = build_request(:create_predictor_backtest_export_job, params)
|
1360
|
+
req.send_request(options)
|
1361
|
+
end
|
1362
|
+
|
1233
1363
|
# Deletes an Amazon Forecast dataset that was created using the
|
1234
1364
|
# CreateDataset operation. You can only delete datasets that have a
|
1235
1365
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
@@ -1392,6 +1522,29 @@ module Aws::ForecastService
|
|
1392
1522
|
req.send_request(options)
|
1393
1523
|
end
|
1394
1524
|
|
1525
|
+
# Deletes a predictor backtest export job.
|
1526
|
+
#
|
1527
|
+
# @option params [required, String] :predictor_backtest_export_job_arn
|
1528
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job to
|
1529
|
+
# delete.
|
1530
|
+
#
|
1531
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1532
|
+
#
|
1533
|
+
# @example Request syntax with placeholder values
|
1534
|
+
#
|
1535
|
+
# resp = client.delete_predictor_backtest_export_job({
|
1536
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1537
|
+
# })
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob AWS API Documentation
|
1540
|
+
#
|
1541
|
+
# @overload delete_predictor_backtest_export_job(params = {})
|
1542
|
+
# @param [Hash] params ({})
|
1543
|
+
def delete_predictor_backtest_export_job(params = {}, options = {})
|
1544
|
+
req = build_request(:delete_predictor_backtest_export_job, params)
|
1545
|
+
req.send_request(options)
|
1546
|
+
end
|
1547
|
+
|
1395
1548
|
# Describes an Amazon Forecast dataset created using the CreateDataset
|
1396
1549
|
# operation.
|
1397
1550
|
#
|
@@ -1435,7 +1588,7 @@ module Aws::ForecastService
|
|
1435
1588
|
# resp.data_frequency #=> String
|
1436
1589
|
# resp.schema.attributes #=> Array
|
1437
1590
|
# resp.schema.attributes[0].attribute_name #=> String
|
1438
|
-
# resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp"
|
1591
|
+
# resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
|
1439
1592
|
# resp.encryption_config.role_arn #=> String
|
1440
1593
|
# resp.encryption_config.kms_key_arn #=> String
|
1441
1594
|
# resp.status #=> String
|
@@ -1533,6 +1686,9 @@ module Aws::ForecastService
|
|
1533
1686
|
# * {Types::DescribeDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
1534
1687
|
# * {Types::DescribeDatasetImportJobResponse#dataset_arn #dataset_arn} => String
|
1535
1688
|
# * {Types::DescribeDatasetImportJobResponse#timestamp_format #timestamp_format} => String
|
1689
|
+
# * {Types::DescribeDatasetImportJobResponse#time_zone #time_zone} => String
|
1690
|
+
# * {Types::DescribeDatasetImportJobResponse#use_geolocation_for_time_zone #use_geolocation_for_time_zone} => Boolean
|
1691
|
+
# * {Types::DescribeDatasetImportJobResponse#geolocation_format #geolocation_format} => String
|
1536
1692
|
# * {Types::DescribeDatasetImportJobResponse#data_source #data_source} => Types::DataSource
|
1537
1693
|
# * {Types::DescribeDatasetImportJobResponse#field_statistics #field_statistics} => Hash<String,Types::Statistics>
|
1538
1694
|
# * {Types::DescribeDatasetImportJobResponse#data_size #data_size} => Float
|
@@ -1553,6 +1709,9 @@ module Aws::ForecastService
|
|
1553
1709
|
# resp.dataset_import_job_arn #=> String
|
1554
1710
|
# resp.dataset_arn #=> String
|
1555
1711
|
# resp.timestamp_format #=> String
|
1712
|
+
# resp.time_zone #=> String
|
1713
|
+
# resp.use_geolocation_for_time_zone #=> Boolean
|
1714
|
+
# resp.geolocation_format #=> String
|
1556
1715
|
# resp.data_source.s3_config.path #=> String
|
1557
1716
|
# resp.data_source.s3_config.role_arn #=> String
|
1558
1717
|
# resp.data_source.s3_config.kms_key_arn #=> String
|
@@ -1817,6 +1976,63 @@ module Aws::ForecastService
|
|
1817
1976
|
req.send_request(options)
|
1818
1977
|
end
|
1819
1978
|
|
1979
|
+
# Describes a predictor backtest export job created using the
|
1980
|
+
# CreatePredictorBacktestExportJob operation.
|
1981
|
+
#
|
1982
|
+
# In addition to listing the properties provided by the user in the
|
1983
|
+
# `CreatePredictorBacktestExportJob` request, this operation lists the
|
1984
|
+
# following properties:
|
1985
|
+
#
|
1986
|
+
# * `CreationTime`
|
1987
|
+
#
|
1988
|
+
# * `LastModificationTime`
|
1989
|
+
#
|
1990
|
+
# * `Status`
|
1991
|
+
#
|
1992
|
+
# * `Message` (if an error occurred)
|
1993
|
+
#
|
1994
|
+
# @option params [required, String] :predictor_backtest_export_job_arn
|
1995
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1996
|
+
#
|
1997
|
+
# @return [Types::DescribePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1998
|
+
#
|
1999
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
|
2000
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_name #predictor_backtest_export_job_name} => String
|
2001
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_arn #predictor_arn} => String
|
2002
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#destination #destination} => Types::DataDestination
|
2003
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#message #message} => String
|
2004
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#status #status} => String
|
2005
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#creation_time #creation_time} => Time
|
2006
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#last_modification_time #last_modification_time} => Time
|
2007
|
+
#
|
2008
|
+
# @example Request syntax with placeholder values
|
2009
|
+
#
|
2010
|
+
# resp = client.describe_predictor_backtest_export_job({
|
2011
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
2012
|
+
# })
|
2013
|
+
#
|
2014
|
+
# @example Response structure
|
2015
|
+
#
|
2016
|
+
# resp.predictor_backtest_export_job_arn #=> String
|
2017
|
+
# resp.predictor_backtest_export_job_name #=> String
|
2018
|
+
# resp.predictor_arn #=> String
|
2019
|
+
# resp.destination.s3_config.path #=> String
|
2020
|
+
# resp.destination.s3_config.role_arn #=> String
|
2021
|
+
# resp.destination.s3_config.kms_key_arn #=> String
|
2022
|
+
# resp.message #=> String
|
2023
|
+
# resp.status #=> String
|
2024
|
+
# resp.creation_time #=> Time
|
2025
|
+
# resp.last_modification_time #=> Time
|
2026
|
+
#
|
2027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob AWS API Documentation
|
2028
|
+
#
|
2029
|
+
# @overload describe_predictor_backtest_export_job(params = {})
|
2030
|
+
# @param [Hash] params ({})
|
2031
|
+
def describe_predictor_backtest_export_job(params = {}, options = {})
|
2032
|
+
req = build_request(:describe_predictor_backtest_export_job, params)
|
2033
|
+
req.send_request(options)
|
2034
|
+
end
|
2035
|
+
|
1820
2036
|
# Provides metrics on the accuracy of the models that were trained by
|
1821
2037
|
# the CreatePredictor operation. Use metrics to see how well the model
|
1822
2038
|
# performed and to decide whether to use the predictor to generate a
|
@@ -2227,6 +2443,86 @@ module Aws::ForecastService
|
|
2227
2443
|
req.send_request(options)
|
2228
2444
|
end
|
2229
2445
|
|
2446
|
+
# Returns a list of predictor backtest export jobs created using the
|
2447
|
+
# CreatePredictorBacktestExportJob operation. This operation returns a
|
2448
|
+
# summary for each backtest export job. You can filter the list using an
|
2449
|
+
# array of Filter objects.
|
2450
|
+
#
|
2451
|
+
# To retrieve the complete set of properties for a particular backtest
|
2452
|
+
# export job, use the ARN with the DescribePredictorBacktestExportJob
|
2453
|
+
# operation.
|
2454
|
+
#
|
2455
|
+
# @option params [String] :next_token
|
2456
|
+
# If the result of the previous request was truncated, the response
|
2457
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
2458
|
+
# token in the next request. Tokens expire after 24 hours.
|
2459
|
+
#
|
2460
|
+
# @option params [Integer] :max_results
|
2461
|
+
# The number of items to return in the response.
|
2462
|
+
#
|
2463
|
+
# @option params [Array<Types::Filter>] :filters
|
2464
|
+
# An array of filters. For each filter, provide a condition and a match
|
2465
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
2466
|
+
# whether to include or exclude the predictor backtest export jobs that
|
2467
|
+
# match the statement from the list. The match statement consists of a
|
2468
|
+
# key and a value.
|
2469
|
+
#
|
2470
|
+
# **Filter properties**
|
2471
|
+
#
|
2472
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
2473
|
+
# `IS_NOT`. To include the predictor backtest export jobs that match
|
2474
|
+
# the statement, specify `IS`. To exclude matching predictor backtest
|
2475
|
+
# export jobs, specify `IS_NOT`.
|
2476
|
+
#
|
2477
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
2478
|
+
# `PredictorArn` and `Status`.
|
2479
|
+
#
|
2480
|
+
# * `Value` - The value to match.
|
2481
|
+
#
|
2482
|
+
# @return [Types::ListPredictorBacktestExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2483
|
+
#
|
2484
|
+
# * {Types::ListPredictorBacktestExportJobsResponse#predictor_backtest_export_jobs #predictor_backtest_export_jobs} => Array<Types::PredictorBacktestExportJobSummary>
|
2485
|
+
# * {Types::ListPredictorBacktestExportJobsResponse#next_token #next_token} => String
|
2486
|
+
#
|
2487
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2488
|
+
#
|
2489
|
+
# @example Request syntax with placeholder values
|
2490
|
+
#
|
2491
|
+
# resp = client.list_predictor_backtest_export_jobs({
|
2492
|
+
# next_token: "NextToken",
|
2493
|
+
# max_results: 1,
|
2494
|
+
# filters: [
|
2495
|
+
# {
|
2496
|
+
# key: "String", # required
|
2497
|
+
# value: "Arn", # required
|
2498
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2499
|
+
# },
|
2500
|
+
# ],
|
2501
|
+
# })
|
2502
|
+
#
|
2503
|
+
# @example Response structure
|
2504
|
+
#
|
2505
|
+
# resp.predictor_backtest_export_jobs #=> Array
|
2506
|
+
# resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_arn #=> String
|
2507
|
+
# resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_name #=> String
|
2508
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.path #=> String
|
2509
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.role_arn #=> String
|
2510
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.kms_key_arn #=> String
|
2511
|
+
# resp.predictor_backtest_export_jobs[0].status #=> String
|
2512
|
+
# resp.predictor_backtest_export_jobs[0].message #=> String
|
2513
|
+
# resp.predictor_backtest_export_jobs[0].creation_time #=> Time
|
2514
|
+
# resp.predictor_backtest_export_jobs[0].last_modification_time #=> Time
|
2515
|
+
# resp.next_token #=> String
|
2516
|
+
#
|
2517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs AWS API Documentation
|
2518
|
+
#
|
2519
|
+
# @overload list_predictor_backtest_export_jobs(params = {})
|
2520
|
+
# @param [Hash] params ({})
|
2521
|
+
def list_predictor_backtest_export_jobs(params = {}, options = {})
|
2522
|
+
req = build_request(:list_predictor_backtest_export_jobs, params)
|
2523
|
+
req.send_request(options)
|
2524
|
+
end
|
2525
|
+
|
2230
2526
|
# Returns a list of predictors created using the CreatePredictor
|
2231
2527
|
# operation. For each predictor, this operation returns a summary of its
|
2232
2528
|
# properties, including its Amazon Resource Name (ARN). You can retrieve
|
@@ -2341,6 +2637,48 @@ module Aws::ForecastService
|
|
2341
2637
|
req.send_request(options)
|
2342
2638
|
end
|
2343
2639
|
|
2640
|
+
# Stops a resource.
|
2641
|
+
#
|
2642
|
+
# The resource undergoes the following states: `CREATE_STOPPING` and
|
2643
|
+
# `CREATE_STOPPED`. You cannot resume a resource once it has been
|
2644
|
+
# stopped.
|
2645
|
+
#
|
2646
|
+
# This operation can be applied to the following resources (and their
|
2647
|
+
# corresponding child resources):
|
2648
|
+
#
|
2649
|
+
# * Dataset Import Job
|
2650
|
+
#
|
2651
|
+
# * Predictor Job
|
2652
|
+
#
|
2653
|
+
# * Forecast Job
|
2654
|
+
#
|
2655
|
+
# * Forecast Export Job
|
2656
|
+
#
|
2657
|
+
# * Predictor Backtest Export Job
|
2658
|
+
#
|
2659
|
+
# @option params [required, String] :resource_arn
|
2660
|
+
# The Amazon Resource Name (ARN) that identifies the resource to stop.
|
2661
|
+
# The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
|
2662
|
+
# `PredictorBacktestExportJobArn`, `ForecastArn`, and
|
2663
|
+
# `ForecastExportJobArn`.
|
2664
|
+
#
|
2665
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2666
|
+
#
|
2667
|
+
# @example Request syntax with placeholder values
|
2668
|
+
#
|
2669
|
+
# resp = client.stop_resource({
|
2670
|
+
# resource_arn: "Arn", # required
|
2671
|
+
# })
|
2672
|
+
#
|
2673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource AWS API Documentation
|
2674
|
+
#
|
2675
|
+
# @overload stop_resource(params = {})
|
2676
|
+
# @param [Hash] params ({})
|
2677
|
+
def stop_resource(params = {}, options = {})
|
2678
|
+
req = build_request(:stop_resource, params)
|
2679
|
+
req.send_request(options)
|
2680
|
+
end
|
2681
|
+
|
2344
2682
|
# Associates the specified tags to a resource with the specified
|
2345
2683
|
# `resourceArn`. If existing tags on a resource are not specified in the
|
2346
2684
|
# request parameters, they are not changed. When a resource is deleted,
|
@@ -2480,7 +2818,7 @@ module Aws::ForecastService
|
|
2480
2818
|
params: params,
|
2481
2819
|
config: config)
|
2482
2820
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2483
|
-
context[:gem_version] = '1.
|
2821
|
+
context[:gem_version] = '1.17.0'
|
2484
2822
|
Seahorse::Client::Request.new(handlers, context)
|
2485
2823
|
end
|
2486
2824
|
|