aws-sdk-forecastservice 1.34.0 → 1.35.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: c50cef6489273243959819b7bb9f17cc3c373fe1d187a3540742a1727266f86f
4
- data.tar.gz: 87d76aa60e0e3f3e35f62cdce1eb7f8ef53e26985497389a9a974746a7b2fa7c
3
+ metadata.gz: c0b1136c7b930b95a83619431c9eca4f2baee09e26037da8971b47b5f17264f3
4
+ data.tar.gz: 63913f9e8661e0c247adec9d3d4f2b39f96cdd2c9a8765de1a45778be60af89e
5
5
  SHA512:
6
- metadata.gz: 6b628a59e02990029a21f7a69b347b1d5fcbea96087f8a0d30b391cea598e6621578216afd4234b86dafaccf11b397a57af189901c716ebcade6d9f4796b5656
7
- data.tar.gz: de4812f719be8c7fd47b612c233852dbe200a0457f8e66dc114269877bc6fd4a29b6e56d7db2191f386cbdabcf93f83c7755097aa534e57b516cff395676cd35
6
+ metadata.gz: aedb6b600f47f158e9999298eba549c7731182bb64ab496c78a228d23a2257f5085f71b47bfcfe5659d4ca9ae78e5c0f75d1e04a4561565eaf875b26992f42b2
7
+ data.tar.gz: c303fe52fa855ebed5a89ace542b75f9f6de614f5181de66c6c3eb56b53baa9cdbb3c47b4afb853c8b73a9edf8181d774b29aa428e82f511794bd2f87fb5a5f8
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.35.0 (2022-05-26)
5
+ ------------------
6
+
7
+ * Feature - Introduced a new field in Auto Predictor as Time Alignment Boundary. It helps in aligning the timestamps generated during Forecast exports
8
+
4
9
  1.34.0 (2022-05-23)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.34.0
1
+ 1.35.0
@@ -511,6 +511,19 @@ module Aws::ForecastService
511
511
  #
512
512
  # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
513
513
  #
514
+ # @option params [Types::TimeAlignmentBoundary] :time_alignment_boundary
515
+ # The time boundary Forecast uses to align and aggregate any data that
516
+ # doesn't align with your forecast frequency. Provide the unit of time
517
+ # and the time boundary as a key value pair. For more information on
518
+ # specifying a time boundary, see [Specifying a Time Boundary][1]. If
519
+ # you don't provide a time boundary, Forecast uses a set of [Default
520
+ # Time Boundaries][2].
521
+ #
522
+ #
523
+ #
524
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
525
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
526
+ #
514
527
  # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
515
528
  #
516
529
  # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
@@ -558,6 +571,12 @@ module Aws::ForecastService
558
571
  # monitor_config: {
559
572
  # monitor_name: "Name", # required
560
573
  # },
574
+ # time_alignment_boundary: {
575
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
576
+ # day_of_month: 1,
577
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
578
+ # hour: 1,
579
+ # },
561
580
  # })
562
581
  #
563
582
  # @example Response structure
@@ -2350,6 +2369,7 @@ module Aws::ForecastService
2350
2369
  # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
2351
2370
  # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
2352
2371
  # * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo
2372
+ # * {Types::DescribeAutoPredictorResponse#time_alignment_boundary #time_alignment_boundary} => Types::TimeAlignmentBoundary
2353
2373
  #
2354
2374
  # @example Request syntax with placeholder values
2355
2375
  #
@@ -2393,6 +2413,10 @@ module Aws::ForecastService
2393
2413
  # resp.explainability_info.status #=> String
2394
2414
  # resp.monitor_info.monitor_arn #=> String
2395
2415
  # resp.monitor_info.status #=> String
2416
+ # resp.time_alignment_boundary.month #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
2417
+ # resp.time_alignment_boundary.day_of_month #=> Integer
2418
+ # resp.time_alignment_boundary.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
2419
+ # resp.time_alignment_boundary.hour #=> Integer
2396
2420
  #
2397
2421
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
2398
2422
  #
@@ -3692,8 +3716,8 @@ module Aws::ForecastService
3692
3716
  # events collected by the monitor resource during different windows of
3693
3717
  # time.
3694
3718
  #
3695
- # For information about monitoring see [Viewing Monitoring Results][1].
3696
- # For more information about retrieving monitoring results see [Viewing
3719
+ # For information about monitoring see predictor-monitoring. For more
3720
+ # information about retrieving monitoring results see [Viewing
3697
3721
  # Monitoring Results][1].
3698
3722
  #
3699
3723
  #
@@ -4269,7 +4293,7 @@ module Aws::ForecastService
4269
4293
  params: params,
4270
4294
  config: config)
4271
4295
  context[:gem_name] = 'aws-sdk-forecastservice'
4272
- context[:gem_version] = '1.34.0'
4296
+ context[:gem_version] = '1.35.0'
4273
4297
  Seahorse::Client::Request.new(handlers, context)
4274
4298
  end
4275
4299
 
@@ -62,6 +62,8 @@ module Aws::ForecastService
62
62
  DatasetSummary = Shapes::StructureShape.new(name: 'DatasetSummary')
63
63
  DatasetType = Shapes::StringShape.new(name: 'DatasetType')
64
64
  Datasets = Shapes::ListShape.new(name: 'Datasets')
65
+ DayOfMonth = Shapes::IntegerShape.new(name: 'DayOfMonth')
66
+ DayOfWeek = Shapes::StringShape.new(name: 'DayOfWeek')
65
67
  DeleteDatasetGroupRequest = Shapes::StructureShape.new(name: 'DeleteDatasetGroupRequest')
66
68
  DeleteDatasetImportJobRequest = Shapes::StructureShape.new(name: 'DeleteDatasetImportJobRequest')
67
69
  DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
@@ -134,6 +136,7 @@ module Aws::ForecastService
134
136
  GeolocationFormat = Shapes::StringShape.new(name: 'GeolocationFormat')
135
137
  GetAccuracyMetricsRequest = Shapes::StructureShape.new(name: 'GetAccuracyMetricsRequest')
136
138
  GetAccuracyMetricsResponse = Shapes::StructureShape.new(name: 'GetAccuracyMetricsResponse')
139
+ Hour = Shapes::IntegerShape.new(name: 'Hour')
137
140
  HyperParameterTuningJobConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobConfig')
138
141
  InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
139
142
  Integer = Shapes::IntegerShape.new(name: 'Integer')
@@ -180,6 +183,7 @@ module Aws::ForecastService
180
183
  MonitorInfo = Shapes::StructureShape.new(name: 'MonitorInfo')
181
184
  MonitorSummary = Shapes::StructureShape.new(name: 'MonitorSummary')
182
185
  Monitors = Shapes::ListShape.new(name: 'Monitors')
186
+ Month = Shapes::StringShape.new(name: 'Month')
183
187
  Name = Shapes::StringShape.new(name: 'Name')
184
188
  NextToken = Shapes::StringShape.new(name: 'NextToken')
185
189
  OptimizationMetric = Shapes::StringShape.new(name: 'OptimizationMetric')
@@ -226,6 +230,7 @@ module Aws::ForecastService
226
230
  TestWindowDetails = Shapes::ListShape.new(name: 'TestWindowDetails')
227
231
  TestWindowSummary = Shapes::StructureShape.new(name: 'TestWindowSummary')
228
232
  TestWindows = Shapes::ListShape.new(name: 'TestWindows')
233
+ TimeAlignmentBoundary = Shapes::StructureShape.new(name: 'TimeAlignmentBoundary')
229
234
  TimePointGranularity = Shapes::StringShape.new(name: 'TimePointGranularity')
230
235
  TimeSeriesGranularity = Shapes::StringShape.new(name: 'TimeSeriesGranularity')
231
236
  TimeZone = Shapes::StringShape.new(name: 'TimeZone')
@@ -296,6 +301,7 @@ module Aws::ForecastService
296
301
  CreateAutoPredictorRequest.add_member(:explain_predictor, Shapes::ShapeRef.new(shape: Boolean, location_name: "ExplainPredictor"))
297
302
  CreateAutoPredictorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
298
303
  CreateAutoPredictorRequest.add_member(:monitor_config, Shapes::ShapeRef.new(shape: MonitorConfig, location_name: "MonitorConfig"))
304
+ CreateAutoPredictorRequest.add_member(:time_alignment_boundary, Shapes::ShapeRef.new(shape: TimeAlignmentBoundary, location_name: "TimeAlignmentBoundary"))
299
305
  CreateAutoPredictorRequest.struct_class = Types::CreateAutoPredictorRequest
300
306
 
301
307
  CreateAutoPredictorResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
@@ -507,6 +513,7 @@ module Aws::ForecastService
507
513
  DescribeAutoPredictorResponse.add_member(:optimization_metric, Shapes::ShapeRef.new(shape: OptimizationMetric, location_name: "OptimizationMetric"))
508
514
  DescribeAutoPredictorResponse.add_member(:explainability_info, Shapes::ShapeRef.new(shape: ExplainabilityInfo, location_name: "ExplainabilityInfo"))
509
515
  DescribeAutoPredictorResponse.add_member(:monitor_info, Shapes::ShapeRef.new(shape: MonitorInfo, location_name: "MonitorInfo"))
516
+ DescribeAutoPredictorResponse.add_member(:time_alignment_boundary, Shapes::ShapeRef.new(shape: TimeAlignmentBoundary, location_name: "TimeAlignmentBoundary"))
510
517
  DescribeAutoPredictorResponse.struct_class = Types::DescribeAutoPredictorResponse
511
518
 
512
519
  DescribeDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetGroupArn"))
@@ -1094,6 +1101,12 @@ module Aws::ForecastService
1094
1101
 
1095
1102
  TestWindows.member = Shapes::ShapeRef.new(shape: WindowSummary)
1096
1103
 
1104
+ TimeAlignmentBoundary.add_member(:month, Shapes::ShapeRef.new(shape: Month, location_name: "Month"))
1105
+ TimeAlignmentBoundary.add_member(:day_of_month, Shapes::ShapeRef.new(shape: DayOfMonth, location_name: "DayOfMonth"))
1106
+ TimeAlignmentBoundary.add_member(:day_of_week, Shapes::ShapeRef.new(shape: DayOfWeek, location_name: "DayOfWeek"))
1107
+ TimeAlignmentBoundary.add_member(:hour, Shapes::ShapeRef.new(shape: Hour, location_name: "Hour"))
1108
+ TimeAlignmentBoundary.struct_class = Types::TimeAlignmentBoundary
1109
+
1097
1110
  TrainingParameters.key = Shapes::ShapeRef.new(shape: ParameterKey)
1098
1111
  TrainingParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
1099
1112
 
@@ -467,6 +467,12 @@ module Aws::ForecastService
467
467
  # monitor_config: {
468
468
  # monitor_name: "Name", # required
469
469
  # },
470
+ # time_alignment_boundary: {
471
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
472
+ # day_of_month: 1,
473
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
474
+ # hour: 1,
475
+ # },
470
476
  # }
471
477
  #
472
478
  # @!attribute [rw] predictor_name
@@ -594,6 +600,20 @@ module Aws::ForecastService
594
600
  # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
595
601
  # @return [Types::MonitorConfig]
596
602
  #
603
+ # @!attribute [rw] time_alignment_boundary
604
+ # The time boundary Forecast uses to align and aggregate any data that
605
+ # doesn't align with your forecast frequency. Provide the unit of
606
+ # time and the time boundary as a key value pair. For more information
607
+ # on specifying a time boundary, see [Specifying a Time Boundary][1].
608
+ # If you don't provide a time boundary, Forecast uses a set of
609
+ # [Default Time Boundaries][2].
610
+ #
611
+ #
612
+ #
613
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
614
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
615
+ # @return [Types::TimeAlignmentBoundary]
616
+ #
597
617
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
598
618
  #
599
619
  class CreateAutoPredictorRequest < Struct.new(
@@ -608,7 +628,8 @@ module Aws::ForecastService
608
628
  :optimization_metric,
609
629
  :explain_predictor,
610
630
  :tags,
611
- :monitor_config)
631
+ :monitor_config,
632
+ :time_alignment_boundary)
612
633
  SENSITIVE = []
613
634
  include Aws::Structure
614
635
  end
@@ -2499,6 +2520,10 @@ module Aws::ForecastService
2499
2520
  # monitor resource.
2500
2521
  # @return [Types::MonitorInfo]
2501
2522
  #
2523
+ # @!attribute [rw] time_alignment_boundary
2524
+ # The time boundary Forecast uses when aggregating data.
2525
+ # @return [Types::TimeAlignmentBoundary]
2526
+ #
2502
2527
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2503
2528
  #
2504
2529
  class DescribeAutoPredictorResponse < Struct.new(
@@ -2519,7 +2544,8 @@ module Aws::ForecastService
2519
2544
  :last_modification_time,
2520
2545
  :optimization_metric,
2521
2546
  :explainability_info,
2522
- :monitor_info)
2547
+ :monitor_info,
2548
+ :time_alignment_boundary)
2523
2549
  SENSITIVE = []
2524
2550
  include Aws::Structure
2525
2551
  end
@@ -5925,9 +5951,11 @@ module Aws::ForecastService
5925
5951
  # Describes the results of a monitor evaluation.
5926
5952
  #
5927
5953
  # @!attribute [rw] resource_arn
5954
+ # The Amazon Resource Name (ARN) of the resource to monitor.
5928
5955
  # @return [String]
5929
5956
  #
5930
5957
  # @!attribute [rw] monitor_arn
5958
+ # The Amazon Resource Name (ARN) of the monitor resource.
5931
5959
  # @return [String]
5932
5960
  #
5933
5961
  # @!attribute [rw] evaluation_time
@@ -6727,6 +6755,60 @@ module Aws::ForecastService
6727
6755
  include Aws::Structure
6728
6756
  end
6729
6757
 
6758
+ # The time boundary Forecast uses to align and aggregate your data to
6759
+ # match your forecast frequency. Provide the unit of time and the time
6760
+ # boundary as a key value pair. If you don't provide a time boundary,
6761
+ # Forecast uses a set of [Default Time Boundaries][1].
6762
+ #
6763
+ # For more information about aggregation, see [Data Aggregation for
6764
+ # Different Forecast Frequencies][2]. For more information setting a
6765
+ # custom time boundary, see [Specifying a Time Boundary][3].
6766
+ #
6767
+ #
6768
+ #
6769
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
6770
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html
6771
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
6772
+ #
6773
+ # @note When making an API call, you may pass TimeAlignmentBoundary
6774
+ # data as a hash:
6775
+ #
6776
+ # {
6777
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
6778
+ # day_of_month: 1,
6779
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
6780
+ # hour: 1,
6781
+ # }
6782
+ #
6783
+ # @!attribute [rw] month
6784
+ # The month to use for time alignment during aggregation. The month
6785
+ # must be in uppercase.
6786
+ # @return [String]
6787
+ #
6788
+ # @!attribute [rw] day_of_month
6789
+ # The day of the month to use for time alignment during aggregation.
6790
+ # @return [Integer]
6791
+ #
6792
+ # @!attribute [rw] day_of_week
6793
+ # The day of week to use for time alignment during aggregation. The
6794
+ # day must be in uppercase.
6795
+ # @return [String]
6796
+ #
6797
+ # @!attribute [rw] hour
6798
+ # The hour of day to use for time alignment during aggregation.
6799
+ # @return [Integer]
6800
+ #
6801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeAlignmentBoundary AWS API Documentation
6802
+ #
6803
+ class TimeAlignmentBoundary < Struct.new(
6804
+ :month,
6805
+ :day_of_month,
6806
+ :day_of_week,
6807
+ :hour)
6808
+ SENSITIVE = []
6809
+ include Aws::Structure
6810
+ end
6811
+
6730
6812
  # @note When making an API call, you may pass UntagResourceRequest
6731
6813
  # data as a hash:
6732
6814
  #
@@ -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.34.0'
51
+ GEM_VERSION = '1.35.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-forecastservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.34.0
4
+ version: 1.35.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-05-23 00:00:00.000000000 Z
11
+ date: 2022-05-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core