Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

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.

get/properties/aggregates#aggregateTypes&resolution&startDate&endDate

Query parameters

assetIdstring

The ID of the asset.

propertyIdstring

The ID of the asset property.

propertyAliasstring

The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.

aggregateTypesAggregateType[] required

The data aggregating function.

resolutionstring required

The time interval over which to aggregate data.

qualitiesQuality[]

The quality by which to filter asset data.

startDatestring date-time required

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

endDatestring date-time required

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

timeOrdering'ASCENDING' | 'DESCENDING'
<p>The chronological sorting order of the requested information.</p> <p>Default: <code>ASCENDING</code> </p>
nextTokenstring

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

maxResultsinteger
<p>The maximum number of results to return for each paginated request.</p> <p>Default: 100</p>

Response

Success

nextTokenstring

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