Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.GetAssetPropertyAggregates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

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.

This operation returns paginated results.

Synopsis

Creating a Request

data GetAssetPropertyAggregates Source #

See: newGetAssetPropertyAggregates smart constructor.

Constructors

GetAssetPropertyAggregates'

Fields

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
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.
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
propertyId :: Maybe Text
The ID of the asset property.
assetId :: Maybe Text
The ID of the asset.
maxResults :: Maybe Natural
The maximum number of results to return for each paginated request.
Default: 100
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

Instances details

Eq GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods (==) :: GetAssetPropertyAggregates -> GetAssetPropertyAggregates -> Bool # (/=) :: GetAssetPropertyAggregates -> GetAssetPropertyAggregates -> Bool #
Read GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods readsPrec :: Int -> ReadS GetAssetPropertyAggregates # readList :: ReadS [GetAssetPropertyAggregates] # readPrec :: ReadPrec GetAssetPropertyAggregates # readListPrec :: ReadPrec [GetAssetPropertyAggregates] #
Show GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods showsPrec :: Int -> GetAssetPropertyAggregates -> ShowS # show :: GetAssetPropertyAggregates -> String # showList :: [GetAssetPropertyAggregates] -> ShowS #
Generic GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Associated Types type Rep GetAssetPropertyAggregates :: Type -> Type # Methods from :: GetAssetPropertyAggregates -> Rep GetAssetPropertyAggregates x # to :: Rep GetAssetPropertyAggregates x -> GetAssetPropertyAggregates #
NFData GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods rnf :: GetAssetPropertyAggregates -> () #
Hashable GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods hashWithSalt :: Int -> GetAssetPropertyAggregates -> Int # hash :: GetAssetPropertyAggregates -> Int #
AWSPager GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods page :: GetAssetPropertyAggregates -> AWSResponse GetAssetPropertyAggregates -> Maybe GetAssetPropertyAggregates #
AWSRequest GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Associated Types type AWSResponse GetAssetPropertyAggregates # Methods request :: GetAssetPropertyAggregates -> Request GetAssetPropertyAggregates # response :: MonadResource m => Logger -> Service -> Proxy GetAssetPropertyAggregates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAssetPropertyAggregates))) #
ToHeaders GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods toHeaders :: GetAssetPropertyAggregates -> [Header] #
ToPath GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods toPath :: GetAssetPropertyAggregates -> ByteString #
ToQuery GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods toQuery :: GetAssetPropertyAggregates -> QueryString #
type Rep GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates type Rep GetAssetPropertyAggregates = D1 ('MetaData "GetAssetPropertyAggregates" "Amazonka.IoTSiteWise.GetAssetPropertyAggregates" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "GetAssetPropertyAggregates'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "qualities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Quality))) :: S1 ('MetaSel ('Just "timeOrdering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeOrdering))) :: (S1 ('MetaSel ('Just "propertyAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: 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))))))
type AWSResponse GetAssetPropertyAggregates Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates type AWSResponse GetAssetPropertyAggregates = GetAssetPropertyAggregatesResponse

newGetAssetPropertyAggregates Source #

Arguments

:: NonEmpty AggregateType	`$sel:aggregateTypes:GetAssetPropertyAggregates'`
-> Text	`$sel:resolution:GetAssetPropertyAggregates'`
-> UTCTime	`$sel:startDate:GetAssetPropertyAggregates'`
-> UTCTime	`$sel:endDate:GetAssetPropertyAggregates'`
-> GetAssetPropertyAggregates

Create a value of GetAssetPropertyAggregates 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:qualities:GetAssetPropertyAggregates', getAssetPropertyAggregates_qualities - The quality by which to filter asset data.

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

Default: ASCENDING

$sel:propertyAlias:GetAssetPropertyAggregates', getAssetPropertyAggregates_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:nextToken:GetAssetPropertyAggregates', getAssetPropertyAggregates_nextToken - The token to be used for the next set of paginated results.

$sel:propertyId:GetAssetPropertyAggregates', getAssetPropertyAggregates_propertyId - The ID of the asset property.

$sel:assetId:GetAssetPropertyAggregates', getAssetPropertyAggregates_assetId - The ID of the asset.

$sel:maxResults:GetAssetPropertyAggregates', getAssetPropertyAggregates_maxResults - The maximum number of results to return for each paginated request.

Default: 100

$sel:aggregateTypes:GetAssetPropertyAggregates', getAssetPropertyAggregates_aggregateTypes - The data aggregating function.

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

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

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

Request Lenses

getAssetPropertyAggregates_qualities :: Lens' GetAssetPropertyAggregates (Maybe (NonEmpty Quality)) Source #

The quality by which to filter asset data.

getAssetPropertyAggregates_timeOrdering :: Lens' GetAssetPropertyAggregates (Maybe TimeOrdering) Source #

The chronological sorting order of the requested information.

Default: ASCENDING

getAssetPropertyAggregates_propertyAlias :: Lens' GetAssetPropertyAggregates (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.

getAssetPropertyAggregates_nextToken :: Lens' GetAssetPropertyAggregates (Maybe Text) Source #

The token to be used for the next set of paginated results.

getAssetPropertyAggregates_propertyId :: Lens' GetAssetPropertyAggregates (Maybe Text) Source #

The ID of the asset property.

getAssetPropertyAggregates_assetId :: Lens' GetAssetPropertyAggregates (Maybe Text) Source #

The ID of the asset.

getAssetPropertyAggregates_maxResults :: Lens' GetAssetPropertyAggregates (Maybe Natural) Source #

The maximum number of results to return for each paginated request.

Default: 100

getAssetPropertyAggregates_aggregateTypes :: Lens' GetAssetPropertyAggregates (NonEmpty AggregateType) Source #

The data aggregating function.

getAssetPropertyAggregates_resolution :: Lens' GetAssetPropertyAggregates Text Source #

The time interval over which to aggregate data.

getAssetPropertyAggregates_startDate :: Lens' GetAssetPropertyAggregates UTCTime Source #

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

getAssetPropertyAggregates_endDate :: Lens' GetAssetPropertyAggregates UTCTime Source #

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

Destructuring the Response

data GetAssetPropertyAggregatesResponse Source #

See: newGetAssetPropertyAggregatesResponse smart constructor.

Constructors

GetAssetPropertyAggregatesResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code. aggregatedValues :: [AggregatedValue] The requested aggregated values.

Instances

Instances details

Eq GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods (==) :: GetAssetPropertyAggregatesResponse -> GetAssetPropertyAggregatesResponse -> Bool # (/=) :: GetAssetPropertyAggregatesResponse -> GetAssetPropertyAggregatesResponse -> Bool #
Read GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods readsPrec :: Int -> ReadS GetAssetPropertyAggregatesResponse # readList :: ReadS [GetAssetPropertyAggregatesResponse] # readPrec :: ReadPrec GetAssetPropertyAggregatesResponse # readListPrec :: ReadPrec [GetAssetPropertyAggregatesResponse] #
Show GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods showsPrec :: Int -> GetAssetPropertyAggregatesResponse -> ShowS # show :: GetAssetPropertyAggregatesResponse -> String # showList :: [GetAssetPropertyAggregatesResponse] -> ShowS #
Generic GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Associated Types type Rep GetAssetPropertyAggregatesResponse :: Type -> Type # Methods from :: GetAssetPropertyAggregatesResponse -> Rep GetAssetPropertyAggregatesResponse x # to :: Rep GetAssetPropertyAggregatesResponse x -> GetAssetPropertyAggregatesResponse #
NFData GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates Methods rnf :: GetAssetPropertyAggregatesResponse -> () #
type Rep GetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.GetAssetPropertyAggregates type Rep GetAssetPropertyAggregatesResponse = D1 ('MetaData "GetAssetPropertyAggregatesResponse" "Amazonka.IoTSiteWise.GetAssetPropertyAggregates" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "GetAssetPropertyAggregatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "aggregatedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AggregatedValue]))))

newGetAssetPropertyAggregatesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetAssetPropertyAggregatesResponse'`
-> GetAssetPropertyAggregatesResponse

Create a value of GetAssetPropertyAggregatesResponse 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:nextToken:GetAssetPropertyAggregates', getAssetPropertyAggregatesResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:GetAssetPropertyAggregatesResponse', getAssetPropertyAggregatesResponse_httpStatus - The response's http status code.

$sel:aggregatedValues:GetAssetPropertyAggregatesResponse', getAssetPropertyAggregatesResponse_aggregatedValues - The requested aggregated values.

Response Lenses

getAssetPropertyAggregatesResponse_nextToken :: Lens' GetAssetPropertyAggregatesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

getAssetPropertyAggregatesResponse_httpStatus :: Lens' GetAssetPropertyAggregatesResponse Int Source #

The response's http status code.

getAssetPropertyAggregatesResponse_aggregatedValues :: Lens' GetAssetPropertyAggregatesResponse [AggregatedValue] Source #

The requested aggregated values.