Skip to content
AWS for Query.Farm

aws.iotsitewise.get_asset_property_aggregates

Example SQL Queries

SELECT * FROM
aws.iotsitewise.get_asset_property_aggregates
WHERE
"aggregate_types" = 'VALUE'
AND "resolution" = 'VALUE'
AND "start_date" = 'VALUE'
AND "end_date" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
aggregate_types Required Input Column

The data aggregating function.

VARCHAR[]
Show child fields
aggregate_types[]
end_date Required Input Column

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

TIMESTAMP_S
resolution Required Input Column

The time interval over which to aggregate data.

VARCHAR
start_date Required Input Column

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

TIMESTAMP_S
asset_id Input Column

The ID of the asset, in UUID format.

VARCHAR
property_alias Input Column

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.

VARCHAR
property_id Input Column

The ID of the asset property, in UUID format.

VARCHAR
qualities Input Column

The quality by which to filter asset data.

VARCHAR[]
Show child fields
qualities[]
time_ordering Input Column

The chronological sorting order of the requested information.

Default: ASCENDING 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
quality

The quality of the aggregated data.

VARCHAR
timestamp

The date the aggregating computations occurred, in Unix epoch time.

TIMESTAMP_S
value

The value of the aggregates.

STRUCT(
    "average" DOUBLE,
    "count" DOUBLE,
    "maximum" DOUBLE,
    "minimum" DOUBLE,
    "sum" DOUBLE,
    "standard_deviation" DOUBLE
)
Show child fields
value.average

The average (mean) value of the time series over a time interval window.

value.count

The count of data points in the time series over a time interval window.

value.maximum

The maximum value of the time series over a time interval window.

value.minimum

The minimum value of the time series over a time interval window.

value.standard_deviation

The standard deviation of the time series over a time interval window.

value.sum

The sum of the time series over a time interval window.