aws-sdk-forecastservice 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c50cef6489273243959819b7bb9f17cc3c373fe1d187a3540742a1727266f86f
-  data.tar.gz: 87d76aa60e0e3f3e35f62cdce1eb7f8ef53e26985497389a9a974746a7b2fa7c
+  metadata.gz: c0b1136c7b930b95a83619431c9eca4f2baee09e26037da8971b47b5f17264f3
+  data.tar.gz: 63913f9e8661e0c247adec9d3d4f2b39f96cdd2c9a8765de1a45778be60af89e
 SHA512:
-  metadata.gz: 6b628a59e02990029a21f7a69b347b1d5fcbea96087f8a0d30b391cea598e6621578216afd4234b86dafaccf11b397a57af189901c716ebcade6d9f4796b5656
-  data.tar.gz: de4812f719be8c7fd47b612c233852dbe200a0457f8e66dc114269877bc6fd4a29b6e56d7db2191f386cbdabcf93f83c7755097aa534e57b516cff395676cd35
+  metadata.gz: aedb6b600f47f158e9999298eba549c7731182bb64ab496c78a228d23a2257f5085f71b47bfcfe5659d4ca9ae78e5c0f75d1e04a4561565eaf875b26992f42b2
+  data.tar.gz: c303fe52fa855ebed5a89ace542b75f9f6de614f5181de66c6c3eb56b53baa9cdbb3c47b4afb853c8b73a9edf8181d774b29aa428e82f511794bd2f87fb5a5f8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.35.0 (2022-05-26)
+------------------
+
+* Feature - Introduced a new field in Auto Predictor as Time Alignment Boundary. It helps in aligning the timestamps generated during Forecast exports
+
 1.34.0 (2022-05-23)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.35.0

data/lib/aws-sdk-forecastservice/client.rb

@@ -511,6 +511,19 @@ module Aws::ForecastService
     #
     #   [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
     #
+    # @option params [Types::TimeAlignmentBoundary] :time_alignment_boundary
+    #   The time boundary Forecast uses to align and aggregate any data that
+    #   doesn't align with your forecast frequency. Provide the unit of time
+    #   and the time boundary as a key value pair. For more information on
+    #   specifying a time boundary, see [Specifying a Time Boundary][1]. If
+    #   you don't provide a time boundary, Forecast uses a set of [Default
+    #   Time Boundaries][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
+    #   [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
+    #
     # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
@@ -558,6 +571,12 @@ module Aws::ForecastService
     #     monitor_config: {
     #       monitor_name: "Name", # required
     #     },
+    #     time_alignment_boundary: {
+    #       month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
+    #       day_of_month: 1,
+    #       day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
+    #       hour: 1,
+    #     },
     #   })
     #
     # @example Response structure
@@ -2350,6 +2369,7 @@ module Aws::ForecastService
     #   * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
     #   * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
     #   * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo
+    #   * {Types::DescribeAutoPredictorResponse#time_alignment_boundary #time_alignment_boundary} => Types::TimeAlignmentBoundary
     #
     # @example Request syntax with placeholder values
     #
@@ -2393,6 +2413,10 @@ module Aws::ForecastService
     #   resp.explainability_info.status #=> String
     #   resp.monitor_info.monitor_arn #=> String
     #   resp.monitor_info.status #=> String
+    #   resp.time_alignment_boundary.month #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
+    #   resp.time_alignment_boundary.day_of_month #=> Integer
+    #   resp.time_alignment_boundary.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
+    #   resp.time_alignment_boundary.hour #=> Integer
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
     #
@@ -3692,8 +3716,8 @@ module Aws::ForecastService
     # events collected by the monitor resource during different windows of
     # time.
     #
-    # For information about monitoring see [Viewing Monitoring Results][1].
-    # For more information about retrieving monitoring results see [Viewing
+    # For information about monitoring see predictor-monitoring. For more
+    # information about retrieving monitoring results see [Viewing
     # Monitoring Results][1].
     #
     #
@@ -4269,7 +4293,7 @@ module Aws::ForecastService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastservice'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-forecastservice/client_api.rb

@@ -62,6 +62,8 @@ module Aws::ForecastService
     DatasetSummary = Shapes::StructureShape.new(name: 'DatasetSummary')
     DatasetType = Shapes::StringShape.new(name: 'DatasetType')
     Datasets = Shapes::ListShape.new(name: 'Datasets')
+    DayOfMonth = Shapes::IntegerShape.new(name: 'DayOfMonth')
+    DayOfWeek = Shapes::StringShape.new(name: 'DayOfWeek')
     DeleteDatasetGroupRequest = Shapes::StructureShape.new(name: 'DeleteDatasetGroupRequest')
     DeleteDatasetImportJobRequest = Shapes::StructureShape.new(name: 'DeleteDatasetImportJobRequest')
     DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
@@ -134,6 +136,7 @@ module Aws::ForecastService
     GeolocationFormat = Shapes::StringShape.new(name: 'GeolocationFormat')
     GetAccuracyMetricsRequest = Shapes::StructureShape.new(name: 'GetAccuracyMetricsRequest')
     GetAccuracyMetricsResponse = Shapes::StructureShape.new(name: 'GetAccuracyMetricsResponse')
+    Hour = Shapes::IntegerShape.new(name: 'Hour')
     HyperParameterTuningJobConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobConfig')
     InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
@@ -180,6 +183,7 @@ module Aws::ForecastService
     MonitorInfo = Shapes::StructureShape.new(name: 'MonitorInfo')
     MonitorSummary = Shapes::StructureShape.new(name: 'MonitorSummary')
     Monitors = Shapes::ListShape.new(name: 'Monitors')
+    Month = Shapes::StringShape.new(name: 'Month')
     Name = Shapes::StringShape.new(name: 'Name')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     OptimizationMetric = Shapes::StringShape.new(name: 'OptimizationMetric')
@@ -226,6 +230,7 @@ module Aws::ForecastService
     TestWindowDetails = Shapes::ListShape.new(name: 'TestWindowDetails')
     TestWindowSummary = Shapes::StructureShape.new(name: 'TestWindowSummary')
     TestWindows = Shapes::ListShape.new(name: 'TestWindows')
+    TimeAlignmentBoundary = Shapes::StructureShape.new(name: 'TimeAlignmentBoundary')
     TimePointGranularity = Shapes::StringShape.new(name: 'TimePointGranularity')
     TimeSeriesGranularity = Shapes::StringShape.new(name: 'TimeSeriesGranularity')
     TimeZone = Shapes::StringShape.new(name: 'TimeZone')
@@ -296,6 +301,7 @@ module Aws::ForecastService
     CreateAutoPredictorRequest.add_member(:explain_predictor, Shapes::ShapeRef.new(shape: Boolean, location_name: "ExplainPredictor"))
     CreateAutoPredictorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
     CreateAutoPredictorRequest.add_member(:monitor_config, Shapes::ShapeRef.new(shape: MonitorConfig, location_name: "MonitorConfig"))
+    CreateAutoPredictorRequest.add_member(:time_alignment_boundary, Shapes::ShapeRef.new(shape: TimeAlignmentBoundary, location_name: "TimeAlignmentBoundary"))
     CreateAutoPredictorRequest.struct_class = Types::CreateAutoPredictorRequest
 
     CreateAutoPredictorResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
@@ -507,6 +513,7 @@ module Aws::ForecastService
     DescribeAutoPredictorResponse.add_member(:optimization_metric, Shapes::ShapeRef.new(shape: OptimizationMetric, location_name: "OptimizationMetric"))
     DescribeAutoPredictorResponse.add_member(:explainability_info, Shapes::ShapeRef.new(shape: ExplainabilityInfo, location_name: "ExplainabilityInfo"))
     DescribeAutoPredictorResponse.add_member(:monitor_info, Shapes::ShapeRef.new(shape: MonitorInfo, location_name: "MonitorInfo"))
+    DescribeAutoPredictorResponse.add_member(:time_alignment_boundary, Shapes::ShapeRef.new(shape: TimeAlignmentBoundary, location_name: "TimeAlignmentBoundary"))
     DescribeAutoPredictorResponse.struct_class = Types::DescribeAutoPredictorResponse
 
     DescribeDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetGroupArn"))
@@ -1094,6 +1101,12 @@ module Aws::ForecastService
 
     TestWindows.member = Shapes::ShapeRef.new(shape: WindowSummary)
 
+    TimeAlignmentBoundary.add_member(:month, Shapes::ShapeRef.new(shape: Month, location_name: "Month"))
+    TimeAlignmentBoundary.add_member(:day_of_month, Shapes::ShapeRef.new(shape: DayOfMonth, location_name: "DayOfMonth"))
+    TimeAlignmentBoundary.add_member(:day_of_week, Shapes::ShapeRef.new(shape: DayOfWeek, location_name: "DayOfWeek"))
+    TimeAlignmentBoundary.add_member(:hour, Shapes::ShapeRef.new(shape: Hour, location_name: "Hour"))
+    TimeAlignmentBoundary.struct_class = Types::TimeAlignmentBoundary
+
     TrainingParameters.key = Shapes::ShapeRef.new(shape: ParameterKey)
     TrainingParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
 

data/lib/aws-sdk-forecastservice/types.rb

@@ -467,6 +467,12 @@ module Aws::ForecastService
     #         monitor_config: {
     #           monitor_name: "Name", # required
     #         },
+    #         time_alignment_boundary: {
+    #           month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
+    #           day_of_month: 1,
+    #           day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
+    #           hour: 1,
+    #         },
     #       }
     #
     # @!attribute [rw] predictor_name
@@ -594,6 +600,20 @@ module Aws::ForecastService
     #   [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
     #   @return [Types::MonitorConfig]
     #
+    # @!attribute [rw] time_alignment_boundary
+    #   The time boundary Forecast uses to align and aggregate any data that
+    #   doesn't align with your forecast frequency. Provide the unit of
+    #   time and the time boundary as a key value pair. For more information
+    #   on specifying a time boundary, see [Specifying a Time Boundary][1].
+    #   If you don't provide a time boundary, Forecast uses a set of
+    #   [Default Time Boundaries][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
+    #   [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
+    #   @return [Types::TimeAlignmentBoundary]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
     #
     class CreateAutoPredictorRequest < Struct.new(
@@ -608,7 +628,8 @@ module Aws::ForecastService
       :optimization_metric,
       :explain_predictor,
       :tags,
-      :monitor_config)
+      :monitor_config,
+      :time_alignment_boundary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2499,6 +2520,10 @@ module Aws::ForecastService
     #   monitor resource.
     #   @return [Types::MonitorInfo]
     #
+    # @!attribute [rw] time_alignment_boundary
+    #   The time boundary Forecast uses when aggregating data.
+    #   @return [Types::TimeAlignmentBoundary]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
     #
     class DescribeAutoPredictorResponse < Struct.new(
@@ -2519,7 +2544,8 @@ module Aws::ForecastService
       :last_modification_time,
       :optimization_metric,
       :explainability_info,
-      :monitor_info)
+      :monitor_info,
+      :time_alignment_boundary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -5925,9 +5951,11 @@ module Aws::ForecastService
     # Describes the results of a monitor evaluation.
     #
     # @!attribute [rw] resource_arn
+    #   The Amazon Resource Name (ARN) of the resource to monitor.
     #   @return [String]
     #
     # @!attribute [rw] monitor_arn
+    #   The Amazon Resource Name (ARN) of the monitor resource.
     #   @return [String]
     #
     # @!attribute [rw] evaluation_time
@@ -6727,6 +6755,60 @@ module Aws::ForecastService
       include Aws::Structure
     end
 
+    # The time boundary Forecast uses to align and aggregate your data to
+    # match your forecast frequency. Provide the unit of time and the time
+    # boundary as a key value pair. If you don't provide a time boundary,
+    # Forecast uses a set of [Default Time Boundaries][1].
+    #
+    # For more information about aggregation, see [Data Aggregation for
+    # Different Forecast Frequencies][2]. For more information setting a
+    # custom time boundary, see [Specifying a Time Boundary][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
+    # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html
+    # [3]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
+    #
+    # @note When making an API call, you may pass TimeAlignmentBoundary
+    #   data as a hash:
+    #
+    #       {
+    #         month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
+    #         day_of_month: 1,
+    #         day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
+    #         hour: 1,
+    #       }
+    #
+    # @!attribute [rw] month
+    #   The month to use for time alignment during aggregation. The month
+    #   must be in uppercase.
+    #   @return [String]
+    #
+    # @!attribute [rw] day_of_month
+    #   The day of the month to use for time alignment during aggregation.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] day_of_week
+    #   The day of week to use for time alignment during aggregation. The
+    #   day must be in uppercase.
+    #   @return [String]
+    #
+    # @!attribute [rw] hour
+    #   The hour of day to use for time alignment during aggregation.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeAlignmentBoundary AWS API Documentation
+    #
+    class TimeAlignmentBoundary < Struct.new(
+      :month,
+      :day_of_month,
+      :day_of_week,
+      :hour)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass UntagResourceRequest
     #   data as a hash:
     #

data/lib/aws-sdk-forecastservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
 # @!group service
 module Aws::ForecastService
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-forecastservice
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core