Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetAssetPropertyAggregates

Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS 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.

Request Syntax


GET /properties/aggregates?aggregateTypes=aggregateTypes&assetId=assetId&endDate=endDate&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&qualities=qualities&resolution=resolution&startDate=startDate&timeOrdering=timeOrdering HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

aggregateTypes

The data aggregating function.

Array Members: Minimum number of 1 item.

Required: Yes

assetId

The ID of the asset, in UUID format.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

endDate

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

Required: Yes

maxResults

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 2500.

Valid Range: Minimum value of 1.

nextToken

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

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

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 AWS IoT SiteWise User Guide.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [^\u0000-\u001F\u007F]+

propertyId

The ID of the asset property, in UUID format.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

qualities

The quality by which to filter asset data.

Array Members: Fixed number of 1 item.

Valid Values: GOOD | BAD | UNCERTAIN

resolution

The time interval over which to aggregate data.

Length Constraints: Minimum length of 2. Maximum length of 3.

Pattern: 1m|15m|1h|1d

Required: Yes

startDate

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

Required: Yes

timeOrdering

The chronological sorting order of the requested information.

Default: ASCENDING

Valid Values: ASCENDING | DESCENDING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "aggregatedValues": [ 
      { 
         "quality": "string",
         "timestamp": number,
         "value": { 
            "average": number,
            "count": number,
            "maximum": number,
            "minimum": number,
            "standardDeviation": number,
            "sum": number
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

aggregatedValues

The requested aggregated values.

Type: Array of AggregatedValue objects

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ServiceUnavailableException

The requested service is unavailable.

HTTP Status Code: 503

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429