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

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

Overview

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,
}

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#day_of_month ⇒ Integer

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

Returns:

  • (Integer) 


6889
6890
6891
6892
6893
6894
6895
6896
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6889

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

#day_of_week ⇒ String

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

Returns:

  • (String) 


6889
6890
6891
6892
6893
6894
6895
6896
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6889

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

#hour ⇒ Integer

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

Returns:

  • (Integer) 


6889
6890
6891
6892
6893
6894
6895
6896
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6889

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

#month ⇒ String

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

Returns:

  • (String) 


6889
6890
6891
6892
6893
6894
6895
6896
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6889

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