libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSiteWise.Types.TumblingWindow

Description

 
Synopsis

Documentation

data TumblingWindow Source #

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You use this window in metrics to aggregate data from properties and other assets.

You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, and w represents weeks. You can also use s to represent seconds in offset.

The interval and offset parameters support the ISO 8601 format. For example, PT5S represents five seconds, PT5M represents five minutes, and PT5H represents five hours.

See: newTumblingWindow smart constructor.

Constructors

TumblingWindow' 

Fields

  • offset :: Maybe Text

    The offset for the tumbling window. The offset parameter accepts the following:

    • The offset time.

      For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

      • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
      • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

    • The ISO 8601 format.

      For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

      • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
      • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

    • The 24-hour clock.

      For example, if you specify 00:03:00 for offset and 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

    • The offset time zone.

      For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

      • If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
      • If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
  • interval :: Text

    The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

    IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

    When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

Instances

Instances details
Eq TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

(==) :: TumblingWindow -> TumblingWindow -> Bool #

(/=) :: TumblingWindow -> TumblingWindow -> Bool #

Read TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

readsPrec :: Int -> ReadS TumblingWindow #

readList :: ReadS [TumblingWindow] #

readPrec :: ReadPrec TumblingWindow #

readListPrec :: ReadPrec [TumblingWindow] #

Show TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

showsPrec :: Int -> TumblingWindow -> ShowS #

show :: TumblingWindow -> String #

showList :: [TumblingWindow] -> ShowS #

Generic TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Associated Types

type Rep TumblingWindow :: Type -> Type #

Methods

from :: TumblingWindow -> Rep TumblingWindow x #

to :: Rep TumblingWindow x -> TumblingWindow #

NFData TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

rnf :: TumblingWindow -> () #

Hashable TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

hashWithSalt :: Int -> TumblingWindow -> Int #

hash :: TumblingWindow -> Int #

ToJSON TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

toJSON :: TumblingWindow -> Value #

toEncoding :: TumblingWindow -> Encoding #

toJSONList :: [TumblingWindow] -> Value #

toEncodingList :: [TumblingWindow] -> Encoding #

FromJSON TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

Methods

parseJSON :: Value -> Parser TumblingWindow #

parseJSONList :: Value -> Parser [TumblingWindow] #

type Rep TumblingWindow Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.TumblingWindow

type Rep TumblingWindow = D1 ('MetaData "TumblingWindow" "Amazonka.IoTSiteWise.Types.TumblingWindow" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "TumblingWindow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTumblingWindow Source #

Arguments

:: Text

$sel:interval:TumblingWindow'

-> TumblingWindow 

Create a value of TumblingWindow 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:offset:TumblingWindow', tumblingWindow_offset - The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

    For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The ISO 8601 format.

    For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The 24-hour clock.

    For example, if you specify 00:03:00 for offset and 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

    For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
    • If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

$sel:interval:TumblingWindow', tumblingWindow_interval - The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

tumblingWindow_offset :: Lens' TumblingWindow (Maybe Text) Source #

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

    For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The ISO 8601 format.

    For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The 24-hour clock.

    For example, if you specify 00:03:00 for offset and 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

    For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
    • If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

tumblingWindow_interval :: Lens' TumblingWindow Text Source #

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.