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

Description

Synopsis

Documentation

data BatchGetAssetPropertyValueHistoryEntry Source #

Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.

To identify an asset property, you must specify one of the following:

The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

See: newBatchGetAssetPropertyValueHistoryEntry smart constructor.

Constructors

BatchGetAssetPropertyValueHistoryEntry'

Fields

assetId :: Maybe Text
The ID of the asset in which the asset property was created.
endDate :: Maybe POSIX
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
propertyAlias :: Maybe Text
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
propertyId :: Maybe Text
The ID of the asset property.
qualities :: Maybe (NonEmpty Quality)
The quality by which to filter asset data.
startDate :: Maybe POSIX
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
timeOrdering :: Maybe TimeOrdering
The chronological sorting order of the requested information.
Default: ASCENDING
entryId :: Text
The ID of the entry.

Instances

Instances details

ToJSON BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods toJSON :: BatchGetAssetPropertyValueHistoryEntry -> Value # toEncoding :: BatchGetAssetPropertyValueHistoryEntry -> Encoding # toJSONList :: [BatchGetAssetPropertyValueHistoryEntry] -> Value # toEncodingList :: [BatchGetAssetPropertyValueHistoryEntry] -> Encoding #
Generic BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Associated Types type Rep BatchGetAssetPropertyValueHistoryEntry :: Type -> Type # Methods from :: BatchGetAssetPropertyValueHistoryEntry -> Rep BatchGetAssetPropertyValueHistoryEntry x # to :: Rep BatchGetAssetPropertyValueHistoryEntry x -> BatchGetAssetPropertyValueHistoryEntry #
Read BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods readsPrec :: Int -> ReadS BatchGetAssetPropertyValueHistoryEntry # readList :: ReadS [BatchGetAssetPropertyValueHistoryEntry] # readPrec :: ReadPrec BatchGetAssetPropertyValueHistoryEntry # readListPrec :: ReadPrec [BatchGetAssetPropertyValueHistoryEntry] #
Show BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods showsPrec :: Int -> BatchGetAssetPropertyValueHistoryEntry -> ShowS # show :: BatchGetAssetPropertyValueHistoryEntry -> String # showList :: [BatchGetAssetPropertyValueHistoryEntry] -> ShowS #
NFData BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods rnf :: BatchGetAssetPropertyValueHistoryEntry -> () #
Eq BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods (==) :: BatchGetAssetPropertyValueHistoryEntry -> BatchGetAssetPropertyValueHistoryEntry -> Bool # (/=) :: BatchGetAssetPropertyValueHistoryEntry -> BatchGetAssetPropertyValueHistoryEntry -> Bool #
Hashable BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry Methods hashWithSalt :: Int -> BatchGetAssetPropertyValueHistoryEntry -> Int # hash :: BatchGetAssetPropertyValueHistoryEntry -> Int #
type Rep BatchGetAssetPropertyValueHistoryEntry Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry type Rep BatchGetAssetPropertyValueHistoryEntry = D1 ('MetaData "BatchGetAssetPropertyValueHistoryEntry" "Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyValueHistoryEntry" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "BatchGetAssetPropertyValueHistoryEntry'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "propertyAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "qualities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Quality))) :: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "timeOrdering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeOrdering)) :*: S1 ('MetaSel ('Just "entryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBatchGetAssetPropertyValueHistoryEntry Source #

Arguments

:: Text	`$sel:entryId:BatchGetAssetPropertyValueHistoryEntry'`
-> BatchGetAssetPropertyValueHistoryEntry

Create a value of BatchGetAssetPropertyValueHistoryEntry 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:assetId:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_assetId - The ID of the asset in which the asset property was created.

$sel:endDate:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_endDate - The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

$sel:propertyAlias:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_propertyAlias - The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

$sel:propertyId:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_propertyId - The ID of the asset property.

$sel:qualities:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_qualities - The quality by which to filter asset data.

$sel:startDate:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_startDate - The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

$sel:timeOrdering:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_timeOrdering - The chronological sorting order of the requested information.

Default: ASCENDING

$sel:entryId:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_entryId - The ID of the entry.

batchGetAssetPropertyValueHistoryEntry_assetId :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe Text) Source #

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

batchGetAssetPropertyValueHistoryEntry_endDate :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe UTCTime) Source #

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

batchGetAssetPropertyValueHistoryEntry_propertyAlias :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe Text) Source #

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

batchGetAssetPropertyValueHistoryEntry_propertyId :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe Text) Source #

The ID of the asset property.

batchGetAssetPropertyValueHistoryEntry_qualities :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe (NonEmpty Quality)) Source #

The quality by which to filter asset data.

batchGetAssetPropertyValueHistoryEntry_startDate :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe UTCTime) Source #

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

batchGetAssetPropertyValueHistoryEntry_timeOrdering :: Lens' BatchGetAssetPropertyValueHistoryEntry (Maybe TimeOrdering) Source #

The chronological sorting order of the requested information.

Default: ASCENDING

batchGetAssetPropertyValueHistoryEntry_entryId :: Lens' BatchGetAssetPropertyValueHistoryEntry Text Source #

The ID of the entry.