Class: Aws::IoTSiteWise::Types::AssetHierarchy

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Overview

Describes an asset hierarchy that contains a hierarchy’s name and ID.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#external_id ⇒ String

The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn’t already have one. You can’t change the external ID of an asset hierarchy that already has one. For more information, see [Using external IDs] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids

Returns:

  • (String) 


386
387
388
389
390
391
392
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 386

class AssetHierarchy < Struct.new(
  :id,
  :name,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the hierarchy. This ID is a ‘hierarchyId`.

Returns:

  • (String) 


386
387
388
389
390
391
392
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 386

class AssetHierarchy < Struct.new(
  :id,
  :name,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The hierarchy name provided in the [CreateAssetModel] or

UpdateAssetModel][2

API operation.

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html [2]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html

Returns:

  • (String) 


386
387
388
389
390
391
392
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 386

class AssetHierarchy < Struct.new(
  :id,
  :name,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end