Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTSiteWise.Types.TimeSeriesSummary

Description

Synopsis

data TimeSeriesSummary = TimeSeriesSummary' {
- alias :: Maybe Text
- assetId :: Maybe Text
- dataTypeSpec :: Maybe Text
- propertyId :: Maybe Text
- timeSeriesId :: Text
- dataType :: PropertyDataType
- timeSeriesCreationDate :: POSIX
- timeSeriesLastUpdateDate :: POSIX
}
newTimeSeriesSummary :: Text -> PropertyDataType -> UTCTime -> UTCTime -> TimeSeriesSummary
timeSeriesSummary_alias :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_assetId :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_dataTypeSpec :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_propertyId :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_timeSeriesId :: Lens' TimeSeriesSummary Text
timeSeriesSummary_dataType :: Lens' TimeSeriesSummary PropertyDataType
timeSeriesSummary_timeSeriesCreationDate :: Lens' TimeSeriesSummary UTCTime
timeSeriesSummary_timeSeriesLastUpdateDate :: Lens' TimeSeriesSummary UTCTime

Documentation

data TimeSeriesSummary Source #

Contains a summary of a time series (data stream).

See: newTimeSeriesSummary smart constructor.

Constructors

TimeSeriesSummary'

Fields

alias :: Maybe Text
The alias that identifies the time series.
assetId :: Maybe Text
The ID of the asset in which the asset property was created.
dataTypeSpec :: Maybe Text
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
propertyId :: Maybe Text
The ID of the asset property.
timeSeriesId :: Text
The ID of the time series.
dataType :: PropertyDataType
The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.
timeSeriesCreationDate :: POSIX
The date that the time series was created, in Unix epoch time.
timeSeriesLastUpdateDate :: POSIX
The date that the time series was last updated, in Unix epoch time.

Instances

Instances details

FromJSON TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods parseJSON :: Value -> Parser TimeSeriesSummary # parseJSONList :: Value -> Parser [TimeSeriesSummary] #
Generic TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Associated Types type Rep TimeSeriesSummary :: Type -> Type # Methods from :: TimeSeriesSummary -> Rep TimeSeriesSummary x # to :: Rep TimeSeriesSummary x -> TimeSeriesSummary #
Read TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods readsPrec :: Int -> ReadS TimeSeriesSummary # readList :: ReadS [TimeSeriesSummary] # readPrec :: ReadPrec TimeSeriesSummary # readListPrec :: ReadPrec [TimeSeriesSummary] #
Show TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods showsPrec :: Int -> TimeSeriesSummary -> ShowS # show :: TimeSeriesSummary -> String # showList :: [TimeSeriesSummary] -> ShowS #
NFData TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods rnf :: TimeSeriesSummary -> () #
Eq TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods (==) :: TimeSeriesSummary -> TimeSeriesSummary -> Bool # (/=) :: TimeSeriesSummary -> TimeSeriesSummary -> Bool #
Hashable TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary Methods hashWithSalt :: Int -> TimeSeriesSummary -> Int # hash :: TimeSeriesSummary -> Int #
type Rep TimeSeriesSummary Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.TimeSeriesSummary type Rep TimeSeriesSummary = D1 ('MetaData "TimeSeriesSummary" "Amazonka.IoTSiteWise.Types.TimeSeriesSummary" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "TimeSeriesSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dataTypeSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "timeSeriesId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PropertyDataType)) :: (S1 ('MetaSel ('Just "timeSeriesCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "timeSeriesLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newTimeSeriesSummary Source #

Arguments

:: Text	`$sel:timeSeriesId:TimeSeriesSummary'`
-> PropertyDataType	`$sel:dataType:TimeSeriesSummary'`
-> UTCTime	`$sel:timeSeriesCreationDate:TimeSeriesSummary'`
-> UTCTime	`$sel:timeSeriesLastUpdateDate:TimeSeriesSummary'`
-> TimeSeriesSummary

Create a value of TimeSeriesSummary 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:alias:TimeSeriesSummary', timeSeriesSummary_alias - The alias that identifies the time series.

$sel:assetId:TimeSeriesSummary', timeSeriesSummary_assetId - The ID of the asset in which the asset property was created.

$sel:dataTypeSpec:TimeSeriesSummary', timeSeriesSummary_dataTypeSpec - The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

$sel:propertyId:TimeSeriesSummary', timeSeriesSummary_propertyId - The ID of the asset property.

$sel:timeSeriesId:TimeSeriesSummary', timeSeriesSummary_timeSeriesId - The ID of the time series.

$sel:dataType:TimeSeriesSummary', timeSeriesSummary_dataType - The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

$sel:timeSeriesCreationDate:TimeSeriesSummary', timeSeriesSummary_timeSeriesCreationDate - The date that the time series was created, in Unix epoch time.

$sel:timeSeriesLastUpdateDate:TimeSeriesSummary', timeSeriesSummary_timeSeriesLastUpdateDate - The date that the time series was last updated, in Unix epoch time.

timeSeriesSummary_alias :: Lens' TimeSeriesSummary (Maybe Text) Source #

The alias that identifies the time series.

timeSeriesSummary_assetId :: Lens' TimeSeriesSummary (Maybe Text) Source #

The ID of the asset in which the asset property was created.

timeSeriesSummary_dataTypeSpec :: Lens' TimeSeriesSummary (Maybe Text) Source #

The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

timeSeriesSummary_propertyId :: Lens' TimeSeriesSummary (Maybe Text) Source #

The ID of the asset property.

timeSeriesSummary_timeSeriesId :: Lens' TimeSeriesSummary Text Source #

The ID of the time series.

timeSeriesSummary_dataType :: Lens' TimeSeriesSummary PropertyDataType Source #

The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

timeSeriesSummary_timeSeriesCreationDate :: Lens' TimeSeriesSummary UTCTime Source #

The date that the time series was created, in Unix epoch time.

timeSeriesSummary_timeSeriesLastUpdateDate :: Lens' TimeSeriesSummary UTCTime Source #

The date that the time series was last updated, in Unix epoch time.