ListAssociatedAssetsRequest

import type { ListAssociatedAssetsRequest } from "https://aws-api.deno.dev/v0.3/services/iotsitewise.ts?docs=full";

interface ListAssociatedAssetsRequest {

assetId: string;

hierarchyId?: string | null;

maxResults?: number | null;

nextToken?: string | null;

traversalDirection?: TraversalDirection | null;

}

§Properties

assetId: string

[src]

The ID of the asset to query.

hierarchyId?: string | null

[src]

The ID of the hierarchy by which child assets are associated to the asset. 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.

maxResults?: number | null

[src]

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

Default: 50

nextToken?: string | null

[src]

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

traversalDirection?: TraversalDirection | null

[src]

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