BatchGetAssetPropertyValueHistoryEntry - AWS IoT SiteWise
ContentsSee Also

BatchGetAssetPropertyValueHistoryEntry

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.

Contents

entryId

The ID of the entry.

Type: String

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

assetId

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

Type: String

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}$

Required: No

endDate

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

Type: Timestamp

Required: No

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.

Type: String

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

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

Required: No

propertyId

The ID of the asset property, in UUID format.

Type: String

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}$

Required: No

qualities

The quality by which to filter asset data.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: GOOD | BAD | UNCERTAIN

Required: No

startDate

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

Type: Timestamp

Required: No

timeOrdering

The chronological sorting order of the requested information.

Default: ASCENDING

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: