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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::ListAssociatedAssetsRequest

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

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,
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_id ⇒ 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.

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

• #traversal_direction ⇒ String

  The direction to list associated assets.

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset to query.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5594

class ListAssociatedAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :traversal_direction,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5594

class ListAssociatedAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :traversal_direction,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Default: 50

Returns:

• (Integer)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5594

class ListAssociatedAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :traversal_direction,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5594

class ListAssociatedAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :traversal_direction,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5594

class ListAssociatedAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :traversal_direction,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end