| Column Name | Column Data Type |
|---|
asset_model_composite_model_id Required Input Column
The ID of a composite model on this asset model. | VARCHAR |
asset_model_id Required Input Column
The ID of the asset model, in UUID format. | 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 |
action_definitions
The available actions for a composite model on this asset model. | STRUCT(
"action_definition_id" VARCHAR,
"action_name" VARCHAR,
"action_type" VARCHAR
)[] |
Show child fields- action_definitions[]
Show child fields- action_definitions[].action_definition_id
The ID of the action definition. - action_definitions[].action_name
The name of the action definition. - action_definitions[].action_type
The type of the action definition.
|
asset_model_composite_model_description
The description for the composite model. | VARCHAR |
asset_model_composite_model_external_id
The external ID of a composite model on this asset model. | VARCHAR |
asset_model_composite_model_name
The unique, friendly name for the composite model. | VARCHAR |
asset_model_composite_model_path
The path to the composite model listing the parent composite models. | STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[] |
Show child fields- asset_model_composite_model_path[]
Show child fields- asset_model_composite_model_path[].id
The ID of the path segment. - asset_model_composite_model_path[].name
The name of the path segment.
|
asset_model_composite_model_properties
The property definitions of the composite model. | STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"data_type" VARCHAR,
"data_type_spec" 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_model_composite_model_properties[]
Show child fields- asset_model_composite_model_properties[].data_type
The data type of the asset model property. - asset_model_composite_model_properties[].data_type_spec
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type. - asset_model_composite_model_properties[].external_id
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_model_composite_model_properties[].id
The ID of the asset model property. -
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. -
If you are calling UpdateAssetModel to modify an existing 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. - asset_model_composite_model_properties[].name
The name of the asset model property. - asset_model_composite_model_properties[].path[]
Show child fields- asset_model_composite_model_properties[].path[].id
The ID of the path segment. - asset_model_composite_model_properties[].path[].name
The name of the path segment.
- asset_model_composite_model_properties[].type
The property type (see PropertyType). Show child fields- asset_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].type.measurement.processing_config.forwarding_config
The forwarding configuration for the given measurement property. Show child fields- asset_model_composite_model_properties[].type.measurement.processing_config.forwarding_config.state
The forwarding state for the given property.
- asset_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].type.metric.processing_config.compute_location
The compute location for the given metric property.
- asset_model_composite_model_properties[].type.metric.variables[]
Show child fields- asset_model_composite_model_properties[].type.metric.variables[].name
The friendly name of the variable to be used in the expression. - asset_model_composite_model_properties[].type.metric.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- asset_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].type.metric.variables[].value.property_path[]
Show child fields- asset_model_composite_model_properties[].type.metric.variables[].value.property_path[].id
The ID of the path segment. - asset_model_composite_model_properties[].type.metric.variables[].value.property_path[].name
The name of the path segment.
- asset_model_composite_model_properties[].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_model_composite_model_properties[].type.metric.window.tumbling
The tumbling time interval window. Show child fields- asset_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].type.transform.processing_config.compute_location
The compute location for the given transform property. - asset_model_composite_model_properties[].type.transform.processing_config.forwarding_config
The forwarding configuration for a given property. Show child fields- asset_model_composite_model_properties[].type.transform.processing_config.forwarding_config.state
The forwarding state for the given property.
- asset_model_composite_model_properties[].type.transform.variables[]
Show child fields- asset_model_composite_model_properties[].type.transform.variables[].name
The friendly name of the variable to be used in the expression. - asset_model_composite_model_properties[].type.transform.variables[].value
The variable that identifies an asset property from which to use values. Show child fields- asset_model_composite_model_properties[].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_model_composite_model_properties[].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_model_composite_model_properties[].type.transform.variables[].value.property_path[]
Show child fields- asset_model_composite_model_properties[].type.transform.variables[].value.property_path[].id
The ID of the path segment. - asset_model_composite_model_properties[].type.transform.variables[].value.property_path[].name
The name of the path segment.
- asset_model_composite_model_properties[].unit
The unit of the asset model property, such as Newtons or RPM.
|
asset_model_composite_model_summaries
The list of composite model summaries for the composite model. | STRUCT(
"id" VARCHAR,
"external_id" VARCHAR,
"name" VARCHAR,
"type" VARCHAR,
"description" VARCHAR,
"path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)[] |
Show child fields- asset_model_composite_model_summaries[]
Show child fields- asset_model_composite_model_summaries[].description
The description of the composite model that this summary describes.. - asset_model_composite_model_summaries[].external_id
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_model_composite_model_summaries[].id
The ID of the composite model that this summary describes.. - asset_model_composite_model_summaries[].name
The name of the composite model that this summary describes.. - asset_model_composite_model_summaries[].path[]
Show child fields- asset_model_composite_model_summaries[].path[].id
The ID of the path segment. - asset_model_composite_model_summaries[].path[].name
The name of the path segment.
- asset_model_composite_model_summaries[].type
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
|
asset_model_composite_model_type
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY. | VARCHAR |
composition_details
Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel . For instance, an array detailing the path of the composition relationship for this composite model. | STRUCT(
"composition_relationship" STRUCT(
"id" VARCHAR
)[]
) |
Show child fields- composition_details.composition_relationship[]
Show child fields- composition_details.composition_relationship[].id
The ID of the component.
|