aws-sdk-forecastqueryservice 1.21.0 → 1.22.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bfe49d460655e3ba0b86571e4f8a63ab852640e8d3022a4440894439b2b569ac
|
4
|
+
data.tar.gz: 200d73896a9baef7db8e768aa38eaab867b0c3696e5d7432cf39ff20540424cc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c586ff15845a279c928e8debeea03f58b8572108aec08f0e6f7de294ee03761faa85d5a446d918a5ff95202cb664b364f6e784831f364999d96741cca720fe7e
|
7
|
+
data.tar.gz: 2209e98cee587f64cb7b726261c0215626c95f26ba0772dd9d8dab551aab1d3b2f4eed24c1ec52fd9d6c8a4730212d4d58f6a0da8832b5092f8b33ca42149c81
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.22.0
|
@@ -448,6 +448,72 @@ module Aws::ForecastQueryService
|
|
448
448
|
req.send_request(options)
|
449
449
|
end
|
450
450
|
|
451
|
+
# Retrieves a what-if forecast.
|
452
|
+
#
|
453
|
+
# @option params [required, String] :what_if_forecast_arn
|
454
|
+
# The Amazon Resource Name (ARN) of the what-if forecast to query.
|
455
|
+
#
|
456
|
+
# @option params [String] :start_date
|
457
|
+
# The start date for the what-if forecast. Specify the date using this
|
458
|
+
# format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
|
459
|
+
# 2015-01-01T08:00:00.
|
460
|
+
#
|
461
|
+
# @option params [String] :end_date
|
462
|
+
# The end date for the what-if forecast. Specify the date using this
|
463
|
+
# format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
|
464
|
+
# 2015-01-01T20:00:00.
|
465
|
+
#
|
466
|
+
# @option params [required, Hash<String,String>] :filters
|
467
|
+
# The filtering criteria to apply when retrieving the forecast. For
|
468
|
+
# example, to get the forecast for `client_21` in the electricity usage
|
469
|
+
# dataset, specify the following:
|
470
|
+
#
|
471
|
+
# `\{"item_id" : "client_21"\}`
|
472
|
+
#
|
473
|
+
# To get the full what-if forecast, use the [CreateForecastExportJob][1]
|
474
|
+
# operation.
|
475
|
+
#
|
476
|
+
#
|
477
|
+
#
|
478
|
+
# [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html
|
479
|
+
#
|
480
|
+
# @option params [String] :next_token
|
481
|
+
# If the result of the previous request was truncated, the response
|
482
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
483
|
+
# token in the next request. Tokens expire after 24 hours.
|
484
|
+
#
|
485
|
+
# @return [Types::QueryWhatIfForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
486
|
+
#
|
487
|
+
# * {Types::QueryWhatIfForecastResponse#forecast #forecast} => Types::Forecast
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
#
|
491
|
+
# resp = client.query_what_if_forecast({
|
492
|
+
# what_if_forecast_arn: "LongArn", # required
|
493
|
+
# start_date: "DateTime",
|
494
|
+
# end_date: "DateTime",
|
495
|
+
# filters: { # required
|
496
|
+
# "AttributeName" => "AttributeValue",
|
497
|
+
# },
|
498
|
+
# next_token: "NextToken",
|
499
|
+
# })
|
500
|
+
#
|
501
|
+
# @example Response structure
|
502
|
+
#
|
503
|
+
# resp.forecast.predictions #=> Hash
|
504
|
+
# resp.forecast.predictions["Statistic"] #=> Array
|
505
|
+
# resp.forecast.predictions["Statistic"][0].timestamp #=> String
|
506
|
+
# resp.forecast.predictions["Statistic"][0].value #=> Float
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast AWS API Documentation
|
509
|
+
#
|
510
|
+
# @overload query_what_if_forecast(params = {})
|
511
|
+
# @param [Hash] params ({})
|
512
|
+
def query_what_if_forecast(params = {}, options = {})
|
513
|
+
req = build_request(:query_what_if_forecast, params)
|
514
|
+
req.send_request(options)
|
515
|
+
end
|
516
|
+
|
451
517
|
# @!endgroup
|
452
518
|
|
453
519
|
# @param params ({})
|
@@ -461,7 +527,7 @@ module Aws::ForecastQueryService
|
|
461
527
|
params: params,
|
462
528
|
config: config)
|
463
529
|
context[:gem_name] = 'aws-sdk-forecastqueryservice'
|
464
|
-
context[:gem_version] = '1.
|
530
|
+
context[:gem_version] = '1.22.0'
|
465
531
|
Seahorse::Client::Request.new(handlers, context)
|
466
532
|
end
|
467
533
|
|
@@ -25,10 +25,13 @@ module Aws::ForecastQueryService
|
|
25
25
|
InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
|
26
26
|
InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
|
27
27
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
28
|
+
LongArn = Shapes::StringShape.new(name: 'LongArn')
|
28
29
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
29
30
|
Predictions = Shapes::MapShape.new(name: 'Predictions')
|
30
31
|
QueryForecastRequest = Shapes::StructureShape.new(name: 'QueryForecastRequest')
|
31
32
|
QueryForecastResponse = Shapes::StructureShape.new(name: 'QueryForecastResponse')
|
33
|
+
QueryWhatIfForecastRequest = Shapes::StructureShape.new(name: 'QueryWhatIfForecastRequest')
|
34
|
+
QueryWhatIfForecastResponse = Shapes::StructureShape.new(name: 'QueryWhatIfForecastResponse')
|
32
35
|
ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
|
33
36
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
34
37
|
Statistic = Shapes::StringShape.new(name: 'Statistic')
|
@@ -67,6 +70,16 @@ module Aws::ForecastQueryService
|
|
67
70
|
QueryForecastResponse.add_member(:forecast, Shapes::ShapeRef.new(shape: Forecast, location_name: "Forecast"))
|
68
71
|
QueryForecastResponse.struct_class = Types::QueryForecastResponse
|
69
72
|
|
73
|
+
QueryWhatIfForecastRequest.add_member(:what_if_forecast_arn, Shapes::ShapeRef.new(shape: LongArn, required: true, location_name: "WhatIfForecastArn"))
|
74
|
+
QueryWhatIfForecastRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: DateTime, location_name: "StartDate"))
|
75
|
+
QueryWhatIfForecastRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: DateTime, location_name: "EndDate"))
|
76
|
+
QueryWhatIfForecastRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, required: true, location_name: "Filters"))
|
77
|
+
QueryWhatIfForecastRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
78
|
+
QueryWhatIfForecastRequest.struct_class = Types::QueryWhatIfForecastRequest
|
79
|
+
|
80
|
+
QueryWhatIfForecastResponse.add_member(:forecast, Shapes::ShapeRef.new(shape: Forecast, location_name: "Forecast"))
|
81
|
+
QueryWhatIfForecastResponse.struct_class = Types::QueryWhatIfForecastResponse
|
82
|
+
|
70
83
|
ResourceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
71
84
|
ResourceInUseException.struct_class = Types::ResourceInUseException
|
72
85
|
|
@@ -106,6 +119,19 @@ module Aws::ForecastQueryService
|
|
106
119
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
107
120
|
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
108
121
|
end)
|
122
|
+
|
123
|
+
api.add_operation(:query_what_if_forecast, Seahorse::Model::Operation.new.tap do |o|
|
124
|
+
o.name = "QueryWhatIfForecast"
|
125
|
+
o.http_method = "POST"
|
126
|
+
o.http_request_uri = "/"
|
127
|
+
o.input = Shapes::ShapeRef.new(shape: QueryWhatIfForecastRequest)
|
128
|
+
o.output = Shapes::ShapeRef.new(shape: QueryWhatIfForecastResponse)
|
129
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
130
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
131
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
132
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
133
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
134
|
+
end)
|
109
135
|
end
|
110
136
|
|
111
137
|
end
|
@@ -43,6 +43,15 @@ module Aws::ForecastQueryService
|
|
43
43
|
# * p50
|
44
44
|
#
|
45
45
|
# * p90
|
46
|
+
#
|
47
|
+
# The default setting is `["0.1", "0.5", "0.9"]`. Use the optional
|
48
|
+
# `ForecastTypes` parameter of the [CreateForecast][1] operation to
|
49
|
+
# change the values. The values will vary depending on how this is
|
50
|
+
# set, with a minimum of `1` and a maximum of `5.`
|
51
|
+
#
|
52
|
+
#
|
53
|
+
#
|
54
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html
|
46
55
|
# @return [Hash<String,Array<Types::DataPoint>>]
|
47
56
|
#
|
48
57
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/Forecast AWS API Documentation
|
@@ -166,6 +175,81 @@ module Aws::ForecastQueryService
|
|
166
175
|
include Aws::Structure
|
167
176
|
end
|
168
177
|
|
178
|
+
# @note When making an API call, you may pass QueryWhatIfForecastRequest
|
179
|
+
# data as a hash:
|
180
|
+
#
|
181
|
+
# {
|
182
|
+
# what_if_forecast_arn: "LongArn", # required
|
183
|
+
# start_date: "DateTime",
|
184
|
+
# end_date: "DateTime",
|
185
|
+
# filters: { # required
|
186
|
+
# "AttributeName" => "AttributeValue",
|
187
|
+
# },
|
188
|
+
# next_token: "NextToken",
|
189
|
+
# }
|
190
|
+
#
|
191
|
+
# @!attribute [rw] what_if_forecast_arn
|
192
|
+
# The Amazon Resource Name (ARN) of the what-if forecast to query.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] start_date
|
196
|
+
# The start date for the what-if forecast. Specify the date using this
|
197
|
+
# format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
|
198
|
+
# 2015-01-01T08:00:00.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] end_date
|
202
|
+
# The end date for the what-if forecast. Specify the date using this
|
203
|
+
# format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
|
204
|
+
# 2015-01-01T20:00:00.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] filters
|
208
|
+
# The filtering criteria to apply when retrieving the forecast. For
|
209
|
+
# example, to get the forecast for `client_21` in the electricity
|
210
|
+
# usage dataset, specify the following:
|
211
|
+
#
|
212
|
+
# `\{"item_id" : "client_21"\}`
|
213
|
+
#
|
214
|
+
# To get the full what-if forecast, use the
|
215
|
+
# [CreateForecastExportJob][1] operation.
|
216
|
+
#
|
217
|
+
#
|
218
|
+
#
|
219
|
+
# [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html
|
220
|
+
# @return [Hash<String,String>]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] next_token
|
223
|
+
# If the result of the previous request was truncated, the response
|
224
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
225
|
+
# token in the next request. Tokens expire after 24 hours.
|
226
|
+
# @return [String]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecastRequest AWS API Documentation
|
229
|
+
#
|
230
|
+
class QueryWhatIfForecastRequest < Struct.new(
|
231
|
+
:what_if_forecast_arn,
|
232
|
+
:start_date,
|
233
|
+
:end_date,
|
234
|
+
:filters,
|
235
|
+
:next_token)
|
236
|
+
SENSITIVE = []
|
237
|
+
include Aws::Structure
|
238
|
+
end
|
239
|
+
|
240
|
+
# @!attribute [rw] forecast
|
241
|
+
# Provides information about a forecast. Returned as part of the
|
242
|
+
# QueryForecast response.
|
243
|
+
# @return [Types::Forecast]
|
244
|
+
#
|
245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecastResponse AWS API Documentation
|
246
|
+
#
|
247
|
+
class QueryWhatIfForecastResponse < Struct.new(
|
248
|
+
:forecast)
|
249
|
+
SENSITIVE = []
|
250
|
+
include Aws::Structure
|
251
|
+
end
|
252
|
+
|
169
253
|
# The specified resource is in use.
|
170
254
|
#
|
171
255
|
# @!attribute [rw] message
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-forecastqueryservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.22.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|