Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Documentation

data BatchGetAssetPropertyAggregatesEntry

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates 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: newBatchGetAssetPropertyAggregatesEntry smart constructor.

Constructors

BatchGetAssetPropertyAggregatesEntry'

Fields

• assetId :: Maybe Text

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

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

• timeOrdering :: Maybe TimeOrdering

  The chronological sorting order of the requested information.

  Default: ASCENDING

• entryId :: Text

  The ID of the entry.

• aggregateTypes :: NonEmpty AggregateType

  The data aggregating function.

• resolution :: Text

  The time interval over which to aggregate data.

• startDate :: POSIX

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

• endDate :: POSIX

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

Instances

ToJSON BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

toJSON :: BatchGetAssetPropertyAggregatesEntry -> Value

toEncoding :: BatchGetAssetPropertyAggregatesEntry -> Encoding

toJSONList :: [BatchGetAssetPropertyAggregatesEntry] -> Value

toEncodingList :: [BatchGetAssetPropertyAggregatesEntry] -> Encoding

Generic BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Associated Types

type Rep BatchGetAssetPropertyAggregatesEntry :: Type -> Type

Methods

from :: BatchGetAssetPropertyAggregatesEntry -> Rep BatchGetAssetPropertyAggregatesEntry x

to :: Rep BatchGetAssetPropertyAggregatesEntry x -> BatchGetAssetPropertyAggregatesEntry

Read BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

readsPrec :: Int -> ReadS BatchGetAssetPropertyAggregatesEntry

readList :: ReadS [BatchGetAssetPropertyAggregatesEntry]

readPrec :: ReadPrec BatchGetAssetPropertyAggregatesEntry

readListPrec :: ReadPrec [BatchGetAssetPropertyAggregatesEntry]

Show BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

showsPrec :: Int -> BatchGetAssetPropertyAggregatesEntry -> ShowS

show :: BatchGetAssetPropertyAggregatesEntry -> String

showList :: [BatchGetAssetPropertyAggregatesEntry] -> ShowS

NFData BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

rnf :: BatchGetAssetPropertyAggregatesEntry -> ()

Eq BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

(==) :: BatchGetAssetPropertyAggregatesEntry -> BatchGetAssetPropertyAggregatesEntry -> Bool

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

Hashable BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

Methods

hashWithSalt :: Int -> BatchGetAssetPropertyAggregatesEntry -> Int

hash :: BatchGetAssetPropertyAggregatesEntry -> Int

type Rep BatchGetAssetPropertyAggregatesEntry

Defined in Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry

type Rep BatchGetAssetPropertyAggregatesEntry = D1 ('MetaData "BatchGetAssetPropertyAggregatesEntry" "Amazonka.IoTSiteWise.Types.BatchGetAssetPropertyAggregatesEntry" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "BatchGetAssetPropertyAggregatesEntry'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "timeOrdering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeOrdering))))) :*: ((S1 ('MetaSel ('Just "entryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "aggregateTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty AggregateType))) :*: (S1 ('MetaSel ('Just "resolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newBatchGetAssetPropertyAggregatesEntry

Arguments

:: Text

$sel:entryId:BatchGetAssetPropertyAggregatesEntry'

-> NonEmpty AggregateType

$sel:aggregateTypes:BatchGetAssetPropertyAggregatesEntry'

-> Text

$sel:resolution:BatchGetAssetPropertyAggregatesEntry'

-> UTCTime

$sel:startDate:BatchGetAssetPropertyAggregatesEntry'

-> UTCTime

$sel:endDate:BatchGetAssetPropertyAggregatesEntry'

-> BatchGetAssetPropertyAggregatesEntry

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

$sel:propertyAlias:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_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:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_propertyId - The ID of the asset property.

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

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

Default: ASCENDING

$sel:entryId:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_entryId - The ID of the entry.

$sel:aggregateTypes:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_aggregateTypes - The data aggregating function.

$sel:resolution:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_resolution - The time interval over which to aggregate data.

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

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

batchGetAssetPropertyAggregatesEntry_assetId :: Lens' BatchGetAssetPropertyAggregatesEntry (Maybe Text)

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

batchGetAssetPropertyAggregatesEntry_propertyAlias :: Lens' BatchGetAssetPropertyAggregatesEntry (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.

batchGetAssetPropertyAggregatesEntry_propertyId :: Lens' BatchGetAssetPropertyAggregatesEntry (Maybe Text)

The ID of the asset property.

batchGetAssetPropertyAggregatesEntry_qualities :: Lens' BatchGetAssetPropertyAggregatesEntry (Maybe (NonEmpty Quality))

The quality by which to filter asset data.

batchGetAssetPropertyAggregatesEntry_timeOrdering :: Lens' BatchGetAssetPropertyAggregatesEntry (Maybe TimeOrdering)

The chronological sorting order of the requested information.

Default: ASCENDING

batchGetAssetPropertyAggregatesEntry_entryId :: Lens' BatchGetAssetPropertyAggregatesEntry Text

The ID of the entry.

batchGetAssetPropertyAggregatesEntry_aggregateTypes :: Lens' BatchGetAssetPropertyAggregatesEntry (NonEmpty AggregateType)

The data aggregating function.

batchGetAssetPropertyAggregatesEntry_resolution :: Lens' BatchGetAssetPropertyAggregatesEntry Text

The time interval over which to aggregate data.

batchGetAssetPropertyAggregatesEntry_startDate :: Lens' BatchGetAssetPropertyAggregatesEntry UTCTime

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

batchGetAssetPropertyAggregatesEntry_endDate :: Lens' BatchGetAssetPropertyAggregatesEntry UTCTime

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