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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::ListAssetRelationshipsRequest

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

SENSITIVE =

[]

Instance Attribute Summary

• #asset_id ⇒ String

  The ID of 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_type ⇒ String

  The type of traversal to use to identify asset relationships.

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset.

Returns:

• (String)

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

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

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

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

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

#traversal_type ⇒ String

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)

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

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