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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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. This can be either the actual ID in
UUID format, or else externalId:
followed by the external ID, if
it has one. For more information, see Referencing objects with
external IDs in the IoT SiteWise User Guide.
6564 6565 6566 6567 6568 6569 6570 6571 6572 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6564 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. (This can be either the actual ID in UUID format, or else
externalId:
followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the
IoT SiteWise User Guide.) 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.
6564 6565 6566 6567 6568 6569 6570 6571 6572 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6564 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
6564 6565 6566 6567 6568 6569 6570 6571 6572 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6564 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.
6564 6565 6566 6567 6568 6569 6570 6571 6572 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6564 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. ThehierarchyId
parameter is required if you chooseCHILD
.PARENT
– The list includes the asset's parent asset.
Default: CHILD
6564 6565 6566 6567 6568 6569 6570 6571 6572 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6564 class ListAssociatedAssetsRequest < Struct.new( :asset_id, :hierarchy_id, :traversal_direction, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |