Class: Aws::IoTSiteWise::Types::AssetSummary

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

Overview

Contains a summary of an asset.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the asset, which has the following format.

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_idString

The ID of the asset model used to create this asset.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The date the asset was created, in Unix epoch time.

Returns:

  • (Time)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the asset.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#external_idString

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#hierarchiesArray<Types::AssetHierarchy>

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID of the asset, in UUID format.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_dateTime

The date the asset was last updated, in Unix epoch time.

Returns:

  • (Time)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the asset.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::AssetStatus

The current status of the asset.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1296

class AssetSummary < Struct.new(
  :id,
  :arn,
  :name,
  :asset_model_id,
  :creation_date,
  :last_update_date,
  :status,
  :hierarchies,
  :description,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end