AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::ListAssetRelationshipsRequest

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 ListAssetRelationshipsRequest data as a hash:

{
  asset_id: "ID", # required
  traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the asset.

Returns:

  • (String)


4434
4435
4436
4437
4438
4439
4440
4441
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4434

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

#max_resultsInteger

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

Returns:

  • (Integer)


4434
4435
4436
4437
4438
4439
4440
4441
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4434

class ListAssetRelationshipsRequest < Struct.new(
  :asset_id,
  :traversal_type,
  :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)


4434
4435
4436
4437
4438
4439
4440
4441
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4434

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

#traversal_typeString

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

^

Returns:

  • (String)


4434
4435
4436
4437
4438
4439
4440
4441
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4434

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