class Aws::IoTSiteWise::Types::ListAssociatedAssetsRequest
@note When making an API call, you may pass ListAssociatedAssetsRequest
data as a hash: { asset_id: "ID", # required hierarchy_id: "ID", traversal_direction: "PARENT", # accepts PARENT, CHILD next_token: "NextToken", max_results: 1, }
@!attribute [rw] asset_id
The ID of the asset to query. @return [String]
@!attribute [rw] hierarchy_id
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the [DescribeAsset][1] or [DescribeAssetModel][2] operations. This parameter is required if you choose `CHILD` for `traversalDirection`. For more information, see [Asset hierarchies][3] in the *IoT SiteWise User Guide*. [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html @return [String]
@!attribute [rw] traversal_direction
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` @return [String]
@!attribute [rw] next_token
The token to be used for the next set of paginated results. @return [String]
@!attribute [rw] max_results
The maximum number of results to return for each paginated request. Default: 50 @return [Integer]
Constants
- SENSITIVE