| Column Name | Column Data Type |
|---|
asset_id Required Input Column
The ID of the asset, in UUID format. | VARCHAR |
property_id Required Input Column
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide. | 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 |
asset_external_id
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide. | VARCHAR |
asset_model_id
The ID of the asset model, in UUID format. | VARCHAR |
asset_name
The name of the asset. | VARCHAR |
asset_property
The asset property's definition, alias, and notification state. This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel. | STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"alias" VARCHAR,
"notification" STRUCT(
"topic" VARCHAR,
"state" VARCHAR
),
"data_type" VARCHAR,
"unit" VARCHAR,
"type" STRUCT(
"attribute" STRUCT(
"default_value" VARCHAR
),
"measurement" STRUCT(
"processing_config" STRUCT(
"forwarding_config" STRUCT(
"state" VARCHAR
)
)
),
"transform" STRUCT(
"expression" VARCHAR,
"variables" STRUCT(
"name" VARCHAR,
"value" STRUCT(
"property_id" VARCHAR,
"hierarchy_id" VARCHAR,
"property_path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)
)[],
"processing_config" STRUCT(
"compute_location" VARCHAR,
"forwarding_config" STRUCT(
"state" VARCHAR
)
)
),
"metric" STRUCT(
"expression" VARCHAR,
"variables" STRUCT(
"name" VARCHAR,
"value" STRUCT(
"property_id" VARCHAR,
"hierarchy_id" VARCHAR,
"property_path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)
)[],
"window" STRUCT(
"tumbling" STRUCT(
"interval" VARCHAR,
"offset" VARCHAR
)
),
"processing_config" STRUCT(
"compute_location" VARCHAR
)
)
),
"path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[],
"external_id" VARCHAR
) |
Show child fields- asset_property.alias
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. - asset_property.data_type
The property data type. - asset_property.external_id
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_property.id
The ID of the asset property. - asset_property.name
The name of the property. - asset_property.notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty. Show child fields- asset_property.notification.state
The current notification state. - asset_property.notification.topic
The MQTT topic to which IoT SiteWise publishes property value update notifications.
- asset_property.path[]
Show child fields- asset_property.path[].id
The ID of the path segment. - asset_property.path[].name
The name of the path segment.
- asset_property.type
The property type (see PropertyType). A property contains one type. Show child fields- asset_property.type.attribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine. Show child fields- asset_property.type.attribute.default_value
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
- asset_property.type.measurement
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values. Show child fields- asset_property.type.measurement.processing_config
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud. Show child fields- asset_property.type.measurement.processing_config.forwarding_config
The forwarding configuration for the given measurement property. Show child fields- asset_property.type.measurement.processing_config.forwarding_config.state
The forwarding state for the given property.
- asset_property.type.metric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature. Show child fields- asset_property.type.metric.expression
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. - asset_property.type.metric.processing_config
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud. Show child fields- asset_property.type.metric.processing_config.compute_location
The compute location for the given metric property.
- asset_property.type.metric.variables[]
Show child fields- asset_property.type.metric.variables[].name
The friendly name of the variable to be used in the expression. - asset_property.type.metric.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- asset_property.type.metric.variables[].value.hierarchy_id
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. - asset_property.type.metric.variables[].value.property_id
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_property.type.metric.variables[].value.property_path[]
Show child fields- asset_property.type.metric.variables[].value.property_path[].id
The ID of the path segment. - asset_property.type.metric.variables[].value.property_path[].name
The name of the path segment.
- asset_property.type.metric.window
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window. Show child fields- asset_property.type.metric.window.tumbling
The tumbling time interval window. Show child fields- asset_property.type.metric.window.tumbling.interval
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week. IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on. When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval. - asset_property.type.metric.window.tumbling.offset
The offset for the tumbling window. The offset parameter accepts the following: -
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. -
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. -
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. -
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. -
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). -
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric. -
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
- asset_property.type.transform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit. Show child fields- asset_property.type.transform.expression
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. - asset_property.type.transform.processing_config
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud. Show child fields- asset_property.type.transform.processing_config.compute_location
The compute location for the given transform property. - asset_property.type.transform.processing_config.forwarding_config
The forwarding configuration for a given property. Show child fields- asset_property.type.transform.processing_config.forwarding_config.state
The forwarding state for the given property.
- asset_property.type.transform.variables[]
Show child fields- asset_property.type.transform.variables[].name
The friendly name of the variable to be used in the expression. - asset_property.type.transform.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- asset_property.type.transform.variables[].value.hierarchy_id
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. - asset_property.type.transform.variables[].value.property_id
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_property.type.transform.variables[].value.property_path[]
Show child fields- asset_property.type.transform.variables[].value.property_path[].id
The ID of the path segment. - asset_property.type.transform.variables[].value.property_path[].name
The name of the path segment.
- asset_property.unit
The unit (such as Newtons or RPM) of the asset property.
|
composite_model
The composite model that declares this asset property, if this asset property exists in a composite model. | STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"asset_property" STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"alias" VARCHAR,
"notification" STRUCT(
"topic" VARCHAR,
"state" VARCHAR
),
"data_type" VARCHAR,
"unit" VARCHAR,
"type" STRUCT(
"attribute" STRUCT(
"default_value" VARCHAR
),
"measurement" STRUCT(
"processing_config" STRUCT(
"forwarding_config" STRUCT(
"state" VARCHAR
)
)
),
"transform" STRUCT(
"expression" VARCHAR,
"variables" STRUCT(
"name" VARCHAR,
"value" STRUCT(
"property_id" VARCHAR,
"hierarchy_id" VARCHAR,
"property_path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)
)[],
"processing_config" STRUCT(
"compute_location" VARCHAR,
"forwarding_config" STRUCT(
"state" VARCHAR
)
)
),
"metric" STRUCT(
"expression" VARCHAR,
"variables" STRUCT(
"name" VARCHAR,
"value" STRUCT(
"property_id" VARCHAR,
"hierarchy_id" VARCHAR,
"property_path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)
)[],
"window" STRUCT(
"tumbling" STRUCT(
"interval" VARCHAR,
"offset" VARCHAR
)
),
"processing_config" STRUCT(
"compute_location" VARCHAR
)
)
),
"path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[],
"external_id" VARCHAR
),
"id" VARCHAR,
"external_id" VARCHAR
) |
Show child fields- composite_model.asset_property
Contains asset property information. Show child fields- composite_model.asset_property.alias
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. - composite_model.asset_property.data_type
The property data type. - composite_model.asset_property.external_id
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide. - composite_model.asset_property.id
The ID of the asset property. - composite_model.asset_property.name
The name of the property. - composite_model.asset_property.notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty. Show child fields- composite_model.asset_property.notification.state
The current notification state. - composite_model.asset_property.notification.topic
The MQTT topic to which IoT SiteWise publishes property value update notifications.
- composite_model.asset_property.path[]
Show child fields- composite_model.asset_property.path[].id
The ID of the path segment. - composite_model.asset_property.path[].name
The name of the path segment.
- composite_model.asset_property.type
The property type (see PropertyType). A property contains one type. Show child fields- composite_model.asset_property.type.attribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine. Show child fields- composite_model.asset_property.type.attribute.default_value
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
- composite_model.asset_property.type.measurement
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values. Show child fields- composite_model.asset_property.type.measurement.processing_config
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud. Show child fields- composite_model.asset_property.type.measurement.processing_config.forwarding_config
The forwarding configuration for the given measurement property. Show child fields- composite_model.asset_property.type.measurement.processing_config.forwarding_config.state
The forwarding state for the given property.
- composite_model.asset_property.type.metric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature. Show child fields- composite_model.asset_property.type.metric.expression
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. - composite_model.asset_property.type.metric.processing_config
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud. Show child fields- composite_model.asset_property.type.metric.processing_config.compute_location
The compute location for the given metric property.
- composite_model.asset_property.type.metric.variables[]
Show child fields- composite_model.asset_property.type.metric.variables[].name
The friendly name of the variable to be used in the expression. - composite_model.asset_property.type.metric.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- composite_model.asset_property.type.metric.variables[].value.hierarchy_id
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. - composite_model.asset_property.type.metric.variables[].value.property_id
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. - composite_model.asset_property.type.metric.variables[].value.property_path[]
Show child fields- composite_model.asset_property.type.metric.variables[].value.property_path[].id
The ID of the path segment. - composite_model.asset_property.type.metric.variables[].value.property_path[].name
The name of the path segment.
- composite_model.asset_property.type.metric.window
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window. Show child fields- composite_model.asset_property.type.metric.window.tumbling
The tumbling time interval window. Show child fields- composite_model.asset_property.type.metric.window.tumbling.interval
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week. IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on. When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval. - composite_model.asset_property.type.metric.window.tumbling.offset
The offset for the tumbling window. The offset parameter accepts the following: -
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. -
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. -
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. -
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. -
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). -
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: -
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric. -
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
- composite_model.asset_property.type.transform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit. Show child fields- composite_model.asset_property.type.transform.expression
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. - composite_model.asset_property.type.transform.processing_config
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud. Show child fields- composite_model.asset_property.type.transform.processing_config.compute_location
The compute location for the given transform property. - composite_model.asset_property.type.transform.processing_config.forwarding_config
The forwarding configuration for a given property. Show child fields- composite_model.asset_property.type.transform.processing_config.forwarding_config.state
The forwarding state for the given property.
- composite_model.asset_property.type.transform.variables[]
Show child fields- composite_model.asset_property.type.transform.variables[].name
The friendly name of the variable to be used in the expression. - composite_model.asset_property.type.transform.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- composite_model.asset_property.type.transform.variables[].value.hierarchy_id
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. - composite_model.asset_property.type.transform.variables[].value.property_id
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. - composite_model.asset_property.type.transform.variables[].value.property_path[]
Show child fields- composite_model.asset_property.type.transform.variables[].value.property_path[].id
The ID of the path segment. - composite_model.asset_property.type.transform.variables[].value.property_path[].name
The name of the path segment.
- composite_model.asset_property.unit
The unit (such as Newtons or RPM) of the asset property.
- composite_model.external_id
The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide. - composite_model.id
The ID of the composite model that contains the property. - composite_model.name
The name of the property. - composite_model.type
The type of the composite model that defines this property.
|