You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::ListAssociatedAssetsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListAssociatedAssetsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  asset_id: "ID", # required
  hierarchy_id: "ID",
  traversal_direction: "PARENT", # accepts PARENT, CHILD
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset to query.

Returns:

  • (String) —

    The ID of the asset to query.

#hierarchy_id ⇒ String

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 AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The ID of the hierarchy by which child assets are associated to the asset.

#max_results ⇒ Integer

The maximum number of results to be returned per paginated request.

Default: 50

Returns:

  • (Integer) —

    The maximum number of results to be returned per paginated request.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#traversal_direction ⇒ String

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

Possible values:

  • PARENT
  • CHILD

Returns:

  • (String) —

    The direction to list associated assets.