Skip to content
AWS for Query.Farm

aws.iotsitewise.describe_asset

Example SQL Queries

SELECT * FROM
aws.iotsitewise.describe_asset
WHERE
"asset_id" = 'VALUE';

Description

Retrieves information about an asset.

Table Definition

Column NameColumn Data Type
asset_id Required Input Column

The ID of the asset, in UUID format.

VARCHAR
exclude_properties Input Column

Whether or not to exclude asset properties from the response. 

BOOLEAN
_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_arn

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} 

VARCHAR
asset_composite_model_summaries

The list of the immediate child custom composite model summaries for the asset.

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_models

The composite models for the asset.

STRUCT(
    "name" VARCHAR,
    "description" VARCHAR,
    "type" VARCHAR,
    "properties" 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
    )[],
    "id" VARCHAR,
    "external_id" VARCHAR
)[]
Show child fields
asset_composite_models[]
Show child fields
asset_composite_models[].description

The description of the composite model.

asset_composite_models[].external_id

The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.

asset_composite_models[].id

The ID of the asset composite model.

asset_composite_models[].name

The name of the composite model.

asset_composite_models[].properties[]
Show child fields
asset_composite_models[].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_models[].properties[].data_type

The data type of the asset property.

asset_composite_models[].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_models[].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_models[].properties[].id

The ID of the asset property.

asset_composite_models[].properties[].name

The name of the property.

asset_composite_models[].properties[].notification

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

Show child fields
asset_composite_models[].properties[].notification.state

The current notification state.

asset_composite_models[].properties[].notification.topic

The MQTT topic to which IoT SiteWise publishes property value update notifications.

asset_composite_models[].properties[].path[]
Show child fields
asset_composite_models[].properties[].path[].id

The ID of the path segment.

asset_composite_models[].properties[].path[].name

The name of the path segment.

asset_composite_models[].properties[].unit

The unit (such as Newtons or RPM) of the asset property.

asset_composite_models[].type

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

asset_creation_date

The date the asset was created, in Unix epoch time.

TIMESTAMP_S
asset_description

A description for the asset.

VARCHAR
asset_external_id

The external ID of the asset, if any.

VARCHAR
asset_hierarchies

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "external_id" VARCHAR
)[]
Show child fields
asset_hierarchies[]
Show child fields
asset_hierarchies[].external_id

The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.

asset_hierarchies[].id

The ID of the hierarchy. This ID is a hierarchyId.

asset_hierarchies[].name

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

asset_last_update_date

The date the asset was last updated, in Unix epoch time.

TIMESTAMP_S
asset_model_id

The ID of the asset model that was used to create the asset.

VARCHAR
asset_name

The name of the asset.

VARCHAR
asset_properties

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

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_properties[]
Show child fields
asset_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_properties[].data_type

The data type of the asset property.

asset_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_properties[].external_id

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

asset_properties[].id

The ID of the asset property.

asset_properties[].name

The name of the property.

asset_properties[].notification

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

Show child fields
asset_properties[].notification.state

The current notification state.

asset_properties[].notification.topic

The MQTT topic to which IoT SiteWise publishes property value update notifications.

asset_properties[].path[]
Show child fields
asset_properties[].path[].id

The ID of the path segment.

asset_properties[].path[].name

The name of the path segment.

asset_properties[].unit

The unit (such as Newtons or RPM) of the asset property.

asset_status

The current status of the asset, which contains a state and any error message.

STRUCT(
    "state" VARCHAR,
    "error" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR,
        "details" STRUCT(
            "code" VARCHAR,
            "message" VARCHAR
        )[]
    )
)
Show child fields
asset_status.error

Contains associated error information, if any.

Show child fields
asset_status.error.code

The error code.

asset_status.error.details[]
Show child fields
asset_status.error.details[].code

The error code.

asset_status.error.details[].message

The error message.

asset_status.error.message

The error message.

asset_status.state

The current status of the asset.