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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the asset to query.

Returns:

  • (String)


3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3559

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

#hierarchy_idString

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)


3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3559

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

#max_resultsInteger

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

Default: 50

Returns:

  • (Integer)


3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3559

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

#next_tokenString

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

Returns:

  • (String)


3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3559

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

#traversal_directionString

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)


3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3559

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