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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of an asset.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #asset_model_id ⇒ String

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

• #creation_date ⇒ Time

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

• #description ⇒ String

  A description for the asset.

• #external_id ⇒ String

  The external ID of the asset.

• #hierarchies ⇒ Array<Types::AssetHierarchy>

  A list of asset hierarchies that each contain a ‘hierarchyId`.

• #id ⇒ String

  The ID of the asset, in UUID format.

• #last_update_date ⇒ Time

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

• #name ⇒ String

  The name of the asset.

• #status ⇒ Types::AssetStatus

  The current status of the asset.

Instance Attribute Details

#arn ⇒ String

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

‘arn:$Partition:iotsitewise:$Region:$Account:asset/$AssetId`

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

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

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_id ⇒ String

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

Returns:

• (String)

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

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_date ⇒ Time

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

Returns:

• (Time)

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

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

#description ⇒ String

A description for the asset.

Returns:

• (String)

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

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_id ⇒ String

The external ID of the asset. 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)

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

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

#hierarchies ⇒ Array<Types::AssetHierarchy>

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

Returns:

• (Array<Types::AssetHierarchy>)

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

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

#id ⇒ String

The ID of the asset, in UUID format.

Returns:

• (String)

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

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_date ⇒ Time

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

Returns:

• (Time)

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

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

#name ⇒ String

The name of the asset.

Returns:

• (String)

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

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

#status ⇒ Types::AssetStatus

The current status of the asset.

Returns:

• (Types::AssetStatus)

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

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