GET

/assets/{assetId}/hierarchies

http://iotsitewise.{region}.amazonaws.com/assets/{assetId}/hierarchies

Retrieves a paginated list of associated assets. You can use this operation to do the following: <ul> <li> List child assets associated to a parent asset by a hierarchy that you specify. </li> <li> List an asset's parent asset. </li> </ul>

Access Token Required: API Key

Path Parameters

assetIdstringrequired

The ID of the asset to query.

Query Params

hierarchyIdstring

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose <code>CHILD</code> for <code>traversalDirection</code>. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the IoT SiteWise User Guide.

traversalDirectionstring

The direction to list associated assets. Choose one of the following options: <ul> <li> <code>CHILD</code> – The list includes all child assets associated to the asset. The <code>hierarchyId</code> parameter is required if you choose <code>CHILD</code>. </li> <li> <code>PARENT</code> – The list includes the asset's parent asset. </li> </ul> Default: <code>CHILD</code>

Allowed:

nextTokenstring

The token to be used for the next set of paginated results.

maxResultsinteger

The maximum number of results to return for each paginated request. Default: 50

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/assets/{assetId}/hierarchies' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET