| Column Name | Column Data Type |
|---|
asset_composite_model_id Required Input Column
The ID of a composite model on this asset. | VARCHAR |
asset_id Required Input Column
The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs. | 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. | 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_composite_model_description
A description for the composite model. | VARCHAR |
asset_composite_model_external_id
An external ID to assign to the asset model. If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of. | VARCHAR |
asset_composite_model_name
The unique, friendly name for the composite model. | VARCHAR |
asset_composite_model_path
The path to the composite model listing the parent composite models. | STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[] |
Show child fields- asset_composite_model_path[]
Show child fields- asset_composite_model_path[].id
The ID of the path segment. - asset_composite_model_path[].name
The name of the path segment.
|
asset_composite_model_properties
The property definitions of the composite model that was used to create the asset. | STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"alias" VARCHAR,
"notification" STRUCT(
"topic" VARCHAR,
"state" VARCHAR
),
"data_type" VARCHAR,
"data_type_spec" VARCHAR,
"unit" VARCHAR,
"path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[],
"external_id" VARCHAR
)[] |
Show child fields- asset_composite_model_properties[]
Show child fields- asset_composite_model_properties[].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_composite_model_properties[].data_type
The data type of the asset property. - asset_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_composite_model_properties[].external_id
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide. - asset_composite_model_properties[].id
The ID of the asset property. - asset_composite_model_properties[].name
The name of the property. - asset_composite_model_properties[].notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty. Show child fields- asset_composite_model_properties[].notification.state
The current notification state. - asset_composite_model_properties[].notification.topic
The MQTT topic to which IoT SiteWise publishes property value update notifications.
- asset_composite_model_properties[].path[]
Show child fields- asset_composite_model_properties[].path[].id
The ID of the path segment. - asset_composite_model_properties[].path[].name
The name of the path segment.
- asset_composite_model_properties[].unit
The unit (such as Newtons or RPM) of the asset property.
|
asset_composite_model_summaries
The list of composite model summaries. | STRUCT(
"id" VARCHAR,
"external_id" VARCHAR,
"name" VARCHAR,
"type" VARCHAR,
"description" VARCHAR,
"path" STRUCT(
"id" VARCHAR,
"name" VARCHAR
)[]
)[] |
Show child fields- asset_composite_model_summaries[]
Show child fields- asset_composite_model_summaries[].description
A description of the composite model that this summary describes. - asset_composite_model_summaries[].external_id
An external ID to assign to the asset model. If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of. - asset_composite_model_summaries[].id
The ID of the composite model that this summary describes. - asset_composite_model_summaries[].name
The name of the composite model that this summary describes. - asset_composite_model_summaries[].path[]
Show child fields- asset_composite_model_summaries[].path[].id
The ID of the path segment. - asset_composite_model_summaries[].path[].name
The name of the path segment.
- asset_composite_model_summaries[].type
The type of asset model. -
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. -
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
|
asset_composite_model_type
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY. | VARCHAR |