Skip to content
AWS for Query.Farm

aws.iotsitewise.list_associated_assets

Example SQL Queries

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

Description

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • List child assets associated to a parent asset by a hierarchy that you specify.

  • List an asset's parent asset.

Table Definition

Column NameColumn Data Type
asset_id Required Input Column

The ID of the asset to query. 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
hierarchy_id Input Column

The ID of the hierarchy by which child assets are associated to the asset. (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.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

VARCHAR
traversal_direction Input Column

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD 

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
arn

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

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

VARCHAR
asset_model_id

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

VARCHAR
creation_date

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

TIMESTAMP_S
description

A description for the asset.

VARCHAR
external_id

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

VARCHAR
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
hierarchies[]
Show child fields
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.

hierarchies[].id

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

hierarchies[].name

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

id

The ID of the asset, in UUID format.

VARCHAR
last_update_date

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

TIMESTAMP_S
name

The name of the asset.

VARCHAR
status

The current status of the asset.

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

Contains associated error information, if any.

Show child fields
status.error.code

The error code.

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

The error code.

status.error.details[].message

The error message.

status.error.message

The error message.

status.state

The current status of the asset.