Class: Aws::ForecastService::Types::TimeAlignmentBoundary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-forecastservice/types.rb

Overview

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].

For more information about aggregation, see [Data Aggregation for Different Forecast Frequencies]. For more information setting a custom time boundary, see [Specifying a Time Boundary].

[1]: docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries [2]: docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html [3]: docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#day_of_monthInteger

The day of the month to use for time alignment during aggregation.

Returns:

  • (Integer)


6723
6724
6725
6726
6727
6728
6729
6730
# File 'lib/aws-sdk-forecastservice/types.rb', line 6723

class TimeAlignmentBoundary < Struct.new(
  :month,
  :day_of_month,
  :day_of_week,
  :hour)
  SENSITIVE = []
  include Aws::Structure
end

#day_of_weekString

The day of week to use for time alignment during aggregation. The day must be in uppercase.

Returns:

  • (String)


6723
6724
6725
6726
6727
6728
6729
6730
# File 'lib/aws-sdk-forecastservice/types.rb', line 6723

class TimeAlignmentBoundary < Struct.new(
  :month,
  :day_of_month,
  :day_of_week,
  :hour)
  SENSITIVE = []
  include Aws::Structure
end

#hourInteger

The hour of day to use for time alignment during aggregation.

Returns:

  • (Integer)


6723
6724
6725
6726
6727
6728
6729
6730
# File 'lib/aws-sdk-forecastservice/types.rb', line 6723

class TimeAlignmentBoundary < Struct.new(
  :month,
  :day_of_month,
  :day_of_week,
  :hour)
  SENSITIVE = []
  include Aws::Structure
end

#monthString

The month to use for time alignment during aggregation. The month must be in uppercase.

Returns:

  • (String)


6723
6724
6725
6726
6727
6728
6729
6730
# File 'lib/aws-sdk-forecastservice/types.rb', line 6723

class TimeAlignmentBoundary < Struct.new(
  :month,
  :day_of_month,
  :day_of_week,
  :hour)
  SENSITIVE = []
  include Aws::Structure
end