Amazonka.Forecast.Types.TimeAlignmentBoundary

Documentation

data TimeAlignmentBoundary

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: newTimeAlignmentBoundary smart constructor.

Constructors

TimeAlignmentBoundary'

Fields

• dayOfMonth :: Maybe Natural

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

• dayOfWeek :: Maybe DayOfWeek

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

• hour :: Maybe Natural

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

• month :: Maybe Month

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

Instances

FromJSON TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

parseJSON :: Value -> Parser TimeAlignmentBoundary

parseJSONList :: Value -> Parser [TimeAlignmentBoundary]

ToJSON TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

toJSON :: TimeAlignmentBoundary -> Value

toEncoding :: TimeAlignmentBoundary -> Encoding

toJSONList :: [TimeAlignmentBoundary] -> Value

toEncodingList :: [TimeAlignmentBoundary] -> Encoding

Generic TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Associated Types

type Rep TimeAlignmentBoundary :: Type -> Type

Methods

from :: TimeAlignmentBoundary -> Rep TimeAlignmentBoundary x

to :: Rep TimeAlignmentBoundary x -> TimeAlignmentBoundary

Read TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

readsPrec :: Int -> ReadS TimeAlignmentBoundary

readList :: ReadS [TimeAlignmentBoundary]

readPrec :: ReadPrec TimeAlignmentBoundary

readListPrec :: ReadPrec [TimeAlignmentBoundary]

Show TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

showsPrec :: Int -> TimeAlignmentBoundary -> ShowS

show :: TimeAlignmentBoundary -> String

showList :: [TimeAlignmentBoundary] -> ShowS

NFData TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

rnf :: TimeAlignmentBoundary -> ()

Eq TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

(==) :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool

(/=) :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool

Hashable TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

Methods

hashWithSalt :: Int -> TimeAlignmentBoundary -> Int

hash :: TimeAlignmentBoundary -> Int

type Rep TimeAlignmentBoundary

Defined in Amazonka.Forecast.Types.TimeAlignmentBoundary

type Rep TimeAlignmentBoundary = D1 ('MetaData "TimeAlignmentBoundary" "Amazonka.Forecast.Types.TimeAlignmentBoundary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "TimeAlignmentBoundary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dayOfMonth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "dayOfWeek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DayOfWeek))) :*: (S1 ('MetaSel ('Just "hour") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "month") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Month)))))

newTimeAlignmentBoundary :: TimeAlignmentBoundary

Create a value of TimeAlignmentBoundary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dayOfMonth:TimeAlignmentBoundary', timeAlignmentBoundary_dayOfMonth - The day of the month to use for time alignment during aggregation.

$sel:dayOfWeek:TimeAlignmentBoundary', timeAlignmentBoundary_dayOfWeek - The day of week to use for time alignment during aggregation. The day must be in uppercase.

$sel:hour:TimeAlignmentBoundary', timeAlignmentBoundary_hour - The hour of day to use for time alignment during aggregation.

$sel:month:TimeAlignmentBoundary', timeAlignmentBoundary_month - The month to use for time alignment during aggregation. The month must be in uppercase.

timeAlignmentBoundary_dayOfMonth :: Lens' TimeAlignmentBoundary (Maybe Natural)

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

timeAlignmentBoundary_dayOfWeek :: Lens' TimeAlignmentBoundary (Maybe DayOfWeek)

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

timeAlignmentBoundary_hour :: Lens' TimeAlignmentBoundary (Maybe Natural)

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

timeAlignmentBoundary_month :: Lens' TimeAlignmentBoundary (Maybe Month)

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